System management

This chapter provides information about configuring basic system management parameters.

System management parameters

System management commands allow you to configure basic system management functions such as the system name, the router’s location and coordinates, and Common Language Location Identifier (CLLI) code, as well as time zones, Network Time Protocol (NTP), Simple Network Time Protocol (SNTP) properties, CRON and synchronization properties.

System information

This section describes the system information components.

System name

The system name is the MIB II (RFC 1907, Management Information Base for Version 2 of the Simple Network Management Protocol (SNMPv2)) sysName object. By convention, this text string is the fully-qualified domain name of the node. The system name can be any ASCII printable text string up to 32 characters.

System contact

The system contact is the MIB II sysContact object. By convention, this text string is a textual identification of the contact person for this managed node, together with information about how to contact this person. The system contact can be any ASCII printable text string up to 80 characters.

System location

The system location is the MIB II sysLocation object, which is a text string conventionally used to describe the physical location of the node; for example, Bldg MV-11, 1st Floor, Room 101. The system location can be any ASCII printable text string up to 80 characters.

System coordinates

The Nokia Chassis MIB tmnxChassisCoordinates object defines the system coordinates. This text string indicates the Global Positioning System (GPS) coordinates of the location of the chassis.

Two-dimensional GPS positioning offers latitude and longitude information as a four dimensional vector:

direction, hours, minutes, seconds

where:

direction is one of the four basic values: N, S, W, E

hours ranges from 0 to 180 (for latitude) and 0 to 90 for longitude

minutes and seconds range from 0 to 60.

<W, 122, 56, 89> is an example of longitude and <N, 85, 66, 43> is an example of latitude.

System coordinates can be expressed in different notations; for example:

  • N 45 58 23, W 34 56 12

  • N37 37' 00 latitude, W122 22' 00 longitude

  • N36*39.246' W121*40.121

The system coordinates can be any ASCII printable text string up to 80 characters.

Naming objects

It is discouraged to configure named objects with a name that starts with ‟_tmnx_” and with the ‟_” symbol.

CLLI

A CLLI code string for the device is an 11-character standardized geographic identifier that uniquely identifies the geographic location of places and specific functional categories of equipment unique to the telecommunications industry. The CLLI code is stored in the Nokia Chassis MIB tmnxChassisCLLICode object.

The CLLI code can be any ASCII printable text string of up to 11 characters.

System time

The 7210 SAS routers are equipped with a real-time system clock for time-keeping purposes. When set, the system clock always operates on Coordinated Universal Time (UTC), but the software has options for local time translation and system clock synchronization. System time parameters include Time zones, Network Time Protocol (NTP), SNTP time synchronization, and CRON.

Time zones

Setting a time zone allows for times to be displayed in the local time instead of in UTC. The 7210 SAS supports both user-defined and system-defined time zones.

A user-defined time zone has a user-assigned name of up to four printable ASCII characters that is different from the system-defined time zones. For user-defined time zones, the offset from UTC is configured, as well as any summer time adjustment for the time zone.

The following table describes the system-defined time zones, including time zones with and without summer time correction.

Table 1. System-defined time zones

Acronym

Time zone name

UTC offset

Europe

GMT

Greenwich Mean Time

UTC

BST

British Summer Time

UTC +1

IST

Irish Summer Time

UTC +1*

WET

Western Europe Time

UTC

WEST

Western Europe Summer Time

UTC +1

CET

Central Europe Time

UTC +1

CEST

Central Europe Summer Time

UTC +2

EET

Eastern Europe Time

UTC +2

EEST

Eastern Europe Summer Time

UTC +3

MSK

Moscow Time

UTC +3

MSD

Moscow Summer Time

UTC +4

US and Canada

AST

Atlantic Standard Time

UTC -4

ADT

Atlantic Daylight Time

UTC -3

EST

Eastern Standard Time

UTC -5

EDT

Eastern Daylight Saving Time

UTC -4

ET

Eastern Time

Either as EST or EDT, depending on place and time of year

CST

Central Standard Time

UTC -6

CDT

Central Daylight Saving Time

UTC -5

CT

Central Time

Either as CST or CDT, depending on place and time of year

MST

Mountain Standard Time

UTC -7

MDT

Mountain Daylight Saving Time

UTC -6

MT

Mountain Time

Either as MST or MDT, depending on place and time of year

PST

Pacific Standard Time

UTC -8

PDT

Pacific Daylight Saving Time

UTC -7

PT

Pacific Time

Either as PST or PDT, depending on place and time of year

HST

Hawaiian Standard Time

UTC -10

AKST

Alaska Standard Time

UTC -9

AKDT

Alaska Standard Daylight Saving Time

UTC -8

Australia

AWST

Western Standard Time (for example, Perth)

UTC +8

ACST

Central Standard Time (for example, Darwin)

UTC +9.5

AEST

Eastern Standard/Summer Time (for example, Canberra)

UTC +10

Network Time Protocol (NTP)

The Network Time Protocol (NTP) is defined in RFC 1305, Network Time Protocol (Version 3) Specification, Implementation and Analysis. It allows participating network nodes to keep time more accurately and maintain time in a more synchronized manner between the participating network nodes.

NTP uses stratum levels to define the number of hops from a reference clock. The reference clock is treated as a stratum-0 device that is assumed to be accurate with little or no delay. Stratum-0 servers cannot be used in a network. However, they can be directly connected to devices that operate as stratum-1 servers. A stratum-1 server is an NTP server with a directly-connected device that provides Coordinated Universal Time (UTC), such as a GPS or atomic clock.

The 7210 SAS devices cannot act as stratum-1 servers but can act as stratum-2 devices because a network connection to an NTP server is required.

The higher stratum levels are separated from the stratum-1 server over a network path, therefore a stratum-2 server receives its time over a network link from a stratum-1 server. A stratum-3 server receives its time over a network link from a stratum-2 server.

If the internal PTP process is used as a time source for System Time and OAM, it must be specified as a server for NTP. If PTP is specified, the prefer parameter must also be specified. After PTP has established a UTC traceable time from an external grandmaster source, that clock is always the time source into NTP, even if PTP goes into time holdover.

Note:

Use of the internal PTP time source for NTP promotes the internal NTP server to stratum-1 level. This may impact the NTP network topology.

The following NTP elements are supported:

  • server mode

    In this mode, the node advertises the ability to act as a clock source for other network elements. By default, the node, by default, transmits NTP packets in NTP version 4 mode.

  • authentication keys

    These keys implement increased security support in carrier and other networks. Both DES and MD5 authentication are supported, as well as multiple keys.

  • symmetric active mode

    In this mode, the NTP is synchronized with a specific node that is considered more trustworthy or accurate than other nodes carrying NTP in the system. This mode requires that a specific peer is set.

  • broadcast

    In this mode, the node receives or sends using a broadcast address.

  • alert when NTP server is not available

    When none of the configured servers are reachable on the node, the system reverts to manual timekeeping and issues a critical alarm. When a server becomes available, a trap is issued indicating that standard operation has resumed.

  • NTP and SNTP

    If both NTP and SNTP are enabled on the node, SNTP transitions to an operationally down state. If NTP is removed from the configuration or shut down, SNTP resumes an operationally up state.

  • gradual clock adjustment

    Because several applications (such as Service Assurance Agent (SAA)) can use the clock, if a major adjustment (128 ms or more) is needed, it is performed by programmatically stepping the clock. If a minor (less than 128 ms) adjustment is needed, it is performed by either speeding up or slowing down the clock.

  • rate limit events and traps

    To avoid the generation of excessive events and traps the NTP module rate limits the generation of events and traps to three per second. At that point, a single trap is generated to indicate that event and trap squashing is taking place.

SNTP time synchronization

To synchronize the system clock with outside time sources, the 7210 SAS devices include a Simple Network Time Protocol (SNTP) client. As defined in RFC 2030, SNTP Version 4 is an adaptation of NTP. SNTP typically provides time accuracy within 100 ms of the time source. SNTP can only receive the time from NTP servers; it cannot be used to provide time services to other systems. SNTP is a compact, client-only version of NTP. SNTP does not authenticate traffic.

In the 7210 SAS software, the SNTP client can be configured in both unicast client modes (point-to-point) and broadcast client modes (point-to-multipoint). SNTP should be used only at the extremities of the synchronization subnet. SNTP clients should operate only at the highest stratum (leaves) of the subnet and in configurations where no NTP or SNTP client is dependent on another SNTP client for synchronization. SNTP time servers should operate only at the root (stratum 1) of the subnet and then only in configurations where no other source of synchronization other than a reliable radio clock is available.

CRON

The CRON feature supports the SAA functions and time-based policy scheduling to meet time of day requirements. CRON functionality includes the ability to specify the commands to be run, their scheduling, including one-time only functionality (oneshot), interval and calendar functions, and the storage location for the script output. CRON can also specify the relationship between input, output, and schedule. Scheduled reboots, peer turn ups, service assurance agent tests, and OAM events, such as connectivity checks or troubleshooting runs, can also be scheduled.

CRON features are saved to the configuration file.

CRON features run serially with at least 255 separate schedules and scripts. Each instance can support a schedule where the event is repeatedly executed.

The following CRON elements are supported:

  • action

    This configures parameters for a script including the maximum amount of time to keep the results from a script run, the maximum amount of time a script may run, the maximum number of script runs to store and the location to store the results.

  • schedule

    The schedule function configures the type of schedule to run, including one-time only (oneshot), periodic, or calendar-based runs. All runs are determined by month, day of month or weekday, hour, minute and interval (seconds).

  • script

    The script command opens a new nodal context that contains information about a script.

  • time range

    ACLs and QoS policy configurations may be enhanced to support time-based matching. CRON configuration includes time-matching with the schedule sub-command. Schedules are based on events; time-range defines an end-time used as a match criteria.

  • time of day

    Time of Day (TOD) suites are useful when configuring many types of time-based policies or when a large number of SAPs require the same type of TOD changes. The TOD suite may be configured while using specific ingress or egress ACLs or QoS policies, and is an enhancement of the ingress and egress CLI trees.

High availability

This section describes the high availability (HA) routing options and features that service providers can use to reduce vulnerability at the network or service provider edge and alleviate the effect of a lengthy outage on IP networks.

HA is an important feature in service provider routing systems. The unprecedented growth of IP services and applications in service provider networks is driven by the demand from the enterprise and residential communities. Downtime can be very costly, and, in addition to lost revenue, customer information and business-critical communications can be lost. HA is the combination of continuous uptime over long periods (Mean Time Between Failures (MTBF)) and the speed at which failover or recovery occurs (Mean Time To Repair (MTTR)).

The advantage of HA routing is evident at the network or service provider edge, where thousands of connections are hosted. Rerouting options around a failed piece of equipment are often limited, or, a single access link exists to a customer because of the additional cost of redundant links. As service providers converge business-critical services, such as real-time voice (VoIP), video, and VPN applications over their IP networks, the requirements for HA become more stringent compared to the requirements for best-effort data.

Network and service availability become critical aspects in advanced IP service offerings, which dictate that the IP routers used to build the foundations of these networks must be resilient to component and software outages.

HA features

This section describes high availability features for devices.

Redundancy

Redundancy features enable duplication of data elements to maintain service continuation in case of outages or component failure.

Component redundancy

7210 SAS component redundancy is critical to reducing MTTR for the routing system.

The following component redundancy features are supported on the 7210 SAS-D and 7210 SAS-Dxp:

  • AC or DC power supply

    The 7210 SAS-D and 7210 SAS-Dxp each have an integrated AC or DC power supply. A redundant external backup power supply is available only on the 7210 SAS-D ETR variant, 7210 SAS-Dxp 12p ETR variant, 7210 SAS-Dxp 16p, and 7210 SAS-Dxp 24p. Use of redundant external backup power is optional. The external backup power supply cannot be used with the 7210 SAS-D standard variant and 7210 SAS-Dxp 12p standard variant.

    The 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p provide two power input pins to connect external power supplies for power redundancy. The external power supply can be equipped with various power supply units to meet specific PoE requirements. See the 7210 SAS-Dxp 16p/24p Chassis Installation Guide and 7210 SAS-D, Dxp, K 2F1C2T, K 2F6C4T, K 3SFP+ 8C Interface Configuration Guide for more information.

  • chassis cooling

    7210 SAS-D 128 MB devices support passive cooling. The device also has a fan to allow air circulation (and not cooling). By default, the fan mode is set to auto mode. In auto mode, by default, the software determines when to turn the fan on and when to switch it off. This can be changed by the operator using the CLI command config>system>fan. Operators have an option to switch off the fan permanently or turn it on permanently.

    7210 SAS-Dxp supports passive cooling; it does not have any fans.

  • hot swap

    The power supply is integrated into the chassis. Hot swapping is not supported. The external power supply backup connection can be added or removed at any time on the 7210 SAS-D ETR variant and 7210 SAS-Dxp 12p ETR variant.

    The external power supply can be added or removed at any time on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p.

  • replaceable storage media

    The 7210 SAS-D internal flash device (cf1:\) cannot be replaced.

    The 7210 SAS-Dxp (all variants) supports a single, field-replaceable, SD card-based storage medium.

The following component redundancy features are supported on the 7210 SAS-K 2F1C2T:

  • The 7210 SAS-K 2F1C2T non-ETR (standard) unit supports a single external AC power supply.

  • The 7210 SAS-K 2F1C2T ETR unit supports power redundancy and provides two power input pins on the rear of the unit. The user has the option to use AC, -48V DC, or +24V DC power.

  • There are no fans in either of the 7210 SAS-K 2F1C2T non-ETR or ETR variants; these units are passively cooled.

  • The 7210 SAS-K 2F1C2T (all variants) supports a single, field-replaceable, SD card-based storage medium.

The following component redundancy features are supported on the 7210 SAS-K 2F6C4T:

  • The 7210 SAS-K 2F6C4T non-ETR (standard) unit supports a single external AC power supply.

  • The 7210 SAS-K 2F6C4T ETR unit supports power redundancy and provides two power input connectors on the front panel of the unit. The unit currently only supports an external AC power supply.

  • There are no fans in either of the 7210 SAS-K 2F6C4T non-ETR or ETR variants; these units are passively cooled.

  • The 7210 SAS-K 2F6C4T (all variants) supports a single, field-replaceable, SD card-based storage medium.

The following component redundancy features are supported on the 7210 SAS-K 3SFP+ 8C:

  • The 7210 SAS-K 3SFP+ 8C AC and DC variants support power redundancy and provide two power input connectors on the front panel of the unit. The AC variant has two integrated AC power supplies. The DC variant has one integrated DC power supply.

  • There are no fans in the 7210 SAS-K 3SFP+ 8C; the unit is passively cooled.

  • The 7210 SAS-K 3SFP+ 8C (all variants) supports a single, field-replaceable, SD card-based storage medium.

Temperature threshold alarm and fan speed

The following table describes the over-temperature thresholds for 7210 SAS devices:

Table 2. Over-temperature threshold for 7210 SAS devices

Device variants

Minimum temperature

(in degree centigrade)

Maximum temperature

(in degree centigrade)

7210 SAS-D

0

45

7210 SAS-D ETR

-40

60

7210 SAS-Dxp 12p

0

45

7210 SAS-Dxp 12p ETR

-40

60

7210 SAS-Dxp 16p

-40

95

7210 SAS-Dxp 24p

-40

95

7210 SAS-K 2F1C2T

0

65

7210 SAS-K 2F1C2T ETR

-25

85

7210 SAS-K 2F6C4T

0

76

7210 SAS-K 2F6C4T ETR

-25

85

7210 SAS-K 3SFP+ 8C

-25

90

The 7210 SAS system software controls the fans by monitoring the internal temperature of the chassis. The software manages the fan speed to maintain the internal temperature within the operational limits.

The 7210 SAS-D and 7210 SAS-D ETR platforms support fanless operation. The platforms have a fan for air circulation only, and not for cooling. The fan operates in automatic mode by default, and can be disabled by the operator.

The 7210 SAS-Dxp platforms are passively cooled and do not have fans.

Network synchronization

This section describes the network synchronization capabilities available on 7210 SAS platforms. These capabilities involve multiple approaches to network timing, including synchronous Ethernet, PTP/1588v2, adaptive timing, and others. These features address barriers to entry as follows:

  • provide synchronization quality required by mobile networks, such as radio operations and circuit emulation services (CES) transport

  • augment and potentially replace the existing (SONET/SDH) timing infrastructure and deliver high quality network timing for time-sensitive wireline applications

Note:

Network synchronization is only supported on the 7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C.

The following figure shows how network synchronization is commonly distributed in a hierarchical PTP topology at the physical layer.

Figure 1. Conventional network timing architecture (North American nomenclature)

The architecture shown in the preceding figure provides the following benefits:

  • It limits the need for high quality clocks at each network element and only requires that they reliably replicate input to remain traceable to its reference.

  • It uses reliable physical media to provide transport of the timing signal. It does not consume any bandwidth and requires limited additional processing.

The synchronization network is designed so a clock always receives timing from a clock of equal or higher stratum or quality level. This ensures that if an upstream clock has a fault condition (for example, loses its reference and enters a holdover or free-run state) and begins to drift in frequency, the downstream clock will be able to follow it. For greater reliability and robustness, most offices and nodes have at least two synchronization references that can be selected in priority order (such as primary and secondary).

Further levels of resiliency can be provided by designing a capability in the node clock that will operate within prescribed network performance specifications without any reference for a specified timeframe. A clock operating in this mode is said to hold the last known state over (or holdover) until the reference lock is once again achieved. Each level in the timing hierarchy is associated with minimum levels of network performance.

Each synchronization-capable port can be independently configured to transmit data using the node reference timing. In addition, some TDM channels can use adaptive timing or loop timing.

Transmission of a reference clock through a chain of Ethernet equipment requires that all equipment supports Synchronous Ethernet. A single piece of equipment that is not capable of performing Synchronous Ethernet breaks the chain. Ethernet frames will still get through but downstream devices should not use the recovered line timing because it will not be traceable to an acceptable stratum source.

Central synchronization subsystem

The timing subsystem has a central clock located on the CPM. The timing subsystem performs several functions of the network element clock as defined by Telcordia (GR-1244-CORE) and ITU-T G.781 standards.

The central clock uses the available timing inputs to train its local oscillator. The number of timing inputs available to train the local oscillator varies per platform. The priority order of these references must be specified. This is an ordered list of inputs: (ref1, ref2). The CPM clock output can drive the clocking for all line cards in the system. The routers support selection of the node reference using Quality Level (QL) indications. The recovered clock will be able to derive its timing from one of the references available on that platform.

A logical model of the synchronization reference selection on 7210 SAS platforms shows how on 7210 SAS devices, the recovered clock is able to derive the timing from any of the following references:

  • synchronous Ethernet ports

  • 1588v2/PTP timeReceiver port

See Synchronization options available on 7210 SAS platforms for information about the synchronization options supported by each 7210 SAS platform.

The following figure shows the synchronization reference selection available for the 7210 SAS platforms.

Figure 2. A logical model of the synchronization reference selection on 7210 SAS platforms

When Quality Level (QL) selection mode is disabled, the reversion setting controls when the central clock can reselect a previously failed reference.

The following table describes the selection followed for two references in both revertive and non-revertive modes.

Table 3. Revertive, non-revertive timing reference switching operation

Status of reference A

Status of reference B

Active reference non-revertive case

Active reference revertive case

OK

OK

A

A

Failed

OK

B

B

OK

OK

B

A

OK

Failed

A

A

OK

OK

A

A

Failed

Failed

Holdover

Holdover

OK

Failed

A

A

Failed

Failed

Holdover

Holdover

Failed

OK

B

B

Failed

Failed

Holdover

Holdover

OK

OK

A or B

A

Synchronization options available on 7210 SAS platforms

The following table lists the synchronization options supported on 7210 SAS platforms.

Note:

The 7210 SAS supports the ordinary clock in timeReceiver mode and the boundary clock. The boundary clock and ordinary clock timeReceiver can be used for both frequency and time distribution and recovery. The 7210 SAS does not support ordinary clock in timeTransmitter mode or peer-to-peer transparent clock.

Table 4. Synchronization options on 7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Synchronization options

7210 SAS platforms

7210 SAS-D ETR

7210 SAS-Dxp 12p ETR

7210 SAS-Dxp 16p

7210 SAS-Dxp 24p

7210 SAS-K 2F1C2T

7210 SAS-K 2F6C4T

7210 SAS-K 3SFP+ 8C

SyncE with SSM (SFP, SFP+, and 10G/XFP ports)

1

1

SyncE with fixed copper ports2

3

1

1

1588v2/PTP with port-based timestamps (both for frequency and time, also known as PTP pure mode)

4

5

5

6

1588v2/PTP with port-based timestamps (time only with SyncE used for frequency recovery, also known as PTP hybrid mode)

PTP end-to-end (E2E) transparent clock7

PTP power profile (IEC/IEEE 61850-9-3 and C37.238-2017)

Synchronization status messages (SSM)

Note:

Synchronous status messages are supported on devices that support Synchronous Ethernet.

SSM allows the synchronization distribution network to determine the quality level of the clock sourcing a specific synchronization trail and also allows a network element to select the best of multiple input synchronization trails. SSMs are defined for various transport protocols (including SONET/SDH, T1/E1, and Synchronous Ethernet), for interaction with office clocks (such as BITS or SSUs) and embedded network element clocks.

SSM allows equipment to autonomously provision and reconfigure (by reference switching) their synchronization references, while helping to avoid the creation of timing loops. These messages are particularly useful for synchronization re-configurations when timing is distributed in both directions around a ring.

Synchronous Ethernet

Traditionally, Ethernet-based networks employ a physical layer transmitter clock derived from an inexpensive +/-100ppm crystal oscillator and the receiver locks onto it. Because data is packetized and can be buffered, there is no need for long-term frequency stability or for consistency between frequencies of different links.

Synchronous Ethernet is a variant of the line timing that derives the physical layer transmitter clock from a high-quality frequency reference, replacing the crystal oscillator with a frequency source traceable to a primary reference clock. This change is transparent to the other Ethernet layers and does not affect their operation. The receiver at the far end of the link is locked to the physical layer clock of the received signal, and ensures access to a highly accurate and stable frequency reference. In a manner analogous to conventional hierarchical network synchronization, this receiver can lock the transmission clock of other ports to this frequency reference, and establish a fully time-synchronous network.

Unlike methods that rely on sending timing information in packets over an unclocked physical layer, Synchronous Ethernet is not affected by impairments introduced by higher levels of networking technology (packet loss, packet delay variation). The frequency accuracy and stability in Synchronous Ethernet typically exceeds networks with unsynchronized physical layers.

Synchronous Ethernet allows operators to gracefully integrate existing systems and future deployments into a conventional industry-standard synchronization hierarchy. The concept is analogous to SONET/SDH system timing capabilities. The operator can select any (optical) Ethernet port as a candidate timing reference. The recovered timing from this port is used to time the system (for example, the CPM locks to this provisioned reference selection). The operator then can ensure that all system output is locked to a stable traceable frequency source.

Note:

Fixed copper ports using Synchronous Ethernet can be used as a candidate reference or for distribution of recovered reference. If the port is a fixed copper Ethernet port and in 1000BASE-T mode of operation, there is a dependency on the 802.3 link timing for the synchronous Ethernet functionality (see ITU-T G.8262). The 802.3 standard link timing states must align with the needed direction of synchronous Ethernet timing flow. When a fixed copper Ethernet port is specified as an input reference for the node or when it is removed as an input reference for the node, 802.3 link autonegotiation is triggered to ensure that the link timing aligns correctly.

The SSM of synchronous Ethernet uses an Ethernet OAM PDU that uses the slow protocol subtype. For a complete description of the format and processing, see ITU-T G.8264.

Clock source quality level definitions

This section describes the clock source quality levels identified for tracking network timing flow in accordance with the network deployment options defined in Recommendation G.803 and G.781. The Option I network is developed on the original European SDH model; Option II network is a network developed on the North American SONET model.

In addition to the QL values received over SSM of an interface, the standards define the following additional codes for internal use:

  • QL INVx is generated internally by the system if and when an unallocated SSM value is received, where x represents the binary value of this SSM. Within the SR OS, these independent values are assigned as the single value QL-INVALID.

  • QL FAILED is generated internally by the system if and when the terminated network synchronization distribution trail is in the signal fail state.

The internal quality level of QL-UNKNOWN is used to differentiate from a received QL-STU code, but is equivalent for the purposes of QL selection.

The following tables list the synchronization message coding and source priorities for SSM values received and transmitted on the port.

Table 5. Synchronization message coding and source priorities – SSM received

SSM value received on port

Internal relative quality level

SDH interface

SyncE interface in SDH mode

SONET interface

SyncE interface in SONET mode

E1 interface

T1 interface (ESF)

0010 (prc)

0001 (prs)

0010 (prc)

00000100 11111111 (prs)

1. Best quality

0000 (stu)

00001000 11111111 (stu)

2.

0111 (st2)

00001100 11111111 (ST2)

3.

0100 (ssua)

0100 (tnc)

0100 (ssua)

01111000 11111111 (TNC)

4.

1101 (st3e)

01111100 11111111 (ST3E)

5.

1000 (ssub)

1000 (ssub)

6.

1010 (st3/eec2)

00010000 11111111 (ST3)

7.

1011 (sec/eec1)

1011 (sec)

8. Lowest quality qualified in QL-enabled mode

1100 (smc)

00100010 11111111 (smc)

9.

00101000 11111111 (st4)

10.

1110 (pno)

01000000 11111111 (pno)

11.

1111 (dnu)

1111 (dus)

1111 (dnu)

00110000 11111111 (dus)

12.

Any other

Any other

Any other

N/A

13. QL_INVALID

14. QL-FAILED

15. QL-UNC

Table 6. Synchronization message coding and source priorities – SSM transmitted

Internal relative quality level

SSM values to be transmitted by interface of type

SDH interface

SyncE interface in SDH mode

SONET interface

SyncE interface in SONET mode

E1 interface

T1 interface (ESF)

1. Best quality

0010 (prc)

0001 (PRS)

0010 (prc)

00000100 11111111 (PRS)

2.

0100 (ssua)

0000 (stu)

0100 (ssua)

00001000 11111111 (stu)

3.

0100 (ssua)

0111 (st2)

0100 (ssua)

00001100 11111111 (st2)

4.

0100 (ssua)

0100 (tnc)

0100 (ssua)

01111000 11111111 (tnc)

5.

1000 (ssub)

1101 (st3e)

1000 (ssub)

01111100 11111111 (st3e)

6.

1000 (ssub)

1010 (st3/eec2)

1000 (ssub)

00010000 11111111 (st3)

7.

1011 (sec/eec1)

1010 (st3/eec2)

1011 (sec)

00010000 11111111 (st3)

8. Lowest quality qualified in QL-enabled mode

1011 (sec/ eec1)

1100 (smc)

1011 (sec)

00100010 11111111 (smc)

9.

1111 (dnu)

1100 (smc)

1111 (dnu)

00100010 11111111 (smc)

10.

1111 (dnu)

1111 (dus)

1111 dnu

00101000 11111111 (st4)

11.

1111 (dnu)

1110 (pno)

1111 (dnu)

01000000 11111111 (pno)

12.

1111 (dnu)

1111 (dus)

1111 (dnu)

00110000 11111111 (dus)

13. QL_INVALID

1111 (dnu)

1111 (dus)

1111 (dnu)

00110000 11111111 (dus)

14. QL-FAILED

1111 (dnu)

1111 (dus)

1111 (dnu)

00110000 11111111 (dus)

15. QL-UNC

1011 (sec/eec1)

1010 (st3/eec2)

1011 (sec)

00010000 11111111 (st3)

IEEE 1588v2 PTP

Note:

  • Precision Time Protocol (PTP) is only supported on the 7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C.

  • References to G.8275.1 and Ethernet encapsulation apply only to the 7210 SAS-Dxp 12p ETR, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C.

PTP is a timing-over-packet protocol defined in the IEEE 1588v2 standard 1588 PTP 2008.

PTP may be deployed as an alternative timing-over-packet option to ACR. PTP provides the capability to synchronize network elements to a Stratum-1 clock or primary reference clock (PRC) traceable source over a network that may or may not be PTP-aware. PTP has several advantages over ACR. It is a standards-based protocol, has lower bandwidth requirements, can transport both frequency and time, and can potentially provide better performance.

The following is a list of the four basic types of PTP devices:

  • ordinary clock

  • boundary clock

  • end-to-end transparent clock

  • peer-to-peer transparent clock

See Synchronization options available on 7210 SAS platforms for more information about supported PTP device types on 7210 SAS platforms.

Peer clocks shows how the 7210 SAS communicates with peer 1588v2 clocks. These peers can be ordinary clock timeReceivers or boundary clocks. The communication can be based on either unicast IPv4 sessions transported through IP interfaces or Ethernet multicast PTP packets transported through an Ethernet port.

The following table describes IP/UDP unicast and multicast support for the 7210 SAS platforms.

Table 7. IP/UDP unicast and Ethernet multicast support

Protocol

IP/UDP unicast

Ethernet multicast

7210 SAS-D

Yes8

No

7210 SAS-Dxp 12p

No

Yes8

7210 SAS-Dxp 16p

No

Yes

7210 SAS-Dxp 24p

No

Yes

7210 SAS-K 2F1C2T

Yes

No

7210 SAS-K 2F6C4T

Yes

Yes

7210 SAS-K 3SFP+ 8C

Yes

Yes

Unicast IP sessions support two types of peers: configured and discovered. The 7210 SAS operating as an ordinary clock timeReceiver or as a boundary clock must have configured peers for each PTP neighbor clock from which it may accept synchronization information. The 7210 SAS initiates unicast sessions with all configured peers. A 7210 SAS operating as a boundary clock accepts unicast session requests from external peers. If the peer is not configured, it is considered a discovered peer. The 7210 SAS can deliver synchronization information toward discovered peers (that is, timeReceivers).

For Ethernet multicast operation, the node listens for and transmits PTP messages using the configured multicast MAC address. Neighbor clocks are discovered via messages received through an enabled Ethernet port. Ethernet multicast ports shows how the 7210 SAS supports only one neighbor PTP clock connecting into a single port.

The 7210 SAS does not allow for simultaneous PTP operations using both unicast IPv4 and Ethernet multicast. A change of profile to G.8275.1 or from G.8275.1 to another profile requires a reboot of the node.

The following figure shows the relationship of various neighbor clocks using unicast IP sessions to communicate with a 7210 SAS configured as a boundary clock with two configured peers.

Figure 3. Peer clocks

The following figure shows the relationship of various neighbor clocks using multicast Ethernet sessions to a 7210 SAS configured as a boundary clock.

Figure 4. Ethernet multicast ports
Note:

7210 SAS platforms do not support the ordinary clock timeTransmitter configuration.

The IEEE 1588v2 standard includes the concept of PTP profiles. These profiles are defined by industry groups or standards bodies that define the use of IEEE 1588v2 for specific applications.

The 7210 SAS currently supports three profiles. The following table lists PTP profile support for 7210 SAS platforms.

Table 8. PTP profile support on 7210 SAS platforms

PTP profiles

7210 SAS platforms

7210 SAS-D ETR

7210 SAS-Dxp 12p ETR

7210 SAS-Dxp 16p

7210 SAS-Dxp 24p

7210 SAS-K 2F1C2T

7210 SAS-K 2F6C4T

7210 SAS-K 3SFP+ 8C

IEEE 1588v2 (default profile)

ITU-T Telecom profile (G.82651)

ITU-T Telecom profile for time with full timing support (G.8275.1)

IEC/IEEE 61850-9-3 and C37.238-2017 profiles

When a 7210 SAS receives Announce messages from one or more configured peers or multicast neighbors, it executes a Best timeTransmitter Clock Algorithm (BTCA) to determine the state of communication between itself and the peers. The system uses the BTCA to create a hierarchical topology, allowing the flow of synchronization information from the best source (the grandmaster clock) out through the network to all boundary and timeReceiver clocks. Each profile has a dedicated BTCA.

If the profile setting for the clock is ieee1588-2008, the precedence order for the BTCA is as follows:

  • priority1

  • clock class

  • clock accuracy

  • PTP variance (offsetScaledLogVariance)

  • priority2

  • clock identity

  • steps removed from the grandmaster

The following table describes how the 7210 SAS sets its local parameters.

Table 9. Local clock parameters when profile is set to ieee1588-2008

Parameter

Value

clockClass

248 - the 7210 SAS is configured as a boundary clock

255 - the 7210 SAS is configured as an ordinary clock timeReceiver

clockAccuracy

FE - unknown

offsetScaledLogVariance

FFFF - not computed

clockIdentity

Chassis MAC address following the guidelines of section 7.5.2.2.2 of IEEE 1588-2008

If the profile setting for the clock is itu-telecom-freq (ITU G.8265.1 profile), the precedence order for the best timeTransmitter selection algorithm is the following:

  • clock class

  • PTSF (Packet Timing Signal Fail) - Announce Loss (miss 3 Announce messages or do not get an Announce message for 6 seconds)

  • priority

The following table describes how the 7210 SAS sets its local parameters.

Table 10. Local clock parameters when profile is set to itu-telecom-freq

Parameter

Value

clockClass

80-110 - value corresponding to the QL out of the central clock of the 7210 SAS as per Table 1/G.8265.1

255 - the 7210 SAS is configured as an ordinary clock timeReceiver

The ITU-T profile is for use in environments with only ordinary clock timeTransmitters and timeReceivers for frequency distribution.

If the profile setting for the clock is g8275dot1-2014, the precedence order for the best timeTransmitter selection algorithm is very similar to that used for the default profile. It ignores the priority1 parameter, includes a localPriority parameter, and includes the ability to force a port to never enter the timeReceiver state (master-only). The precedence is as follows:

  • clock class

  • clock accuracy

  • PTP variance (offsetScaledLogVariance)

  • priority2

  • localPriority

  • clock identity

  • steps removed from the grandmaster

The following table describes how the 7210 SAS sets its local parameters.

Table 11. Local clock parameters when profile is set to g8275dot1-2014

Parameter

Value

clockClass

165 - the 7210 SAS is configured as a boundary clock and the boundary clock was previously locked to a grandmaster with a clock class of 6

248 - the 7210 SAS is configured as a boundary clock

255 - the 7210 SAS is configured as an ordinary clock timeReceiver

clockAccuracy

FE - unknown

offsetScaledLogVariance

FFFF - not computed

clockIdentity

Chassis MAC address following the guidelines of section 7.5.2.2.2 of IEEE 1588-2008

The 7210 SAS can support a limited number of configured peers (possible timeTransmitter or neighbor boundary clocks) and a limited number of discovered peers (timeReceivers).These peers use the unicast negotiation procedures to request service from the 7210 SAS clock. A neighbor boundary clock counts for two peers (both a configured and a discovered peer) toward the maximum limit.

On the 7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C, there are limits on the number of timeReceivers enforced in the implementation for unicast and multicast PTP timeReceivers. Contact your Nokia technical support representative for information about the specific unicast message limits related to PTP.

When PTP is configured, the PTP load must be monitored to ensure that the load does not exceed the capabilities (configured values) to ensure that sufficient CPU processing cycles are available for PTP. There are several commands that can be used for this monitoring, including show system cpu, which identifies the load of the PTP software process. If the ‟capacity usage” reaches 100%, the PTP software process on the 7210 SAS is at its limit of transmitting or receiving PTP packets.

Because the user cannot control the number of PTP messages received by the 7210 SAS over its Ethernet ports, the following statistics commands can be used to identify the source of the message load:

  • show system ptp statistics displays aggregate packet rates

  • show system ptp port and show system ptp port port-id [detail] display received packet rates

The following figure shows the unicast negotiation procedure performed between a timeReceiver and a peer clock that is selected to be the timeTransmitter clock. The timeReceiver clock will request Announce messages from all peer clocks but only request Sync and Delay_Resp messages from the clock selected to be the timeTransmitter clock.

Figure 5. Messaging sequence between the PTP timeReceiver clock and PTP timeTransmitter clocks

PTP clock synchronization

The IEEE 1588v2 standard synchronizes the frequency and time from a timeTransmitter clock to one or more timeReceiver clocks over a packet stream. This packet-based synchronization can be over IP/UDP unicast or Ethernet multicast.

As part of the basic synchronization timing computation, event messages are defined for synchronization messaging between the PTP timeReceiver clock and PTP timeTransmitter clock. A one-step or two-step synchronization operation can be used; the two-step operation requires a follow-up message after each synchronization message.

Note:

The 7210 SAS-D ETR supports only two-step timeTransmitter port operation. All platforms can operate timeReceiver ports that receive from a one-step or two-step timeTransmitter port.

During startup, the PTP timeReceiver clock receives synchronization messages from the PTP timeTransmitter clock before a network delay calculation is made. Before any delay calculation, the delay is assumed to be zero. A drift compensation is activated after a number of synchronization message intervals occur. The expected interval between the reception of synchronization messages is user-configurable.

The following figure shows the basic synchronization timing computation between the PTP timeReceiver clock and PTP best timeTransmitter, as well as the offset of the timeReceiver clock referenced to the best timeTransmitter signal during startup.

Figure 6. PTP timeReceiver clock and timeTransmitter clock synchronization timing computation

When the IEEE 1588v2 standard is used for distribution of a frequency reference, the timeReceiver calculates a message delay from the timeTransmitter to the timeReceiver based on the timestamps exchanged. A sequence of these calculated delays contains information about the relative frequencies of the timeTransmitter clock and timeReceiver clock, but also includes a noise component related to the PDV experienced across the network. The timeReceiver must filter the PDV effects to extract the relative frequency data and then adjust the timeReceiver frequency to align with the timeTransmitter frequency.

When the IEEE 1588v2 standard is used for distribution of time, the 7210 SAS calculates the offset between the 7210 SAS time base and the external timeTransmitter clock time base based on the four timestamps exchanged. The 7210 SAS determines the offset adjustment, and between these adjustments, it maintains the progression of time using the frequency from the central clock of the node. This allows time to be maintained using a Synchronous Ethernet input source even if the IEEE 1588v2 communications fail. When using IEEE 1588v2 for time distribution, the central clock should, at a minimum, have the PTP input reference enabled.

The following figure shows the logical model for using PTP/1588 for network synchronization.

Figure 7. Logical model for using PTP/1588 for network synchronization on 7210 SAS platforms

Performance considerations

Although IEEE 1588v2 can be used on a network that is not PTP-aware, the use of PTP-aware network elements (boundary clocks) within the packet-switched network improves synchronization performance by reducing the impact of PDV between the grandmaster clock and the timeReceiver clock. In particular, when IEEE 1588v2 is used to distribute high-accuracy time, such as for mobile base station phase requirements, the network architecture requires the deployment of PTP awareness in every device between the grandmaster and the mobile base station timeReceiver.

In addition, performance is also improved by the removal of any PDV caused by internal queuing within the boundary clock or timeReceiver clock. This is accomplished with hardware that is capable of port-based timestamping, which detects and timestamps the IEEE 1588v2 packets at the Ethernet interface.

PTP message transparent forwarding
Note:

The ptp-hw-timestamp command is supported only on the 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C. On bootup, port-based hardware timestamping is enabled by default on all ports on the 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C. It is disabled by default on the 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, and 7210 SAS-Dxp 24p. The correction field in the PTP IP/UDP messages and PTP Ethernet messages that are not addressed to the node are updated for the residence time of the packet in the node.

The ptp-hw-timestamp command must be enabled for the node to process locally-destined PTP packets.

Use the ptp-hw-timestamp command to disable port-based hardware timestamping on ports that transparently forward received PTP packets. See the 7210 SAS-D, Dxp, K 2F1C2T, K 2F6C4T, K 3SFP+ 8C Interface Configuration Guide for more information about the ptp-hw-timestamp command.

When PTP port-based hardware timestamping is disabled, the node does not update the correction field in PTP messages.

For example, to transparently forward PTP packets over MPLS tunnels that use access ports with SAPs to connect the PTP timeTransmitters or timeReceivers, you can use the ptp-hw-timestamp command to disable PTP port-based hardware timestamping on the access ports.

Note:

The configuration of port-based hardware timestamping on selective ports of the 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C platforms can be used for transparent PTP packet forwarding if PTP is enabled and used to time the node (that is, PTP messages are originated and terminated by the node acting as a PTP OC-timeReceiver or BC).

The following guidelines must be considered for transparent PTP packet forwarding:

  • To enable transparent PTP packet forwarding, use the configure>port>no ptp-hw-timestamp command to disable the feature on all ports that receive and forward IP-UDP and Ethernet PTP messages.

  • To enable transparent forwarding of PTP packets over MPLS tunnels on the 7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C, PTP hardware port-based timestamping must be disabled on the access ports where SAPs are configured. These access ports connect to either PTP timeTransmitter or PTP timeReceivers that need to establish PTP sessions and exchange PTP messages transparently. Disabling PTP hardware port-based timestamping is not required on network ports where the MPLS tunnels originate and terminate. As a result, these network ports can be used for PTP packet exchange when the node is a PTP boundary clock or an ordinary clock timeReceiver. If the requirement is to forward PTP packets transparently when MPLS uplinks are not used or when a hybrid port with a SAP is used, PTP hardware port-based timestamping must be disabled on the access port and hybrid port.

PTP capabilities

PTP messages are supported through IPv4 unicast with a fixed IP header size. The following table describes the supported message rates for timeReceiver and timeTransmitter states. The ordinary clock can only be used in the timeReceiver state. The boundary clock can be in both of these states.

Table 12. Support message rates for timeReceiver and timeTransmitter clock states

Support message

timeReceiver clock

timeTransmitter clock

Request rate

Grant rate

Min

Max

Announce

1 packet every 2 seconds

1 packet every 2 seconds9

1 packet every 2 seconds9

Sync

User-configurable with an option to configure 8/16 packets per second

8 packets/second9

16 or 64 packets/second9

Delay_Resp

User-configurable with an option to configure 8/16 packets per second

8 packets/second9

16 or 64 packets/second9

Duration

300 seconds

1 second

1000 seconds

State and statistics data for each timeTransmitter clock are available to assist in the detection of failures or unusual situations.

PTP ordinary timeReceiver clock for frequency

Traditionally, only clock frequency is required to ensure smooth transmission in a synchronous network. The PTP ordinary clock with timeReceiver capability on the 7210 SAS provides another option to reference a Stratum-1 traceable clock across a packet switched network. The recovered clock can be referenced by the internal SSU and distributed to all slots and ports.

The following figure shows a PTP ordinary timeReceiver clock network configuration.

Figure 8. timeReceiver clock

PTP boundary clock for frequency and time

Although IEEE 1588v2 can function across a packet network that is not PTP-aware, performance may be unsatisfactory and unpredictable. PDV across the packet network varies with the number of hops, link speeds, utilization rates, and the inherent behavior of routers. By using routers with boundary clock functionality in the path between the grandmaster clock and the timeReceiver clock, one long path over many hops is split into multiple shorter segments, allowing better PDV control and improved timeReceiver performance. This allows PTP to function as a valid timing option in more network deployments and allows for better scalability and increased robustness in certain topologies, such as rings.

Boundary clocks can simultaneously function as a PTP timeReceiver of an upstream grandmaster (ordinary clock) or boundary clock, and as a PTP timeTransmitter of downstream timeReceivers (ordinary clock) or boundary clocks. The time scale recovered in the timeReceiver side of the boundary clock is used by the timeTransmitter side of the boundary clock. This allows time across the boundary clock.

The following figure shows routers with boundary clock functionality in the path between grandmaster and the timeReceiver clock.

Figure 9. Boundary clock

IEC/IEEE 61850-9-3 and C37.238-2017

Note: PTP power profile (that is, IEC/IEEE 61850-9-3 and C37.238-2017) is supported only on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p.

The 7210 SAS supports IEC/IEEE 61850-9-3 and the C37.238-2017 extension, which are profiles that allow PTP to act as a timing source in power utility networks.

The IEC/IEEE 61850-9-3 and C37.238-2017 profiles support only Ethernet encapsulation with multicast addressing. Both profiles use the peer delay mechanism instead of the delay-request and response mechanism.

When configured for IEC/IEEE 61850-9-3 or C37.238-2017, the 7210 SAS can operate as a boundary clock and supports recovery of frequency as well as time of day or phase.

Synchronous Ethernet is recommeded to be used for frequency recovery when using PTP power profile for accurate phase and time recovery.

The IEC/IEEE 61850-9-3 and C37.238-2017 profiles have the following characteristics:

  • The default domain setting is 0 for IEC/IEEE 61850-9-3 and 254 for C37.238-2017; the allowed range is 0 to 255.
  • One-step clock operation is supported on the 7210 SAS without the need for follow-up messages.
  • Can operate timeReceiver ports that receive from a one-step or two-step timeTransmitter port.

  • Only Ethernet encapsulation with multicast frames is supported with this profile.
  • When Ethernet encapsulation is used, virtual local area network (VLAN) tags within Ethernet frames carrying PTP messages are not supported. When a PTP clock receives a PTP message within a frame containing a VLAN tag, it discards this frame.
  • Synchronization messages, Announce messages, and peer delay messages are sent, by default, at the rate of 1 packet/s.
  • By default, the priority1 and priority2 values are set to 128 when the clock-type is boundary. The priority values can be configured to be between 0 and 255.

The C37.238-2017 profile uses the IEEE_C37_238 TLV in Announce messages between the parent and slave clocks. This TLV includes the grand master clock ID and the total time inaccuracy. Each clock in the chain adds its own inaccuracy to the total time inaccuracy, which gives the ultimate slave clock an estimate of the inaccuracy over the entire path.

When acting as a boundary clock, the system receives the total time inaccuracy from the parent clock and adds its own time inaccuracy, then sends out a TLV with the updated total time inaccuracy. The user can change the default value for a boundary clock with the time-inaccuracy-override command.

See the IEC/IEEE 61850-9-3 standard and the C37.238-2017 extension for more information.

Configuration guidelines and restrictions for PTP

The following configuration guidelines and restrictions apply for PTP:

  • The PTP timeReceiver capability is available on all the ports on the 7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C.

  • The 7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C use CPU processing cycles for frequency and time recovery.

  • On the 7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, and 7210 SAS-Dxp 24p, Nokia highly recommends that PTP be used only in hybrid mode. Hybrid mode allows users to use reduced PTP packet rates and to scale better while using syncE for frequency reference.

  • On the 7210 SAS-D ETR, use of both PTP and SyncE as a reference simultaneously is not allowed. Either PTP or SyncE can be configured as a reference but not both at the same time.

  • On 7210 SAS devices, only a single profile (IEEE 1588v2, G.8265.1, or G.8275.1), IEC/IEEE 61850-9-3-2016, or C37.238-2017 can be enabled for all PTP communications (both toward its timeTransmitter and timeReceivers connected to it) at a time.

  • The PTP G.8275.1 profile is only supported on the 7210 SAS-Dxp 12p ETR, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C. The following restrictions apply to the use of the G.8275.1 PTP profile:

    • The delay and sync requests are set to 16 pps by default and are not configurable.

    • The announce rate is set to 8 pps by default and is not configurable.

    • A change of profile to G.8275.1 or from G.8275.1 to another profile requires a reboot of the node.

    • Only a single multicast timeReceiver is supported per port.

  • PTP with Ethernet encapsulation is only supported with the G.8275.1 profile, IEC/IEEE 61850-9-3, and C37.238-2017 profiles.

  • PTP over IP encapsulation is not supported with the G.8275.1, IEC/IEEE 61850-9-3, and C37.238-2017 profiles. It is only supported with the IEEE 1588v2 and G.8265.1 profiles.

  • When changing the clock-type to or from a boundary clock on the 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C, the node must be rebooted for the change to take effect. Ensure that measures are taken to minimize service disruption during the reboot process.

  • On the 7210 SAS-K 2F6C4T and 7210 SAS-K 3SFP+ 8C, to enable PTP hybrid mode when using the IEEE profile, the user must execute the command config>system>ptp>clock>freq-source ssu. To enable pure PTP mode, the user must execute the command config>system>ptp>clock>freq-source ptp. A change of value from ssu to ptp, or the other way around, requires a reboot of the node after the configuration changes are saved for the change to take effect.

  • On the 7210 SAS-Dxp 12p ETR, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C, when the profile is set to G8275.1, the software automatically sets the freq-source to ssu. The user is not required to explicitly configure this setting.

  • On the 7210 SAS-D ETR, port-based timestamping is enabled for all PTP packets by default when PTP is enabled.

    When PTP is enabled, PTP packets are not forwarded transparently through the node, regardless of the service used and whether PTP is configured as a system clock reference. If PTP is enabled, to enable transparent PTP forwarding again, disable PTP, save the configuration, and reboot the node.

  • On the 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, and 7210 SAS-Dxp 24p, port-based timestamping is disabled for all PTP packets by default. To enable PTP port-based timestamps, the user must explicitly enable PTP timestamping on the required ports.

    When PTP is enabled, PTP packets are not forwarded transparently through the node, regardless of the service used and whether PTP is configured as a system clock reference. If PTP is enabled, to enable transparent PTP forwarding again, disable PTP port-based timestamping for the applicable ports.

  • On the 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C, port-based timestamping is enabled for all PTP packets by default:

    • When port-based timestamping is enabled on all ports, PTP packets are not forwarded transparently through the node, regardless of the service used and whether PTP is configured as a system clock reference. To enable transparent PTP forwarding, disable port-based timestamping on the port.

    • Regardless of whether PTP is enabled (configure>sync-if-timing>ptp>no shutdown) or disabled (configure>sync-if-timing>ptp>shutdown), the timestamp value stored in the correction field (CF) is updated for all PTP packets that are in transit through the node. This affects all PTP packets that are not originated or terminated on the node.

      See PTP message transparent forwarding for more information about enabling transparent forwarding.

Configuration to change reference from SyncE to PTP on 7210 SAS-D ETR

The following are the configuration steps to change reference from SyncE to PTP. This procedure is required only on 7210 SAS-D ETR nodes.

  1. Run the following commands to configure standalone PTP as a reference.
    configure >system >ptp >no shutdown
    
    config> system> sync-if-timing> begin
    ptp
    no shutdown
    exit
    ref-order ptp [Must be configured]
    
    config> system> sync-if-timing> commit
    

    After the preceding commands are run, the frequency and time are provided by PTP only.

  2. Run the following commands to change the reference to syncE.
    config> system> sync-if-timing> begin
    ptp
    shutdown
    exit
    
    config> system> sync-if-timing> commit
    
    config> system> sync-if-timing> begin
    ref1
    source-port 1/1/10
    no shutdown
    exit
    
    ref2
    source-port 1/1/11
    no shutdown
    exit
    
    ref-order ref1 ref2   --------> Or, the ref-order you want [But Must be configured]
        
        revert    ---------------------> If you want ref-order you have setup to take 
    effect
    
    ql-selection -------------------> Optional, if we need Quality to be considered. 
    
    config> system> sync-if-timing> commit 
    

    After the preceding commands are run, the frequency is provided by SyncE and TOD is provided by PTP [configure>system>ptp>no shutdown]. This is called PTP Hybrid mode.

  3. Run the following commands to revert to standalone PTP from SyncE.
    config> system> sync-if-timing> begin
    ref1
    source-port 1/1/10   --------------------> Not Required if port is already 
                                               configured, but in admin down state
    shutdown
    exit
    
    ref2
    source-port 1/1/11   --------------------> Not Required if port is already 
                                               configured, but in admin down state
    shutdown
    exit
    
    config> system> sync-if-timing> commit 
    
    config> system> sync-if-timing> begin
    ptp
    no shutdown
    exit
    
    ref-order ptp [Must be configured] 
    
    config> system> sync-if-timing> commit
    

    Now the frequency and time are provide by PTP (config>system>ptp>no shutdown) only. This is standalone PTP mode.

Link Layer Discovery Protocol (LLDP)

The IEEE 802.1ab Link Layer Discovery Protocol (LLDP) is a unidirectional protocol that uses the MAC layer to transmit specific information about the capabilities and status of the local device. The LLDP can send as well as receive information from a remote device stored in the related MIB (or MIBs).

The LLDP does not contain a mechanism to solicit information received from other LLDP agents or to confirm the receipt of information. However, LLDP provides the flexibility to enable a transmitter and receiver separately, and the following LLDP agent configurations are allowed:

  • only transmit information

  • only receive information

  • transmit and receive information

The information fields in each LLDP frame are contained in an LLDP Data Unit (LLDPDU) as a sequence of variable length information elements. Each information element includes Type, Length, and Value fields (TLVs):

  • Type indicates the nature of information being transmitted.

  • Length indicates the length of the information string in octets.

  • Value is the actual information that is transmitted. (For example, a binary bit map or an alphanumeric string that can contain one or more fields).

Each LLDPDU contains four mandatory TLVs and optional TLVs selected by the Network Management. The following is the format of an LLDPDU:

  • Chassis ID TLV

  • Port ID TLV

  • Time To Live (TTL) TLV

  • zero or more optional TLVs, depending on the maximum size of the LLDPDU allowed

  • End of LLDPDU TLV

A concatenated string formed by the Chassis ID TLV and the Port ID TLV is used by a recipient to identify an LLDP port or agent. The combination of the Port ID and Chassis ID TLVs remains unchanged until the port or agent is operational.

The TTL field of a Time-To-Live TLV can be a zero or non-zero value. A zero TTL field value notifies the receiving LLDP agent to immediately discard all information related to sending LLDP agent. A non-zero TTL field value indicates the time duration for which the receiving LLDP agent should retain the information of the sending LLDP agent. The receiving LLDP agent discards all information related to the sending LLDP agent after the time interval indicated in the TTL field is complete.

Note:

A TTL zero value is used to signal that the sending LLDP port has initiated a port shutdown procedure.

The End Of LLDPDU TLV indicates the end of the LLDPDU.

The following information is included in the protocol as defined by the IEEE 802.1ab standard:

  • Connectivity and management information about the local station to adjacent stations on the same IEEE 802 LAN is advertised.

  • Network management information from adjacent stations on the same IEEE 802 LAN is received.

  • It operates with all IEEE 802 access protocols and network media.

  • Network management information schema and object definitions suitable for storing connection information about adjacent stations is established.

  • It supports compatibility with a number of MIBs.

The following figure shows the LLDP internal architecture for a network node.

Figure 10. LLDP internal architecture for a network node

To detect and address network problems and inconsistencies in the configuration, the network operators can discover the topology information using LLDP. The standard-based tools address the complex network scenarios where multiple devices from different vendors are interconnected using Ethernet interfaces.

The following figure shows an MPLS network that uses Ethernet interfaces in the core, or as an access or handoff interface to connect to different kinds of Ethernet-enabled devices such as service gateway and routers, QinQ switches, DSLAMs, or customer equipment.

The topology information of the network in the following figure can be discovered if IEEE 802.1ab LLDP is running on each of the Ethernet interfaces in the network.

Figure 11. Customer use example for LLDP

System resource allocation

This section describes system resource allocation.

Allocation of ingress internal TCAM resources

The system statically allocates ingress TCAM resources for use by SAP ingress QoS classification, SAP ingress access control lists (ACLs), identifying and sending CFM OAM packets to CPU for local processing, and so on. The resource allocation is not user-configurable. With the introduction of new capabilities such as IPv6 classification, UP MEP support, and G8032-fast-flood, the static allocation of resources by software does not meet requirements of customer who need to use different features.

The user can allocate a fixed amount of resources per system for QoS, ACLs, CFM/Y.1731 MEPs, and other features. Of these, some parameters are boot-time and others are run-time. A change in the current value of the parameter that is designated boot-time needs a reboot of the node before the new value takes effect. Change in the current value of the parameter that is designated run-time takes effect immediately if the software determines resources are available for use to accommodate the change.

During bootup, the system reads the resource profile parameters and allocates resources to features in the order they appear in the configuration file.

Because resources are shared, the user must ensure that the sum total of such resources does not exceed the limit supported by the IMM or node. If the system determines that it cannot allocate the requested resources, the feature is disabled. For example, if the system determines that it cannot allocate resources for g8032-fast-flood, it disables the feature from use and G8032 eth-rings will not be able to use fast-flood mechanisms). Another example is the case where the system determines that it cannot allocate resources for IPv4-based SAP Ingress ACL classification, the system will not allow users to use IPv4-based SAP ingress ACL classification feature and fails the configuration when it comes upon the first SAP in the configuration file that uses an IPv4-based SAP ingress ACL policy.

For boot-time parameters, such as g8032-fast-flood-enable, the user must ensure that the configured services match the resources allocated. If the system determines that it cannot allocate resources to services, it fails the configuration file at the first instance where it encounters a command to which resources cannot be allocated. The available resources can be allocated to different features.

For ACL and QoS resources, the user has the option to allocate resources to limit usage per feature, regardless of the match criteria used. The sum of all resources used for different SAP ingress classification match-criteria is limited by the amount of resources allocated for SAP ingress classification. The user can also allocate resources by specific match criteria. The user can enable any supported match criteria and associate a fixed amount of resources with each match criteria in fixed sizes; the chunk size is dependent on the platform.

The system allocates resources based on the order of appearance in the configuration file, and fails any match criteria if the system does not have any more resources to allocate. In addition, the max keyword can be used to indicate that the system needs to allocate resources when they are first required, as long as the maximum amount of resources allocated for that feature is not exceeded or the maximum amount of resources available in the system is not exceeded. The 7210 SAS platforms allocate resources to each feature and match-criteria in fixed-size chunks.

The no form of the command disables the use of corresponding match criteria. During runtime, the command succeeds, if no SAPs are currently using the criteria. Similarly, reduction of resources from the current value to a lower value succeeds, if no SAPs are currently using the criteria.

If the system successfully runs the no command, it frees up resources used by the chunk or slice and make the resources, or the entire chunk/slice, available for use by other features. Before deallocating resources, the software checks if a service object is using the resource and fails the command if the object is in use. If resources are in use, they can be freed up by deleting a SAP, removing a policy association with a SAP, deleting a MEP, and so on. Some commands under the system resource-profile context do not take effect immediately and require a system reboot before the change occurs and resources are freed. The following is the handling of freed resources:

  • If some entries in a slice are freed, they are made available for use by other SAPs using the same feature to which the chunk is allocated.

  • If an entire chunk is freed, it is returned to the system free pool for possible use by other features.

The no form of the commands that are designated as boot-time does not take effect immediately. It takes effect after the reboot. Before reboot, it is the user’s responsibility to free up resources required for use by the feature that has been enabled to take effect after the reboot. Not doing so results in failure when the configuration file is executed on boot up.

See the CLI and feature description chapters in the appropriate 7210 SAS platform user guide for more information about CLI commands and features that use system resource allocation.

Allocation of egress internal TCAM resources

Before the introduction of new capabilities, such as IPv6 match criteria, the system allocated egress TCAM resources on bootup for use by different criteria in SAP egress access control lists (ACLs) and other purposes; the resource allocation was not user configurable. With the introduction of new capabilities, such as IPv6 match criteria in egress, the static allocation of resources by software may not meet customer requirements if they want to use different features. Therefore, to facilitate user configuration and resource allocation in accordance with user needs, the ingress internal TCAM resource allocation capabilities have been extended to include the egress internal TCAM resources.

For information about specific CLI commands and features that use system resource allocation, see the CLI command and feature descriptions in the appropriate 7210 SAS software user manuals.

Note:

The commands in the config>system>resource-profile context, which require a reboot to take effect, are read and implemented by the system only during bootup. These commands do not take effect if the exec command is used to run the configuration file.

System resource allocation examples

Note:

  • On the 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C, resources must be allocated among SAP ingress QoS and ingress ACLs. Users do not need to further allocate resources individually for MAC and IPv4 or IPv6 criteria.

  • The qos-sap-ingress-resource and acl-sap ingress commands under the system>resource-profile>ingress-internal-tcam context allocate resources to ingress QoS and ingress ACLs:

    • On the 7210 SAS-D and 7210 SAS-Dxp, resources are allocated in slices with 256 entries per slice.

    • On the 7210 SAS-K 2F1C2T and 7210 SAS-K 2F6C4T, resources are allocated with 510 entries per slice.

    • On the 7210 SAS-K 3SFP+ 8C, resources are allocated with 192 entries per slice.

  • The acl-sap egress command in the system>resource-profile>egress-internal-tcam context allocates resources to egress ACLs:

    • On the 7210 SAS-D and 7210 SAS-Dxp, resources are allocated in slices with 128 entries per slice.

    • On the 7210 SAS-K 2F1C2T and 7210 SAS-K 2F6C4T, resources are allocated with 510 entries per slice.

    • On the 7210 SAS-K 3SFP+ 8C, resources are allocated with 180 entries per slice.

1
config> system> resource-profile...
...
   acl-sap-ingress 3
      mac-match-enable max
      ipv4-match-enable 1
      no ipv6_128-ipv4-match-enable
      no ipv6_64-only-match-enable
   exit
...

In the preceding CLI example, the system performs the following actions:

  • 3 chunks are allocated for use by the SAP ingress ACL entries.

  • 1 chunk is allocated for use by SAP ingress ACL entries that use ipv4-criteria. The system fails the configuration when the number of ACL entries using ipv4-criteria exceeds the configured limit (that is, the system does not allocate in excess of the configured limit of 1 chunk).

  • A chunk is allocated for use by SAP ingress ACL entries that use mac-criteria. After the max keyword is specified, the system allocates 1 chunk for use when an ingress ACL policy (with mac-criteria entries defined) is associated with a SAP. The system can allocate up to 2 chunks because the max keyword is used. More chunks are allocated when the user configures a SAP that uses mac-criteria and all entries in the allocated chunks are used up. The system fails the configuration if the number of ACL entries with mac-criteria exceeds the limit of 2 chunks allocated to SAP ingress ACL match (that is, the system does not allocate in excess of the configured limit of 3; up to 2 chunks of the configured 3 chunk limit are allocated to mac-criteria and 1 chunk is allocated to ipv4-criteria).

  • The system fails a user attempt to use SAP ingress ACLs with IPv6 match criteria (and other combinations listed in the preceding list items), because the user has disabled these criteria.

2
config> system> resource-profile>ingress-internal-tcam> 
...
acl-sap-ingress  3
mac-match-enable max
ipv4-match-enable 1
no ipv6_128-ipv4-match-enable
ipv6_64-only-match-enable max
exit
...

In the preceding CLI example, the system performs the following actions:

  • 3 chunks are allocated for use by the SAP ingress ACL entries. These resources are available for use with mac-criteria, ipv4-criteria and ipv6-64-bit match criteria.

  • 1 chunk is allocated for use by SAP ingress ACL entries that use ipv4-criteria. The system fails the configuration if the number of ACL entries using ipv4-criteria exceeds the configured limit (that is, the system does not allocate more than the configured limit of 1 chunk).

  • 1 chunk is allocated for use by SAP ingress ACL entries that use mac-criteria when the user associates an ingress ACL policy (with mac-criteria entries defined) with a SAP. Because the max keyword is used, the system can allocate more chunks, if a chunk is available for use.

    In this example, (assuming a SAP with an ingress ACL policy that uses ipv6-64-bit criteria is configured), as no additional chunks are available, mac-criteria cannot allocate more than 1 chunk (even if the max keyword is specified). The system fails the configuration if the number of ACL entries with mac-criteria exceeds the limit of 1 chunk allocated to SAP ingress ACL mac-criteria (that is, the system does not allocate more than the configured limit of 3 chunks = 1 for mac-criteria + for ipv4-criteria + 1 for ipv6-criteria).

  • A chunk is allocated for use by SAP ingress ACL entries that use ipv6-64-bit criteria when the user associates an ingress ACL policy (with ipv6-64-bit-criteria entries defined) with a SAP. Because the max keyword is specified, the system can allocate more chunks, if a chunk is available for use.

    In this example, as there are no more chunks available, ipv6-64-bit criteria cannot allocate more than 1 chunk (even if the max keyword is specified). The system fails the configuration when the number of ACL entries with ipv6-64-bit criteria exceeds the limit of one chunk allocated to SAP ingress ACL match (that is, the system does not allocate more than the configured limit of 3 chunks = 1 for mac-criteria + 1 for ipv4-criteria + 1 for ipv6-64-bit criteria).

  • The system fails any attempt to use SAP ingress ACLs with ipv6-128 bit match criteria (and the other combinations listed above), because the user has disabled these criteria.

In Example 2, the user can run no ipv4-match-enable command to disable the use of ipv4-criteria. The system checks for SAPs that use ipv4-criteria and if found, fails the command; otherwise, the chunk freed for use with either mac-criteria or ipv6-64-bit criteria. The entire chunk is allocated to mac-criteria if the first SAP that needs resources requests for mac-criteria and no entries in the chunk are already allocated to mac-criteria, which leaves no resources for use by ipv6-64-bit criteria. In the same way, the entire chunk is allocated to ipv6-64-bit criteria, if the first SAP that needs resources requests for ipv6-64-bit criteria and no entries in the chunk are already allocated to ipv6-64-bit criteria, which leaves no resources for use by mac-criteria.

System configuration process overview

The following figure shows the process to provision basic system parameters.

Figure 12. System configuration and implementation flow

Configuration notes

This section describes system configuration restrictions.

General

To access the CLI, ensure that the 7210 SAS device is correctly initialized and the boot loader and BOFs have successfully executed.

Configuring system management with CLI

This section provides information about configuring system management features with the CLI.

Saving configurations

When configuration changes are made, the modified configuration must be saved so the changes are not lost when the system is rebooted. The system uses the configuration and image files, as well as other operational parameters necessary for system initialization, according to the locations specified in the BOF parameters. See Boot options for more information about boot option files.

Configuration files are saved by executing implicit or explicit command syntax:

  • An explicit save writes the configuration to the location specified in the save command syntax using the file-url option.

  • An implicit save writes the configuration to the file specified in the primary configuration location.

    If the file-url option is not specified in the save command syntax, the system attempts to save the current configuration to the current BOF primary configuration source. If the primary configuration source (path and/or filename) has changed since the last boot, the new configuration source is used.

Use the detail option of the save command to save both default and non-default configuration parameters.

The index option ensures that the system preserves system indexes when a save command is executed, regardless of the persistent status in the BOF. During a subsequent boot, the index file is read along with the configuration file. As a result, a number of system indexes are preserved between reboots, including the interface index, LSP IDs, and path IDs. This reduces resynchronizations of the network management system (NMS) with the affected network element.

If the save attempt fails at the destination, an error occurs and is logged. The system does not try to save the file to the secondary or tertiary configuration sources unless the path and filename are explicitly named with the save command.

Basic system configuration

This section provides information about configuring system parameters and provides configuration examples of common configuration tasks. The minimal system parameters that should be configured are System information parameters and System time elements.

Basic system configuration

A:ALA-12>config>system# info
#------------------------------------------
echo "System Configuration "
#------------------------------------------
        name "ALA-12"
        coordinates "Unknown"
        snmp
        exit
        security
            snmp
                community "private" rwa version both
            exit
        exit
        time
            ntp
                server 192.168.15.221 
                no shutdown
            exit
            sntp
                shutdown
            exit
            zone GMT
        exit
----------------------------------------------
A:ALA-12>config>system#

Common configuration tasks

This section provides a brief overview of the tasks that must be performed to configure system parameters and provides the CLI commands.

System information

This section covers the basic system information parameters to configure the physical location of the router, contact information, location information for the router (for example, an address, floor or room number), global positioning system (GPS) coordinates, and system name.

Use the CLI syntax displayed in this section to configure the system information parameters.

System information parameters

This section describes the system information parameters.

Name

Use the name command to configure a name for the device. The name is used in the prompt string. Only one system name can be configured. If multiple system names are configured, the last one encountered overwrites the previous entry.

Use the following CLI syntax to configure the system name.

config>system
        name system-name
Command usage to configure the system name
config>system# name ALA-12
Configuration output for the system name
sysName@domain>config>system# info
#------------------------------------------
echo "System Configuration "
#------------------------------------------
        name "ALA-12"
. . .
        exit
----------------------------------------------
sysName@domain>config>system#
Contact

Use the contact command to specify the name of a system administrator, IT staff member, or other administrative entity.

Use the following syntax to specify the contact name.

config>system
        contact contact-name

The following example shows the .

Command usage to specify the contact name
config>system# contact ‟Fred Information Technology”
Location

Use the location command to specify the system location of the device. For example, enter the city, building address, floor, or room number where the router is located.

Use the following CLI syntax to configure the location.

config>system
        location location
Command usage to configure the location
config>system# location ‟Bldg.1-floor 2-Room 201”
CLLI code

The Common Language Location code (CLLI code) is an 11-character standardized geographic identifier that is used to uniquely identify the geographic location of a router.

Use the following CLI command syntax to define the CLLI code.

config>system
        clli-code clli-code
Command usage to define the CLLI code
config>system# clli-code abcdefg1234
Coordinates

Use the optional coordinates command to specify the GPS location of the device. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

Use the following CLI syntax to configure the location.

config>system
        coordinates coordinates
Command usage to configure the location
config>system# coordinates "N 45 58 23, W 34 56 12"
Configuration output of the general system commands
sysName@domain>config>system# info
#------------------------------------------
echo "System Configuration "
#------------------------------------------
name "ALA-12"
        contact "Fred Information Technology"
        location "Bldg.1-floor 2-Room 201"
        clli-code "abcdefg1234"
        coordinates "N 45 58 23, W 34 56 12"

. . .
        exit
----------------------------------------------
A:ALA-12>config>system#

System time elements

This section describes system time elements.

The system clock maintains time according to Coordinated Universal Time (UTC). Configure information time zone and summer time (daylight savings time) parameters to correctly display time according to the local time zone.

Zone

The zone command sets the time zone or time zone offset for the device. The 7210 SAS supports system-defined and user-defined time zones. System-defined time zones describes system-defined time zones.

Use the following CLI syntax to configure the time zone.

config>system>time
        zone std-zone-name|non-std-zone-name [hh [:mm]]
Command usage to configure the time zone
config>system>time# 
    config>system>time# zone GMT
Zone output
A:ALA-12>config>system>time# info
----------------------------------------------
ntp
                server 192.168.15.221 
                no shutdown
exit
sntp
                shutdown
exit
zone UTC 
----------------------------------------------
A:ALA-12>config>system>time#
Table 13. System-defined time zones

Acronym

Time zone name

UTC offset

Europe:

GMT

Greenwich Mean Time

UTC

WET

Western Europe Time

UTC

WEST

Western Europe Summer Time

UTC +1 hour

CET

Central Europe Time

UTC +1 hour

CEST

Central Europe Summer Time

UTC +2 hours

EET

Eastern Europe Time

UTC +2 hours

EEST

Eastern Europe Summer Time

UTC +3 hours

MSK

Moscow Time

UTC +3 hours

MSD

Moscow Summer Time

UTC +4 hours

US and Canada:

AST

Atlantic Standard Time

UTC -4 hours

ADT

Atlantic Daylight Time

UTC -3 hours

EST

Eastern Standard Time

UTC -5 hours

EDT

Eastern Daylight Saving Time

UTC -4 hours

CST

Central Standard Time

UTC -6 hours

CDT

Central Daylight Saving Time

UTC -5 hours

MST

Mountain Standard Time

UTC -7 hours

MDT

Mountain Daylight Saving Time

UTC -6 hours

PST

Pacific Standard Time

UTC -8 hours

PDT

Pacific Daylight Saving Time

UTC -7 hours

HST

Hawaiian Standard Time

UTC -10 hours

AKST

Alaska Standard Time

UTC -9 hours

AKDT

Alaska Standard Daylight Saving Time

UTC -8 hours

Australia and New Zealand:

AWST

Western Standard Time (for example, Perth)

UTC +8 hours

ACST

Central Standard Time (for example, Darwin)

UTC +9.5 hours

AEST

Eastern Standard/Summer Time (for example, Canberra)

UTC +10 hours

NZT

New Zealand Standard Time

UTC +12 hours

NZDT

New Zealand Daylight Saving Time

UTC +13 hours

Summer time conditions

The config>system>time>dst-zone context configures the start and end dates and offset for summer time or daylight savings time to override system defaults or for user-defined time zones.

When configured, the time is adjusted by adding the configured offset when summer time starts and subtracting the configured offset when summer time ends.

Use the following CLI syntax to configure summer time conditions.

config>system>time
        dst-zone zone-name
        end {end-week} {end-day} {end-month} [hours-minutes]
            offset offset
            start {start-week} {start-day} {start-month} [hours-minutes]
Command usage to configure summer time conditions
config>system# time
    config>system>time# dst-zone pt
    config>system>time>dst-zone# start second sunday april 02:00
    end first sunday october 02:00
    config>system>time>dst-zone# offset 0

If the time zone configured is listed in System-defined time zones , the starting and ending parameters and offset do not need to be configured with this command unless there is a need to override the system defaults. The command returns an error if the start and ending dates and times are not available either in System-defined time zones or entered as optional parameters in this command.

Output for the configured parameters
A:ALA-48>config>system>time>dst-zone# info 
----------------------------------------------
                start second sunday april 02:00
                end first sunday october 02:00
                offset 0
----------------------------------------------
A:ALA-48>config>system>time>dst-zone# offset 0
NTP

Network Time Protocol (NTP) is defined in RFC 1305, Network Time Protocol (Version 3) Specification, Implementation and Analysis. It enables participating network nodes to keep time more accurately and maintain time in a synchronized manner between all participating network nodes.

Authentication-check

The authentication-check command provides the option to skip the rejection of NTP PDUs that do not match the authentication key or authentication type requirements. The default behavior when authentication is configured is to reject all NTP PDUs that have a mismatch in either the authentication key ID, type, or key.

When authentication-check is configured, NTP PDUs are authenticated on receipt. However, mismatches cause a counter to be incremented, one counter for the key ID, one for the type, and one for key value mismatches.

Use the following CLI syntax to authenticate NTP PDUs on receipt.

config>system>time>ntp
        authentication-check
Command usage to authenticate NTP PDUs on receipt
config>system>time>ntp# 
    config>system>time>ntp# authentication-check
    config>system>time>ntp# no shutdown
Authentication-key

The authentication-key command configures an authentication key ID, key type, and key used to authenticate NTP PDUs sent to and received from other network elements participating in the NTP protocol. For authentication to work, the authentication key ID, authentication type, and authentication key values must match.

Use the following CLI syntax to configure an authentication key ID, key type, and key.

config>system>time>ntp
        authentication-key key-id {key key} [hash | hash2] type {des|message-digest}
Command usage to configure an authentication key ID, key type, and key
config>system>time>ntp# 
    config>system>time>ntp# authentication-key 1 key A type des
    config>system>time>ntp# no shutdown

The following sample configuration shows NTP disabled with the authentication-key parameter enabled.

A:sim1>config>system>time>ntp# info
----------------------------------------------
                shutdown
                authentication-key 1 key "OAwgNUlbzgI" hash2 type des 
----------------------------------------------
A:sim1>config>system>time>ntp# 
Broadcast

The broadcast command is used to transmit broadcast packets on a specific subnet.

Use the following CLI syntax to transmit broadcast packets.

config>system>time>ntp
        broadcast [router router-name] {interface 
            ip-int-name> [key-id key-id] [version version]
            [ttl ttl]
Command usage to transmit broadcast packets
config>system>time>ntp# 
    config>system>time>ntp# broadcast interface int11 version 4 
        ttl 127
    config>system>time>ntp# no shutdown

The following sample configuration of the system>time context shows NTP enabled with the broadcast command configured.

A:sim1>config>system>time# info detail
----------------------------------------------
            ntp
                no shutdown
                authentication-check
                ntp-server
                broadcast interface int11 version 4 ttl 127
            exit
A:sim1>config>system>time#

The following sample configuration shows NTP enabled in the config context with the broadcast command configured. At this level, the NTP broadcast commands are displayed at the end of the output after the router interfaces are shown.

A:sim1>config info
 
    ....
 
#--------------------------------------------------
echo "System Time NTP Configuration"
#--------------------------------------------------
    system
        time
            ntp
                broadcast interface toboth
            exit
        exit
    exit
A:sim1>config
Broadcastclient

The broadcastclient command enables listening to NTP broadcast messages on the specified interface.

Use the following CLI syntax to enable listening to NTP broadcast messages.

config>system>time>ntp
        broadcastclient [router router-name] {interface ip-int-name} [authenticate]
Command usage to enable listening to NTP broadcast messages
config>system>time>ntp# 
    config>system>time>ntp# broadcastclient interface int11
    config>system>time>ntp# no shutdown

The following is a sample configuration of NTP enabled with the broadcastclient parameter enabled.

A:ALA-12>config>system>time# info
----------------------------------------------
            ntp
                broadcastclient interface int11
                no shutdown
            exit
            dst-zone PT
                start second sunday april 02:00
                end first sunday october 02:00
                offset 0
            exit
            zone UTC
----------------------------------------------
A:ALA-12>config>system>time#
NTP-server

This command configures the node to assume the role of an NTP server. Unless the server command is used, this node functions as an NTP client only and does not distribute the time to downstream network elements. If an authentication key ID is specified in this command, the NTP server requires client packets to be authenticated.

Use the following CLI syntax to configure the node to function as an NTP client.

config>system>time>ntp
        ntp-server [transmit key-id]
Command usage to configure the node to function as an NTP client
config>system>time>ntp# 
    config>system>time>ntp# ntp-server transmit 1
    config>system>time>ntp# no shutdown

The following is a sample configuration output of NTP enabled with the ntp-server command configured.

A:sim1>config>system>time>ntp# info
----------------------------------------------
        no shutdown
        ntp-server
----------------------------------------------
A:sim1>config>system>time>ntp# 
Peer

Configuration of an NTP peer configures symmetric active mode for the configured peer. Although any system can be configured to peer with any other NTP node, Nokia recommends to configure authentication and to configure known time servers as their peers. Use the no form of the command to remove the configured peer.

Use the following CLI syntax to configure symmetric active mode.

config>system>time>ntp
        peer ip-address[version version][key-id key-id]
        [prefer]
Command usage to configure symmetric active mode
config>system>time>ntp# 
    config>system>time>ntp# peer 192.168.1.1 key-id 1
    config>system>time>ntp# no shutdown

The following is a sample configuration output of NTP enabled with the peer command configured.

A:sim1>config>system>time>ntp# info
----------------------------------------------
            no shutdown
            peer 192.168.1.1 key-id 1 
----------------------------------------------
A:sim1>config>system>time>ntp# 
Server

The server command is used when the node operates in client mode with the NTP server specified in the address field. Use the no form of this command to remove the server with the specified address from the configuration. Up to five NTP servers can be configured.

Use the following CLI syntax to configure the node to operate in client mode.

config>system>time>ntp
        server {ip-address |ptp} [key-id key-id] [version version] [prefer]
Command usage to configure the node to operate in client mode
config>system>time>ntp# 
    config>system>time>ntp# server 192.168.1.1 key-id 1
    config>system>time>ntp# no shutdown

The following is a sample configuration output of NTP enabled with the server command configured.

A:7210SAS>config>system>time>ntp# info 
----------------------------------------------
                ntp-server
                server ptp prefer
                broadcast interface "a1"
                no shutdown
----------------------------------------------
A:7210SAS>config>system>time>ntp# 
SNTP

SNTP is a compact, client-only version of the NTP. SNTP can only receive the time from SNTP/NTP servers; it cannot be used to provide time services to other systems. SNTP can be configured in either broadcast or unicast client mode.

SNTP time elements include Broadcast-client and Server-address.

Use the following CLI syntax to configure the SNTP.

config>system
        time
            sntp
                broadcast-client 
                server-address ip-address [version version-number] [normal|preferred] [interval seconds]
            no shutdown
Broadcast-client

The broadcast-client command enables listening at the global device level to SNTP broadcast messages on interfaces with broadcast client enabled.

Use the following CLI syntax to enable listening to SNTP broadcast messages.

config>system>time>sntp
        broadcast-client
Command usage to enable listening to SNTP broadcast messages
config>system>time>sntp# 
    config>system>time>sntp# broadcast-client 
    config>system>time>sntp# no shutdown

The following is a sample configuration output of SNTP enabled with the broadcast-client command enabled.

A:ALA-12>config>system>time# info
----------------------------------------------
            sntp
                broadcast-client
                no shutdown
            exit
            dst-zone PT
                start second sunday april 02:00
                end first sunday october 02:00
                offset 0
            exit
            zone GMT
----------------------------------------------
A:ALA-12>config>system>time#
Server-address

The server-address command configures an SNTP server for SNTP unicast client mode.

Use the following CLI syntax to configure an SNTP server for unicast client mode.

config>system>time>sntp#
        server-address ip-address version version-number] [normal|preferred] [interval seconds]
Command usage to configure an SNTP server for unicast client mode
config>system>time>sntp#
    config>system>time# server-address 10.10.0.94 version
        1 preferred interval 100

The following is a sample configuration output of SNTP enabled with the server-address command configured.

A:ALA-12>config>system>time# info
----------------------------------------------
            sntp
                server-address 10.10.0.94 version 1 preferred interval 100
                no shutdown
            exit
            dst-zone PT start-date 2006/04/04 12:00 end-date 2006/10/25 12:00
            zone GMT
----------------------------------------------
A:ALA-12>config>system>time#
CRON

The cron command supports the Service Assurance Agent (SAA) functions and the ability to schedule turning on and off policies to meet ‟Time of Day” requirements. CRON functionality includes the ability to specify the commands that need to be run, when they will be scheduled, including one-time only functionality (oneshot), interval and calendar functions, as well as where to store the output of the results. In addition, CRON can specify the relationship between input, output, and schedule. Scheduled reboots, peer turn ups, service assurance agent tests and more can all be scheduled with CRON, as well as OAM events, such as connectivity checks, or troubleshooting runs.

CRON elements include Schedule, Script, Time range, and Time of Day.

Schedule

The schedule command configures the type of schedule to run, including one-time only (oneshot), periodic, or calendar-based runs. All runs are determined by month, day of month or weekday, hour, minute, and interval (seconds). If end-time and interval are both configured, whichever condition is reached first is applied.

Use the following CLI syntax to configure the type of schedule to run.

config>system>cron
        schedule schedule-name[owner schedule-owner]
            count number
            day-of-month {day-number [..day-number]|all}
            description description-string
            end-time [date|day-name] time
            hour {hour-number [..hour-number] | all}
            interval seconds 
            minute {minute-number [..minute-number]|all} 
            month {month-number [..month-number]|month-name [..month-name]|all}
            no shutdown 
            type {periodic|calendar|oneshot} 
            weekday {weekday-number [..weekday-number]|day-name [..day-name]|all}
            shutdown

The following example shows the .

Command usage to configure the type of schedule to run
config>system>cron# schedule test2
    config>system>cron>sched# day-of-month 17
    config>system>cron>sched# end-time 2007/07/17 12:00
    config>system>cron>sched# minute 0 15 30 45
    config>system>cron>sched# weekday friday
    config>system>cron>sched# shut

The following is a sample configuration output that schedules a script named ‟test2” to run every 15 minutes on the 17th of each month and every Friday until noon on July 17, 2007.

*A:SR-3>config>system>cron# info 
----------------------------------------------
        schedule "test2"
            shutdown
            day-of-month 17           
            minute 0 15 30 45
            weekday friday 
            end-time 2007/07/17 12:00
        exit
----------------------------------------------
*A:SR-3>config>system>cron# 
Script

The script command opens a new nodal context, which contains information about a script.

Use the following CLI syntax to create a nodal context.

config>system>cron
        script script-name[owner script-owner]
        description description-string
        location file-url 
        shutdown 
Command usage to create a nodal context called ‟test”
config>system>cron# script test
    config>system>cron>script#

The following is a sample configuration output that names a script ‟test”.

A:sim1>config>system>cron# info
----------------------------------------------
        script "test"
            location "ftp://172.16.0.0/./sim1/test.cfg"
            no shutdown 
        exit
----------------------------------------------
A:sim1>config>system>cron# 
Time range

ACLs and QoS policy configurations may be enhanced to support time-based matching. CRON configuration includes time matching with the 'schedule' subcommand. Schedules are based on events; time-range defines an end-time that is used as a match criteria.

Time range elements include Create, Absolute, Daily, Weekdays, Weekend, and Weekly.

Create

Use this command to enable the time-range context.

Use the following syntax to create a time range.

config>system>cron
        time-range name create
Command usage to create a time-range called "test1"
config>system>cron# time-range test1 create
    config>system>cron>time-range$
Absolute

The absolute command configures a start and end time that does not repeat.

Use the following syntax to configure a time range that does not repeat.

config>system>cron>time-range$
        absoluteabsolute-time end absolute-time
Command usage to configure a non-repetitive time range
config>system>cron>time-range$ absolute start 2006/05/05,11:00 end 
    2006/05/06,11:01
    config>system>cron>time-range$

The following is a sample configuration output of an absolute time range beginning on May 5, 2006 at 11:00 and ending May 6, 2006 at 11:01.

A:sim1>config>system>cron>time-range# show cron time-range detail
===============================================================================
Cron time-range details
===============================================================================
Name        : test1
Triggers    : 0
Status      : Inactive
Absolute    : start 2006/05/05,11:00 end 2006/05/06,11:01
===============================================================================
A:sim1>config>system>cron>time-range# 
Daily

The daily command configures the start and end of a periodic schedule for every day of the week (Sunday through Saturday).

Use the following syntax to configure a time range that is repeated daily.

config>system>cron>time-range$
        daily start time-of-day end time-of-day
Command usage to create a time range that is repeated daily
config>system>cron>time-range$ daily start 11:00 end 12:00
    config>system>cron>time-range$

The following is a sample configuration output of a daily time range beginning at 11:00 and ending at 12:00.

A:sim1>config>system>cron>time-range# show cron time-range detail      
===============================================================================
Cron time-range details
===============================================================================
Name        : 1
Triggers    : 0
Status      : Inactive
Periodic    : daily   Start 11:00 End 12:00
===============================================================================
A:sim1>config>system>cron>time-range# 
Weekdays

The weekdays command configures the start and end of a periodic schedule for weekdays (Monday through Friday).

Use the following syntax to configure a time range that is repeated on weekdays.

config>system>cron>time-range$
        weekdays start time-of-day end time-of-day
Command usage to create a time range that is repeated on weekdays
config>system>cron>time-range$ weekdays start 11:00 end 12:00
    config>system>cron>time-range$

The following is a sample configuration output of a time range beginning at 11:00 and ending at 12:00. This schedule runs all weekdays during this time period.

A:sim1>config>system>cron>time-range# show cron time-range detail   
===============================================================================
Cron time-range details
===============================================================================
Name        : 1
Triggers    : 0
Status      : Inactive
Periodic    : weekdays Start 11:00 End 12:00
===============================================================================
A:sim1>config>system>cron>time-range# 
Weekend

The weekend command configures the start and end of a periodic schedule for weekends (Saturday and Sunday). The resolution must be at least one minute apart, for example, start at 11:00 and end at 11:01. A start time and end time of 11:00 is invalid.

Use the following syntax to configure a time range that is repeated on weekends.

config>system>cron>time-range$
        weekend start time-of-day end time-of-day
Command usage to create a time range that is repeated on weekends
config>system>cron>time-range$ weekend start 11:00 end 12:00
    config>system>cron>time-range$

The following is a sample configuration output of a weekend time range beginning at 11:00am and ending at 12:00pm, both Saturday and Sunday.

To specify 11:00am to 12:00pm on Saturday or Sunday only, use the absolute parameter for one day, or the weekly parameter for every Saturday or Sunday accordingly. In addition, see the schedule parameter to schedule one-shot or periodic events in the config>system>cron context.

A:sim1>config>system>cron>time-range# show cron time-range detail  
===============================================================================
Cron time-range details
===============================================================================
Name        : 1
Triggers    : 0
Status      : Inactive
Periodic    : weekend Start 11:00 End 12:00
Weekly

The weekly command configures the start and end of a periodic schedule for the same day every week, for example, every Friday. The start and end dates must be the same. The resolution must be at least one minute apart, for example, start at 11:00 and end at 11:01. A start time and end time of 11:00 is invalid.

Use the following syntax to create a time range that is repeated weekly.

config>system>cron>time-range$
        weekly start time-in-week end time-in-week

The following example shows the .

Command usage to create a time range that is repeated weekly
config>system>cron>time-range$ start fri,01:01 end fri,01:02
    config>system>cron>time-range$

The following is a sample configuration output of a weekly time range beginning on Friday at 1:01am ending Friday at 1:02am.

A:sim1>config>system>cron>time-range$ info
----------------------------------------------
        weekly start fri,01:01 end fri,01:02
----------------------------------------------
A:sim1>config>system>cron>time-range$ 
Time of Day

Time of Day (TOD) suites are useful when configuring many types of time-based policies or when a large number of subscribers or SAPs require the same type of TOD changes. The TOD suite may be configured while using specific ingress or egress ACLs or QoS policies, and is an enhancement of the ingress and egress CLI trees.

SAPs
  • If a TOD suite is assigned to a SAP; statistics collection are not collected for that SAP.

  • When an item is configured both on the SAP level and in the TOD suite assigned to the SAP, the TOD suite defined value takes precedence.

  • A policy or filter assignment configured directly on a SAP has a lower priority than any assignment in a TOD suite. Therefore, it is possible that a new direct configuration has no immediate effect. If the configuration is made by CLI, a warning is given.

Egress

This command is an enhancement for specific egress policies. Use this command to create time range based associations of previously created filter lists, QoS, and scheduler policies. Multiple policies may be included and each must be assigned a different priority; in case time ranges overlap, the priority is used to determine the prevailing policy. Only a single reference to a policy may be included without a time range.

Filters

In a TOD suite, filters that have entries with time ranges may not be selected. Similarly, filter entries with a time range may not be created while a TOD suite refers to that filter. QoS policies and filters referred to by a TOD suite must have the scope ‟template” (default).

Use the following syntax to configure TOD-suite egress parameters.

config>system>cron
        tod-suite tod-suite-name create
            egress 
                filter ip ip-filter-id [time-range time-range-name]
                [priority priority]
                filter ipv6 ipv6-filter-id [time-range time-range-name]
                [priority priority]
                filter mac mac-filter-id [time-range time-range-name] [priority priority]
Command usage to configure TOD-suite egress parameters
config>system>cron>tod-suite$ egress filter ip 100
    config>system>cron>tod-suite$

The following is a sample configuration output of an egress IP filter association with filter ID 100.

sim1>config>filter# ip-filter 100 create
A:sim1>config>filter>ip-filter$ entry 10 create
A:sim1>config>filter>ip-filter>entry$ 
A:sim1>config>system>cron>tod-suite# egress filter ip 100
A:sim1>config>system>cron>tod-suite# info detail
----------------------------------------------
            no description
            egress
                filter ip 100 
            exit
----------------------------------------------
A:sim1>config>system>cron>tod-suite# 
Ingress

This command is an enhancement for specific ingress policies including filter lists and QoS policies. Use this command to create time range based associations of previously created filter lists and QoS policies. Multiple policies may be included and each must be assigned a different priority; in case time ranges overlap, the priority is used to determine the prevailing policy. Only a single reference to a policy may be included without a time range. To configure a daily time range across midnight, use a combination of two entries. An entry that starts at hour zero takes over from an entry that ends at hour 24.

Use the following syntax to configure time range based associations.

config>system>cron
        tod-suite tod-suite-name create
            ingress
                filter ip ip-filter-id [time-range time-range-name]
                [priority priority]
                filter ipv6 ipv6-filter-id [time-range time-range-name]
                filter mac mac-filter-id [time-range time-range-name] [priority priority]
                qos policy-id [time-range time-range-name] [priority priority]
Command usage to configure an IP filter association
config>system>cron>tod-suite$ ingress filter ip 100
    config>system>cron>tod-suite$
Ingress IP filter association with filter ID 100
sim1>config>filter# ip-filter 100 create
A:sim1>config>filter>ip-filter$ entry 10 create
A:sim1>config>filter>ip-filter>entry$ 
...
A:sim1>config>system>cron>tod-suite# ingress filter ip 100
A:sim1>config>system>cron>tod-suite# info detail
----------------------------------------------
            no description
            ingress
                filter ip 100 
            exit
----------------------------------------------
A:sim1>config>system>cron>tod-suite#
Command usage to configure an association with a SAP ingress QoS policy
config>system>cron>tod-suite$ ingress qos 101
    config>system>cron>tod-suite$

The following is a sample configuration output of an association with a SAP ingress QoS policy.

A:sim1>config>qos# sap-egress 101 create
...
A:sim1>config>system>cron>tod-suite# ingress qos 101 
A:sim1>config>system>cron>tod-suite# info detail
----------------------------------------------
            no description
            ingress
                qos 101 
            exit
----------------------------------------------
A:sim1>config>system>cron>tod-suite# 

Configuring backup copies

The config-backup command allows you to specify the maximum number of backup versions of the configuration and index files kept in the primary location.

For example, assume the config-backup count is set to 5 and the configuration file is named xyz.cfg. When a save command is issued, the xyz.cfg file is saved with a .1 extension. Each subsequent config-backup command increments the numeric extension until the maximum count is reached. The oldest file (5) is deleted as more recent files are saved.

xyz.cfg

xyz.cfg.1

xyz.cfg.2

xyz.cfg.3

xyz.cfg.4

xyz.cfg.5

xyz.ndx

Each persistent index file is updated at the same time as the associated configuration file. When the index file is updated, the save is performed to xyz .cfg and the index file is created as xyz.ndx. Synchronization between the active and standby is performed for all configurations and their associated persistent index files.

Use the following CLI syntax to specify the maximum number of backup versions of the configuration and index files kept in the primary location.

config>system
        config-backup <count>

The following example shows the command usage to set the maximum number of backup versions of the configuration and index files kept in the primary location to 7.

config>system#
    config>system# config-backup 7

Output for the config-backup command

A:ALA-12>config>system>time# info
#------------------------------------------
echo "System Configuration"
#------------------------------------------
        name "ALA-12"
        contact "Fred Information Technology"
        location "Bldg.1-floor 2-Room 201"
        clli-code "abcdefg1234"
        coordinates "N 45 58 23, W 34 56 12"
        config-backup 7
...
----------------------------------------------
A:ALA-12>config>system>time#

System administration parameters

This section describes the system administration parameters and the CLI syntax to configure the parameters.

Validating the golden bootstrap image

The admin>check-golden-bootstrap command validates the current golden bootstrap image and displays its version.

Use the following syntax to validate the current golden boot strap image.

admin 
        check-golden-bootstrap

Command usage to validate the current bootstrap image

admin# check-golden-bootstrap
version TiMOS-L-0.0.I312
Golden Bootstrap Image validation successful

Updating the golden bootstrap image

The admin>update-golden-bootstrap command validates the input file and updates the golden bootstrap image with the contents of this file.

Use the following syntax to update the golden boot strap image.

admin
        update-golden-bootstrap [file-url]

Command usage to update the bootstrap image

admin# update-golden-bootstrap boot.tim
Updating Golden Bootstrap Image from "boot.tim"
This operation must not be interrupted
Updating Golden Bootstrap image .... Completed.

Disconnect

The disconnect command immediately disconnects a user from a console, Telnet, FTP, or SSH session.

Note:

Configuration modifications are saved to the primary image file.

Use the following syntax to disconnect a user from a session.

admin
        disconnect [address ip-address |username user-name | {console|telnet|ftp|ssh}]

Command usage to disconnect a user from a session

admin# disconnect 

Output of the disconnect command

ALA-1>admin# disconnect
ALA-1>admin# Logged out by the administrator
Connection to host lost.

C:\>

Set-time

Use the set-time command to set the system date and time. The time entered should be accurate for the time zone configured for the system. The system will convert the local time to UTC before saving to the system clock, which is always set to UTC. If SNTP or NTP is enabled (no shutdown), this command cannot be used. The set-time command does not take into account any daylight saving offset, if defined.

Use the following syntax to set the system date and time.

admin
        set-time date time

The following example shows the .

Command usage to set the system date and time

admin# set-time 2007/02/06 04:10:00

Output of the set-time command

ALA-2# admin set-time 2007/02/06 04:10:00
ALA-2# show time
Thu Feb 2 04:10:04 GMT 2007
ALA-2#

Display-config

The display-config command displays the running configuration of the system.

Use the following syntax to display the running configuration of the system.

admin
        display-config [detail] [index]

Command usage to display the detailed running configuration of the system

admin# display-config detail

Output of the display-config detail command

A:ALA-12>admin# display-config detail
#------------------------------------------
echo "System Configuration"
#------------------------------------------
    system
        name "ALA-12"
        contact "Fred Information Technology"
        location "Bldg.1-floor 2-Room 201"
        clli-code "abcdefg1234"
        coordinates "N 45 58 23, W 34 56 12"
        config-backup 7
        boot-good-exec "ftp://test:test@192.168.xx.xxx/./1xx.cfg.A"
        boot-bad-exec "ftp://test:test@192.168.xx.xxx/./1xx.cfg.1"
        lacp-system-priority 1
        no synchronize
        snmp
            shutdown
            engineID "0000197f000000000467ff00"
            packet-size 1500
            general-port 161
        exit
        login-control
            ftp
                inbound-max-sessions 3
            exit
            telnet
                inbound-max-sessions 5
                outbound-max-sessions 2
            exit
            idle-timeout 1440
            pre-login-message "Property of Service Routing Inc.Unauthorized 
access prohibited."
            motd text ‟Notice to all users: Software upgrade scheduled 3/2 1:00 AM"
        exit
        security
            management-access-filter
                default-action permit
                entry 1
                    no description
...

Tech-support

Note:

This command should only be used with explicit authorization and direction from the Nokia Technical Assistance Center (TAC).

Save

The save command saves the running configuration to a configuration file. If the debug-save parameter is specified, debug configurations are saved in the configuration file; otherwise, the debug configurations are not saved between reboots.

Use the following syntax to save the running configuration and debug configurations to a configuration file.

admin
        save [file-url] [detail] [index] 
        debug-save [file-url]

The following example shows the command usage to save the running configuration and the debug configurations to a configuration file.

admin# save ftp://test:test@192.168.x.xx/./1.cfg
    admin# debug-save debugsave.txt

save command output

A:ALA-1>admin# save ftp://test:test@192.168.x.xx/./1x.cfg
Writing file to ftp://test:test@192.168.x.xx/./1x.cfg
Saving configuration ...Completed.
ALA-1>admin# debug-save ftp://test:test@192.168.x.xx/./debugsave.txt
Writing file to ftp://julie:julie@192.168.x.xx/./debugsave.txt
Saving debug configuration .....Completed.
A:ALA-1>admin#

Reboot

The reboot command reboots the router, including redundant cards in redundant systems. If the now option is not specified, you are prompted to confirm the reboot operation.

Use the following syntax to reboot the router.

admin
        reboot [auto-init][now]

Command usage to reboot the router

admin# reboot now

reboot command output

A:ALA-1>admin# reboot now
Are you sure you want to reboot (y/n)? y
Rebooting...
Using preloaded VxWorks boot loader.
...

When an admin reboot auto-init command is issued, the system resets the existing BOF and reboots. The system startup process after the admin reboot auto-init command is executed is the same as the first-time system boot described in System initialization.

Note:

After the BOF is reset, the system may not boot up with the last saved system configuration unless the new BOF also uses the same configuration file. If you require the system to boot up with the last saved system configuration, Nokia recommends that you should run the admin>save file-url command to save the current system configuration and modify the BOF to use this configuration.

Use the following CLI to reset the BOF and reboot.

admin# reboot auto-init [now]

admin reboot auto-init command output

Example: *A:ALA-1# admin reboot auto-init 
WARNING: Configuration and/or Boot options may have changed since the last save.
Are you sure you want to reset the bof and reboot (y/n)? Y 
Resetting...OK

Nokia 7210 Boot ROM. Copyright 2016 Nokia.
All rights reserved. All use is subject to applicable license agreements.

Post-boot configuration extension files

Two post-boot configuration extension files are supported and are triggered when either a successful or failed boot configuration file is processed. The commands specify URLs for the CLI scripts that are run following the completion of the boot-up configuration. A URL must be specified or no action is taken. The commands are persistent between router reboots and are included in the configuration saves (admin save).

Use the following syntax to specify the CLI scripts that are tun following the completion of the boot-up configuration.

config>system 
        boot-bad-exec file-url
        boot-good-exec file-url

The following example shows the command usage to specify the CLI scripts that are run following the completion of the boot-up configuration.

config>system# boot-bad-exec ftp://test:test@192.168.xx.xxx/./
    fail.cfg
    config>system# boot-good-exec ftp://test:test@192.168.xx.xxx/./
    ok.cfg

Command output

*A:ALA# configure system 
*A:ALA>config>system# info 
----------------------------------------------
#--------------------------------------------------
echo "System Configuration"
#--------------------------------------------------
        name "ALA"
        boot-good-exec "cf1:\good.cfg"
        boot-bad-exec "cf1:\bad.cfg"
        snmp
            shutdown
        exit
        login-control
            idle-timeout disable
            pre-login-message "ala-1" name
        exit
        time
            ntp
                authentication-key 1 key "SV3BxZCsIvI" hash type message-digest 
                server 10.135.16.130 
                peer 10.0.0.1 key-id 1 
                no shutdown
            exit
            sntp
                server-address 10.135.16.90 preferred 
                no shutdown           
            exit
            zone UTC 
        exit
        thresholds
            rmon
            exit
        exit
#--------------------------------------------------
echo "System Security Configuration"
#--------------------------------------------------
        security
            hash-control read-version all write-version 1 
            telnet-server
            ftp-server
            snmp
                community "private" rwa version both
                community "public" r version both
            exit
            source-address
                application ftp 10.135.16.97
                application snmptrap 10.135.16.97
                application ping 10.135.16.97
                application dns 10.135.16.97
            exit
        exit
----------------------------------------------
*A:ALA>config>system#

Show command output and console messages

The show system information command displays the current value of the bad and good exec URLs and indicates whether a post-boot configuration extension file was executed when the system was booted. If an extension file was executed, the show system information command also indicates if it completed successfully.

When executing a post-boot configuration extension file, status messages are output to the console screen before the ‟Login” prompt.

The following is sample output of a failed boot-up configuration that caused a boot-bad-exec file containing another error to be executed.

Attempting to exec configuration file:
’ftp://test:test@192.168.xx.xxx/./12.cfg’ ...
System Configuration
Log Configuration
MAJOR: CLI #1009 An error occurred while processing a CLI command -
File ftp://test:test@192.168.xx.xxx/./12.cfg, Line 195: Command "log" failed.
CRITICAL: CLI #1002 An error occurred while processing the configuration file.
The system configuration is missing or incomplete.
MAJOR: CLI #1008 The SNMP daemon is disabled.
If desired, enable SNMP with the ’config>system>snmp no shutdown’ command.
Attempting to exec configuration failure extension file:
’ftp://test:test@192.168.xx.xxx/./fail.cfg’ ...
Config fail extension
Enabling SNMP daemon
MAJOR: CLI #1009 An error occurred while processing a CLI command -
File ftp://test:test@192.168.xx.xxx/./fail.cfg, Line 5: Command "abc log" failed.
TiMOS-B-x.0.Rx both/hops NOKIA Copyright (c) 2016 Nokia.
All rights reserved. All use subject to applicable license agreements.
Built on Thu Nov 20 19:19:11 PST 2016 by builder in /rel5x.0/b1/Rx/panos/main


Login: 

System timing

When synchronous Ethernet is enabled, the operator can select an Ethernet port as a candidate for timing reference. The timing information recovered from this port is used to time the system.

CLI command syntax for 7210 SAS platforms

This section describes the CLI command syntax to enable synchronous Ethernet on specific 7210 SAS platforms.

CLI syntax for 7210 SAS-D

CLI configuration for the 7210 SAS-D
*A:sas-d>config>system>sync-if-timing# info detail
----------------------------------------------
            no ql-selection
            ref-order ref1 ref2
            ref1
                shutdown
                no source-port
                no ql-override
            exit
            ref2
                shutdown
                no source-port
                no ql-override
            exit
            ptp
                shutdown
                no ql-override
            exit
            no revert
----------------------------------------------
*A:sas-d>config>system>sync-if-timing#

CLI syntax for 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

The following is a sample CLI configuration for the 7210 SAS-K 2F6C4T, 7210 SAS-K 3SFP+ 8C, and 7210 SAS-K 2F1C2T.

A:Dut-A>config>system>sync-if-timing# info detail
----------------------------------------------
            no ql-selection
            ref-order ref1 ref2 ptp
            ref1
                shutdown
                no source-port
                no ql-override
            exit
            ref2
                shutdown
                no source-port
                no ql-override
            exit
            ptp
                shutdown
                no ql-override
            exit
            no revert
----------------------------------------------
A:Dut-A>config>system>sync-if-timing#

Entering edit mode

To enter edit mode and edit timing references, enter the begin keyword at the config>system>sync-if-timing# prompt.

Use the following CLI syntax to enter edit mode.

config>system>sync-if-timing
        begin

The following is a sample error message that is displayed if you try to modify sync-if-timing parameters without entering the begin keyword.

ort 2/1/1
MINOR: CLI The sync-if-timing must be in edit mode by calling begin before any 
changes can be made.
MINOR: CLI Unable to set source port for ref1 to 2/1/1.
A:ALA-12>config>system>sync-if-timing>ref1#
Note:

Use commit to save or abort to discard the changes made in a session.

Configuring timing references

On the 7210 SAS-D, ref1 must be configured to use one of ports 1/1/1 to 1/1/4 and ref2 must be configured to use either port 1/1/5 or 1/1/6. The software enforces this check. Ports 1/1/7 to 1/1/10 can be configured as either ref1 or ref2.

There is no port restriction on the 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, or 7210 SAS-K 3SFP+ 8C; any port can be configured for ref1 or ref2.

Configuration of timing reference parameters

config>system# sync-if-timing
config>system>sync-if-timing# begin
config>system>sync-if-timing# ref1
config>system>sync-if-timing>ref1# source-port 1/1/1
config>system>sync-if-timing>ref1# no shutdown
config>system>sync-if-timing>ref1# exit
config>system>sync-if-timing# ref2
config>system>sync-if-timing>ref2# source-port 1/1/2
config>system>sync-if-timing>ref2# no shutdown
config>system>sync-if-timing>ref2# exit
config>system>sync-if-timing>commit

Timing reference parameters

*7210-SAS>config>system>sync-if-timing#info detail
 
----------------------------------------------
ref-order ref1 ref2
ref1
source-port 1/1/1
no shutdown
exit
ref2
source-port 1/1/2
no shutdown
exit
no revert
----------------------------------------------

Using the revert command

The revert command allows the clock to revert to a higher-priority reference if the current reference goes offline or becomes unstable.

If revertive switching is enabled, the highest-priority valid timing reference is used. If a reference with a higher priority becomes valid, a switchover to that reference is initiated. If a failure on the current reference occurs, the next highest reference takes over.

If non-revertive switching is enabled, the active reference always remains selected while its valid, even if a higher priority reference becomes available. If the active reference becomes invalid, a reference switchover to a valid reference with the highest priority is initiated. The failed reference is eligible for selection when it becomes operational.

config>system>sync-if-timing
        revert

Other editing commands

Other editing commands are:

  • commit

    Saves changes made to the timing references during a session. Modifications are not persistent across system boots unless this command is entered.

  • abort

    Discards changes that have been made to the timing references during a session.

Use the following syntax to abort or commit changes made to a timing reference.

config>system>sync-if-timing
        abort
        commit

Forcing a specific reference

You can force the system synchronous timing output to use a specific reference.

Note:

The debug sync-if-timing force-reference command should only be used to test and debug problems. After the system timing reference input has been forced, it does not revert to another reference unless explicitly reconfigured, if the forced reference fails, or if the received QL code is QL-DNU/DUS and QL selection is enabled.

When the debug sync-if-timing force-reference command is run, the current system synchronous timing output is immediately referenced from the specified reference input. The reference must be qualified.

Debug configurations are not saved between reboots.

Use the following syntax to reference the current system synchronous timing output from the specifies reference input.

debug>sync-if-timing
        force-reference {ref1 | ref2}

The following example shows the command usage to reference the current system synchronous timing output from the specifies reference input.

debug>sync-if-timing# force-reference

Configuring system monitoring thresholds

This section describes how to configure system monitoring thresholds.

Creating events

The event command controls the generation and notification of threshold crossing events configured with the alarm command. When a threshold crossing event is triggered, the rmon event configuration optionally specifies whether an entry in the RMON-MIB log table is created to record the occurrence of the event. It can also specify whether an SNMP notification (trap) is generated for the event. There are two notifications for threshold crossing events: a rising alarm and a falling alarm.ping-address.

Creating an event entry in the RMON-MIB log table does not create a corresponding entry in the 7210 SAS event logs. However, when the event is set to trap, the generation of a rising alarm or falling alarm, a notification creates an entry in the event logs and is distributed to the configured log destinations, including: console, session, memory, file, syslog, or SNMP trap destination. The logger message includes a rising or falling threshold crossing event indicator, the sample type (absolute or delta), the sampled value, the threshold value, the rmon-alarm-id, the associated rmon-event-id, and the sampled SNMP object identifier.

The alarm command configures an entry in the RMON-MIB alarm table. The alarm command controls the monitoring and triggering of threshold crossing events. To trigger the notification or logging of a threshold crossing event, at least one associated rmon event must be configured.

The agent periodically takes statistical sample values from the MIB variable specified for monitoring and compares them to thresholds that have been configured with the alarm command. The alarm command configures the MIB variable to be monitored, the polling period (interval), sampling type (absolute or delta value), and rising and falling threshold parameters. If a sample has crossed a threshold value, the associated event is generated.

Preconfigured CLI threshold commands are available. Preconfigured commands hide some of the complexities of configuring RMON alarm and event commands and perform the same function. In particular, the preconfigured commands do not require the user to know the SNMP object identifier to be sampled. The preconfigured threshold configurations include memory warnings, alarms, and compact flash usage warnings and alarms.

To create events, use the following sample CLI configuration.

config>system>thresholds# cflash-cap-warn cf1-B: rising-threshold 2000000 falling-threshold 1999900 interval 240 trap startup-alarm either
config>system>thresholds# memory-use-alarm rising-threshold 50000000 falling-threshold 45999999 interval 500 both startup-alarm either
config>system>thresh# rmon
config>system>thresh>rmon# event 5 both description "alarm testing" owner "Timos CLI"

Command output

A:ALA-49>config>system>thresholds# info
----------------------------------------------
            rmon
                event 5 description "alarm testing" owner "Timos CLI"
            exit
            cflash-cap-warn cf1-B: rising-threshold 2000000 falling-threshold 
1999900 interval 240 trap
            memory-use-alarm rising-threshold 50000000 falling-threshold 
45999999 interval 500
----------------------------------------------
A:ALA-49>config>system>thresholds#

Configuring an alarm input

The 7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C do not support alarm contact inputs; instead, they provide an option to configure the console port as an alarm input pin. A single alarm input pin can be enabled for use with the console port, allowing operators to monitor external events and alert the operator.

You can configure generation of events when alarm input pins transition between the open and close states. For each generated event, you can specify the following:

  • action associated with each state transition

  • severity associated with each state transition

  • log message associated with each state transition

The RXD and TXD pins of the console input is used to provide a single alarm input pin functionality. The RXD and TXD pins of the console port is used by software to detect external events. The operating system detects an open or closed circuit, triggers an alarm, and logs it when an event is detected.

By default, the console port does not provide alarm input pin functionality. The CLI command configure>system>console>use-console-alarm-input is used to enable the use of console port as an alarm input pin. After this command is executed, the console port can no longer be used as a console port, and the system generates a log message to convey this restriction. Additionally, the user must configure the alarm-contact-input parameters for the console by using the CLI command config> system>alarm-contact-input console-1.

Note:

The user must enable a Telnet session with the node before enabling the console as an alarm input. After the alarm input functionality is enabled, the user can configure the alarm-contact-input no shutdown using the Telnet session.

Configuring system resource profile

System resource profile defaults

*A:Dut-A>config>system>res-prof# info detail
----------------------------------------------
            ingress-internal-tcam
                no qos-sap-ingress-resource
                acl-sap-ingress 1
                    no mac-ipv4-ipv6-128-match-enable
                exit
            exit
            egress-internal-tcam
                acl-sap-egress 2
                    no mac-ipv4-ipv6-128-match-enable
                exit
                no eth-cfm-primary-vlan-enable
            exit
----------------------------------------------
*A:Dut-A>config>system>res-prof#

Configuring LLDP

Use the following syntax to configure LLDP.

config>system>lldp
        tx-interval <interval>
        tx-hold-multiplier <multiplier>
        reinit-delay <time>
        notification-interval <time>
        tx-credit-max <count>
        message-fast-tx <time>
        message-fast-init <count>
        shutdown

The following is a sample .

LLDP port configuration

*A:7210-SAS>config>port>ethernet>lldp# info
----------------------------------------------
       dest-mac nearest-bridge
              admin-status tx-rx
              tx-tlvs port-desc sys-cap
              tx-mgmt-address system
       exit
----------------------------------------------
*A:7210-SAS>config>port>ethernet>lldp#

Global system LLDP configuration


A:7210-SAS>config>system>lldp# info
----------------------------------------------
        tx-interval 10
        tx-hold-multiplier 2
        reinit-delay 5
        notification-interval 10
----------------------------------------------
A:7210-SAS>config>system>lldp#

System command reference

Note:

Some commands are available only on specific platforms. Support for a command on a specific platform is stated explicitly in the CLI command description.

Command hierarchies

Configuration commands

System information commands
config
    - system 
        - boot-bad-exec file-url
        - no boot-bad-exec 
        - boot-good-exec 
        - boot-good-exec
        - clli-code clli-code
        - no clli-code
        - config-backup count
        - no config-backup
        - contact contact-name
        - no contact
        - coordinates coordinates
        - no coordinates
        - lacp-system-priority lacp-system-priority
        - no lacp-system-priority
        - lldp
        - location location
        - no location
        - login-control
        - name system-name
        - no name
        - poe
            - max-poe-power-budget value
            - no max-poe-power-budget
        - power-supply [power-supply-id] type power-module-type module-type
        - power-supply [power-supply-id] type 
        - [no] oper-group name [create]
            - hold-time
                - [no] group-down time in seconds
                - [no] group-up time in seconds
System alarm commands
config
    - system
        - thresholds
            - kb-memory-use-alarm cflash-id rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
            - no kb-memory-use-alarm cflash-id
            - cflash-cap-warn cflash-id rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
            - no cflash-cap-warn cflash-id 
            - kb-memory-use-alarm rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
            - no kb-memory-use-alarm
            - kb-memory-use-warn rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
            - no kb-memory-use-warn
            - memory-use-alarm rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
            - no memory-use-alarm
            - memory-use-warn rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
            - no memory-use-warn
            - [no] rmon
                - alarm rmon-alarm-id variable-oid oid-string interval seconds [sample-type] [startup-alarm alarm-type] [rising-event rmon-event-id rising-threshold threshold] [falling event rmon-event-id falling-threshold threshold] [owner owner-string]
                - no alarm rmon-alarm-id
                - event rmon-event-id [event-type] [description description-string] [owner owner-string]
                - no event rmon-event-id 
PTP commands for 7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C
config
    - system 
        - ptp
            - anno-rx-timeout count 
            - no anno-rx-timeout 
            - clock
                - freq-source freq-source
                - no freq-source
            - clock-type boundary
            - clock-type ordinary {slave}
            - domain domain-value
            - no domain
            - local-priority priority 
            - log-anno-interval log-interval 
            - no log-anno-interval 
            - log-sync-interval value 
            - no log-sync-interval
            - network-type {sdh | sonet} 
            - peer ip-address [create]
            - no peer ip-address
                - local-priority priority 
                - [no] shutdown
            - port port-id [create]
            - no port port-id 
                - address {01:1b:19:00:00:00 | 01:80:c2:00:00:0e}
                - local-priority priority 
                - master-only {true | false} 
                - [no] shutdown 
            - priority1 priority-value	
            - no priority1
            - priority2 priority-value	
            - no priority2
            - profile {g8265dot1-2010 | ieee1588-2008 | g8275dot1-2014 | iec-61850-9-3-2016 | c37dot238-2017}
            - [no] shutdown
PTP commands for 7210 SAS-K 2F1C2T
config
    - system 
        - ptp
            - clock
                - freq-source freq-source
                - no freq-source
            - clock-type boundary
            - clock-type ordinary {slave}
            - domain domain-value
            - no domain
            - log-sync-interval value 
            - no log-sync-interval
            - network-type {sdh | sonet} 
            - peer ip-address [create]
            - no peer ip-address
                - local-priority priority 
                - [no] shutdown
            - priority1 priority-value	
            - no priority1
            - priority2 priority-value	
            - no priority2
            - profile {g8265dot1-2010 | ieee1588-2008 | g8275dot1-2014}
            - [no] shutdown
System time commands
root
    - admin
        - set-time [date] [time] 
config
    - system 
        - time
            - [no] ntp
                - [no] authentication-check
                - authentication-key key-id key key [hash | hash2] type {des | message-digest}
                - no authentication-keykey-id
                - [no] broadcast [router router-name] {interface ip-int-name} [key-id key-id]  [version version] [ttl ttl]
                - [no] broadcast [router router-name] {interface ip-int-name}
                - broadcastclient [router router-name] {interface ip-int-name} [authenticate]
                - [no] broadcastclient [router router-name] {interface ip-int-name}
                - [no] ntp-server [authenticate]
                - [no] peer ip-address [version version] [key-id key-id] [prefer]
                - [no] server {ip-address| ptp} [version version] [key-id key-id] [prefer]
                - [no] shutdown
            - [no] sntp
                - [no] broadcast-client 
                - server-address ip-address [version version-number] [normal | preferred] [interval seconds]
                - no server-address ip-address
                - [no] shutdown
            - [no] dst-zone [std-zone-name | non-std-zone-name]
                - end {end-week} {end-day} {end-month} [hours-minutes]
                - offset offset
                - start {start-week} {start-day} {start-month} [hours-minutes]
            - zone std-zone-name | non-std-zone-name [hh [:mm]] 
            - no zone
CRON commands
config>system
    - [no] cron
        - [no] schedule schedule-name [owner schedule-owner]
            - count number
            - [no] day-of-month {day-number [..day-number] all}
            - [no] description description-string 
            - [no] end-time [date | day-name] time
            - [no] hour {..hour-number [..hour-number]|all} 
            - [no] interval seconds 
            - [no] minute {minute-number [..minute-number]|all} 
            - [no] month {month-number [..month-number]|month-name [..month-name]|all}
            - [no] script-policy policy-name [owner policy-owner]
            - [no] shutdown
            - type {schedule-type} 
            - [no] weekday {weekday-number [..weekday-number]|day-name [..day-name]|all}
        - [no] time-range name [create]
            - absolute start start-absolute-time end end-absolute-time
            - no absolute start start-absolute-time
            - daily start start-time-of-day end end-time-of-day
            -  no daily start start-time-of-day
            - [no] description description-string 
            - weekdays start start-time-of-day end end-time-of-day
            - no weekdays start start-time-of-day
            - weekend start start-time-of-day end end-time-of-day
            - no weekend start start-time-of-day
            - weekly start start-time-in-week end end-time-in-week
            - no weekly start start-time-in-week
        - [no] tod-suite tod-suite-name [create]
            - [no] description description-string 
            - egress 
                - filter ip ip-filter-id [time-range time-range-name] [priority priority] 
                - filter mac mac-filter-id [time-range time-range-name] [priority priority]
                - filter ipv6 ipv6-filter-id [time-range time-range-name] [priority priority] 
                - no filter ip ip-filter-id [time-range time-range-name] 
                - no filter mac mac-filter-id [time-range time-range-name
                - no filter ipv6 ipv6-filter-id [time-range time-range-name] 
            - ingress
                - filter ip ip-filter-id [time-range time-range-name] [priority priority] 
                - filter mac mac-filter-id [time-range time-range-name] [priority priority] 
                - filter ipv6 ipv6-filter-id [time-range time-range-name] [priority priority]
                - no filter ip ip-filter-id [time-range time-range-name] 
                - no filter mac mac-filter-id [time-range time-range-name
                - no filter ipv6 ipv6-filter-id [time-range time-range-name]
                - qos policy-id [time-range time-range-name] [priority priority] 
                - no qos policy-id [time-range time-range-name]
System synchronization commands
config
    - system 
        - sync-if-timing
            - abort
            - begin
            - commit
            - ptp
                - ql-override {prs | stu | st2 | tnc | st3e | st3 | prc | ssua | ssub | sec}
                - no ql-override
                - [no] shutdown
            - [no] ql-selection
            - ref-order first second third
            - no ref-order
            - ref1
                - ql-override {prs | stu | st2 | tnc | st3e | st3 | prc | ssua | ssub | sec | eec1 | eec2}
                - no ql-override
                - [no] shutdown
                - source-port port-id
                - no source-port
            - ref2
                - ql-override {prs | stu | st2 | tnc | st3e | st3 | prc | ssua | ssub | sec | eec1 | eec2}
                - no ql-override
                - [no] shutdown
                - source-port port-id
                - no source-port
            - [no] revert
LLDP system commands
config>system
        - lldp
            - lldp-med 
                - network-policy network-policy-id [create] 
                - no network-policy network-policy-id 
                - application-type {voice | voice-signaling | guest-voice | guest-voice-signaling | soft-phone-voice | video-conferencing | streaming-video | video-signaling} 
                - no application-type 
                - dot1p dot1p-value
                - no dot1p 
                - ip-dscp ip-dscp
                - no ip-dscp 
                - vlan-id vlan-id
                - no vlan-id 
                - [no] vlan-tag-present 
            - message-fast-tx time
            - no message-fast-tx
            - message-fast-tx-init count
            - no message-fast-tx-init
            - notification-interval time
            - no notification-interval
            - reinit-delay time
            - no reinit-delay
            - [no] shutdown
            - tx-credit-max count
            - no tx-credit-max
            - tx-hold-multiplier multiplier
            - no tx-hold-multiplier
            - tx-interval interval
            - no tx-interval
System resource-profile commands for 7210 SAS-D and 7210 SAS-Dxp
config
    - system
        - resource-profile
            - decommission
                - entry entry-id port port-range to port-range
                - no entry entry-id
            - egress-internal-tcam
                - acl-sap-egress [num-resources]
                - no acl-sap-egress
                    - ipv6-128bit-match-enable num-resources
                    - no ipv6-128bit-match-enable
                    - mac-ipv4-match-enable num-resources
                    - no mac-ipv4-match-enable
                    - mac-ipv6-64bit-match-enable num-resources
                    - no mac-ipv6-64bit-match-enable
                    - mac-match-enable num-resources
                    - no mac-match-enable
                - egress-sap-aggregate-meter num-resources
                - no egress-sap-aggregate-meter num-resources
                - mac-auth-res num-resources
                - no mac-auth-res
            - ingress-internal-tcam
                - acl-sap-ingress [num-resources]
                - no acl-sap-ingress
                    - ipv4-ipv6-128-match-enable num-resources
                    - no ipv4-ipv6-128-match-enable
                    - ipv4-match-enable num-resources
                    - no ipv4-match-enable
                    - ipv6-64-only-match-enable num-resources
                    - no ipv6-64-only-match-enable
                    - mac-match-enable num-resources 
                    - no mac-match-enable
                - eth-cfm [num-resources] 
                - no eth-cfm
                    - up-mep num-resources 
                    - no up-mep 
                - mac-auth-res num-resources
                - no mac-auth-res
                - qos-sap-ingress-resource num-resources
                - no qos-sap-ingress-resource
                    - ipv4-mac-match-enable num-resources
                    - no ipv4-mac-match-enable
                    - ipv4-match-enable num-resources
                    - no ipv4-match-enable
                    - ipv6-ipv4-match-enable num-resources
                    - no ipv6-ipv4-match-enable
                    - mac-match-enable num-resources
                    - no mac-match-enable
                - sap-aggregate-meter num-resources
                - no sap-aggregate-meter
System resource-profile commands for 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C
Fan controller commands for 7210 SAS-D and 7210 SAS-D ETR variant with 128MB flash
config
    - system
        - fan {on | off | auto}

Show commands

show
    - alarm-contact-input alarm-contact-input-id [detail]
    - alarm-contact-input all 
    - chassis [environment] [power-supply]
    - chassis
    - system
        - cron
            - schedule action-name [owner owner-name]
            - tod-suite tod-suite-name [detail] associations failed-associations 
            - time-range name associations [detail] 
        - connections [address ip-address [port port-number] [detail]
        - cpu [sample-period seconds] 
        - information
        - lldp
        - lldp 
        - memory-pools
        - ntp [{peers | peer peer-address} | {servers | server server-address} | [all] [detail]
        - resource-profile [active | configured] 
        - ptp
            - peer ip-address [router router-instance | service-name service-name] [detail]
            - peers [router router-instance | service-name service-name] [detail]
            - port port-id [detail]
            - statistics
            - unicast [router router-instance | service-name service-name]
        - sntp
        - sync-if-timing
        - script-control
            - script [script-name] [owner script-owner]
            - script-policy script-policy-name [owner owner-name]
            - script-policy run-history [run-state]
        - thresholds
        - time
        - time
    - oper-group [group-name]
    - oper-group group-name [detail]
    - oper-group group-name [monitoring]
    - uptime

Command descriptions

Configuration commands

Generic commands
shutdown
Syntax

[no] shutdown

Context

config>system>ptp

config>system>ptp>peer

config>system>ptp>port

config>system>time>ntp

config>system>time>sntp

config>system>cron>sched

config>system>script-control>script-policy

config>system>script-control>script

config>system>alarms

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command administratively disables the entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics.

The operational state of the entity is disabled as well as the operational state of any entities contained within. Many objects must be shut down before they may be deleted.

The no form of this command places the entity into an administratively enabled state.

Default

no shutdown

description
Syntax

description description-string

no description

Context

config>system>cron>sched

config>system>cron>tod-suite

config>system>script-control>script

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command creates a text description stored in the configuration file for a configuration context.

The description command associates a text string with a configuration context to help identify the content in the configuration file.

The no form of this command removes the string from the configuration.

Parameters
string

Specifies the description character string. Allowed values are any string up to 80 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

System information commands
boot-bad-exec
Syntax

boot-bad-exec file-url

no boot-bad-exec

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures a URL for a CLI script to exec following a failure of a boot-up configuration. The command specifies a URL for the CLI scripts to be run following the completion of the boot-up configuration. A URL must be specified or no action is taken.

The commands are persistent between router reboots and are included in the configuration saves (admin save).

See the exec command for related commands. This command executes the contents of a text file as if they were commands entered at the console.

Default

no boot-bad-exec

Parameters
file-url

Specifies the location and name of the CLI script file executed following failure of the boot-up configuration file execution. When this parameter is not specified, no CLI script file is executed.

Values

file url local-url | remote-url: 255 chars max

local-url — [cflash-id/ | usb-flash-id][file-path]

remote-url — [{ftp://} login:pswd@remote-locn/][file-path]

remote-locn — [hostname | ipv4-address]

ipv4-address — a.b.c.d

cflash-id — cf1:

usb-flash-id — uf1:

boot-good-exec
Syntax

boot-good-exec file-url

no boot-good-exec

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures a URL for a CLI script to exec following the success of a boot-up configuration.

The exec command executes the contents of a text file as if they were CLI commands entered at the console.

Default

no boot-good-exec

Parameters
file-url

Specifies the location and name of the file executed following successful completion of the boot-up configuration file execution. When this parameter is not specified, no CLI script file is executed.

Values

file url local-url | remote-url: 255 chars max

local-url — [cflash-id/ | usb-flash-id][file-path]

remote-url — [{ftp://} login:pswd@remote-locn/][file-path]

remote-locn — [hostname | ipv4-address]

ipv4-address — a.b.c.d

cflash-id — cf1:

usb-flash-id — uf1:

clli-code
Syntax

clli-code clli-code

no clli-code

Context

config>system

Platforms

Supported on all 7210 SASplatforms as described in this document

Description

This command creates a Common Language Location Identifier (CLLI) code string for the router. A CLLI code is an 11-character standardized geographic identifier that uniquely identifies geographic locations and specific functional categories of equipment unique to the telecommunications industry.

No CLLI validity checks other than truncating or padding the string to eleven characters are performed.

Only one CLLI code can be configured, if multiple CLLI codes are configured the last one entered overwrites the previous entry.

The no form of this command removes the CLLI code.

Parameters
clli-code

Specifies the 11 character string CLLI code. Any printable, seven bit ASCII characters can be used within the string. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes. If more than 11 characters are entered, the string is truncated. If less than 11 characters are entered the string is padded with spaces.

config-backup
Syntax

config-backup count

no config-backup

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures the maximum number of backup versions maintained for configuration files and BOF.

For example, assume the config-backup count is set to 5 and the configuration file is called xyz.cfg. When a save command is executed, the file xyz.cfg is saved with a .1 extension. Each subsequent config-backup command increments the numeric extension until the maximum count is reached.

xyz.cfg

xyz.cfg.1

xyz.cfg.2

xyz.cfg.3

xyz.cfg.4

xyz.cfg.5

xyz.ndx

Each persistent index file is updated at the same time as the associated configuration file. When the index file is updated, then the save is performed to xyz.cfg and the index file is created as xyz.ndx. Synchronization between the active and standby is performed for all configurations and their associated persistent index files.

The no form of this command reverts to the default value.

Default

5

Parameters
count

Specifies the maximum number of backup revisions.

Values

1 to 9

console
Syntax

console

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure console as an alarm-input-pin.

use-console-alarm-input
Syntax

[no] use-console-alarm-input

Context

config>system>console

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command provides an option to the user to use the console port on the 7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, or 7210 SAS-K 3SFP+ 8C as an alarm-input pin. When this command is executed, the console port can be used as an alarm input pin. A single alarm-input pin can be enabled for use with the console port, allowing operators to monitor external events and alert the operator. For this command to take effect, the console must be enabled in the BOF.

The RXD and TXD pins of the console input is used to provide a single alarm input pin functionality and is used by the software to detect external events. The operating system detects an open or a close circuit which triggers an alarm and logs it when an event is detected.

After this command is executed, the console port can no longer be used as a console port, and the system generates a log message to convey this restriction. Additionally, the user needs to configure the alarm-contact-input parameter for console by using the config system alarm-contact-input console-1 command (the console alarm-contact-input is identified with the ID = console-1).

The no form of this command disables use of console port as alarm-input interface.

Default

no use-console-alarm-input

contact
Syntax

contact contact-name

no contact

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command creates a text string that identifies the contact name for the device.

Only one contact can be configured. If multiple contacts are configured, the last one entered overwrites the previous entry.

The no form of this command reverts to the default.

Parameters
contact-name

Specifies the contact name character string. The string can be up to 80 characters. Any printable, seven-bit ASCII characters can be used within the string. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

coordinates
Syntax

coordinates coordinates

no coordinates

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command creates a text string that identifies the system coordinates for the device location. The coordinates ‟37.390 -122.0550" command is read as latitude 37.390 north and longitude 122.0550 west.

Only one set of coordinates can be configured. If multiple coordinates are configured, the last one entered overwrites the previous entry.

The no form of this command reverts to the default value.

Parameters
coordinates

Specifies the coordinates describing the device location character string. The string may be up to 80 characters. Any printable, seven-bit ASCII characters can be used within the string. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes. If the coordinates are subsequently used by an algorithm that locates the exact position of this node then the string must match the requirements of the algorithm.

lacp-system-priority
Syntax

lacp-system-priority lacp-system-priority

no lacp-system-priority

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures the Link Aggregation Control Protocol (LACP) system priority on aggregated Ethernet interfaces. LACP allows the operator to aggregate multiple physical interfaces to form one logical interface.

Default

32768

Parameters
lacp-system-priority

Specifies the LACP system priority

Values

1 to 65535

location
Syntax

location location

no location

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command creates a text string that identifies the system location for the device.

Only one location can be configured. If multiple locations are configured, the last one entered overwrites the previous entry.

The no form of this command reverts to the default value.

Parameters
location

Specifies the location as a character string. The string may be up to 80 characters. Any printable, seven-bit ASCII characters can be used within the string. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

login-control
Syntax

login-control

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure login control.

name
Syntax

name system-name

no name

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command creates a system name string for the device.

For example, system-name parameter ALA-1 for the name command configures the device name as ALA-1.

Only one system name can be configured. If multiple system names are configured, the last one encountered overwrites the previous entry.

The no form of this command reverts to the default value.

Default

The default system name is set to the chassis serial number which is read from the backplane EEPROM.

Parameters
system-name

Specifies the system name as a character string. The string may be up to 32 characters. Any printable, seven-bit ASCII characters can be used within the string. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

oper-group
Syntax

oper-group name [create]

no oper-group

Context

config>system

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command creates a system-wide group name which can be used to associate a number of service objects; for example, ports. The status of the group is derived from the status of its members. The status of the group can then be used to influence the status of non-member objects. For example, when a group status is marked as down, the objects that monitor the group change their status accordingly.

The no form of this command removes the group. All the object associations need to be removed before the no command can be executed.

Default

no oper-group

Parameters
name

Specifies the operational group identifier, up to 32 characters.

create

Keyword to create the configuration context. After the context is created, it is possible to navigate into the context without the create keyword.

hold-time
Syntax

hold-time

Context

config>system>oper-group

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context configure hold time information.

group-down
Syntax

[no] group-down time in seconds

Context

config>system>oper-group>hold-time

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the number of seconds to wait before notifying clients monitoring this group when its operational status transitions from down to up. A value of zero indicates that transitions are reported immediately to monitoring clients.

The no form reverts the value to the default.

Default

0

Parameters
time in seconds

Specifies the wait time, in seconds.

Values

0 to 3600

group-up
Syntax

[no] group-up time in seconds

Context

config>system>oper-group>hold-time

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the number of seconds to wait before notifying clients monitoring this group when its operational status transitions from up to down.

The no form reverts the value to the default.

Default

4

Parameters
time in seconds

Specifies the wait time, in seconds.

Values

0 to 3600

poe
Syntax

poe

Context

config>system

Platforms

7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p

Description

Commands in this context configure power over Ethernet (PoE) power budget information.

max-poe-power-budget
Syntax

max-poe-power-budget value

no max-poe-power-budget

Context

config>system>poe

Platforms

7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p

Description

This command configures the maximum PoE budget that the software uses to allocate PoE power to connected PoE devices (PDs).

When configuring the value parameter, the user must consider the PD power requirements at a site and the available power based on the power supply, operating temperature, and operating altitude. See the 7210 SAS-Dxp 16p/24p Chassis Installation Guide for more information about the formula to calculate the maximum PoE budget based on the operating altitude and temperature range for specific PoE power modules.

The software accounts for power requirements based on the PD type and does not consider the PoE class within a type. The following table lists the power requirements per PD type.

Table 14. PD power requirements

PD

Power requirement

PoE

15 W

PoE+

30 W

PoE++

60 W

HPoE

90 W

For example, if the user configures one PoE port, the software deducts 15 W from the configured max-poe-power-budget. If the user configures two PoE ports and two PoE + ports, the software deducts 90 W from the configured max-poe-power-budget (assuming the configured value is greater than or equal to 90 W). If the user configures a value of 100 W and attempts to configure four PoE+ ports, the software deducts 30 W from the configured max-poe-power-budget for the first three configured PoE+ ports using a total of 90 W (10 W are remaining). When the user configures the fourth port, the configuration fails because only 10 W are available, which does not meet the power requirement for the fourth PoE+ port.

Note:

The following configuration guidelines apply for this command.

  • If power module redundancy is configured, use the lowest common denominator PoE power budget of the two available power modules to determine the available PoE power.

  • If no max-poe-power-budget is configured, no PoE devices can be connected to the node.

  • To modify the module-type, configure no max-poe-power-budget, change the module-type, and configure the correct max-poe-power-budget for the new module-type.

  • The user cannot execute the no max-poe-power-budget command when PoE ports are enabled. Before configuring no max-poe-power-budget, the user must either shut down all PoE ports or remove the PoE configuration on all ports.

The no form of this command allocates 0 W for the PoE power budget.

Default

no max-poe-power-budget

Parameters
value

Specifies the maximum PoE power budget.

Note:

The MIB uses a common maximum value of 720 W for the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p, but the system displays an error message for the 7210 SAS-Dxp 16p when the value exceeds 540 W.

Values

15 W to 540 W, in multiples of 15 W(7210 SAS-Dxp 16p)

15 W to 720 W, in multiples of 15 W (7210 SAS-Dxp 24p)

power-supply
Syntax

power-supply [power-supply-id] type power-module-type module-type

Context

config>system

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, and 7210 SAS-Dxp 24p

Description

This command configures a power supply.

By default, the software does not generate any traps or alarms for PS1 or PS2 when external power supply failure is detected. The user is provided with an option to configure the external backup power supply type on the 7210 SAS-Dxp 12p ETR and external power supply type on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p. The system generates an alarm or trap on a power supply failure only when the user configures the power supply type as ac or dc. The user can disable alarms or traps by setting the type value to none.

On the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p, the power-module-type parameter identifies the specific power supply module in use among the various modules supported on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p.

Note:
  • If the value is none, the software does not send a trap to the management station to clear any pending alarms. Traps are only cleared locally and the LED color is reset if no major or critical alarms are pending. The management station is expected to take appropriate action upon receiving the configuration change event or trap.

  • On the 7210 SAS-Dxp 12p ETR, this command does not affect any traps or alarms generated for the integrated power supply, which continue to be generated on detection of integrated power supply failure when an external power supply is in use.

  • The 7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, and 7210 SAS-Dxp 24p do not have the capability to detect whether the external power supply type is an AC or DC version. Consequently, the user-configured value is not validated by the software. The user is responsible for ensuring that the value is correct and it corresponds to the type of power supply (AC or DC) in use. If an incorrect value is configured, the software continues to display the configured value and generate traps or alarms.

  • This command is only supported on the 7210 SAS-D ETR and 7210 SAS-Dxp 12p ETR. attempts to configure this command on the standard 7210 SAS-D and 7210 SAS-Dxp 12p causes the software to return an error message.

  • On the standard 7210 SAS-Dxp 12p and 7210 SAS-Dxp 12p ETR variant, when a single power supply is used, failure of that power supply brings the node down. On loss of power, the user can configure EFM OAM dying gasp or SNMP IP-based dying gasp to send a power loss notification.

Parameters
power-supply-id

Specifies the power supply ID for which the type is to be applied.

Values

1, 2 (7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p)

2 (7210 SAS-D ETR and 7210 SAS-Dxp 12p ETR)

type

Specifies the type of power supply.

Values

dc, ac, none

module-type

Specifies the power module type. This parameter is supported only on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p.

Values

none, ac-100w, ac-480w, ac-960w, dc-290w

power-supply
Syntax

power-supply [power-supply-id] type

Context

config>system

Platforms

7210 SAS-K 2F1C2T ETR

Description

This command configures the external power-supply type and also provides an option to the user to enable or disable notifications related to power supply. This command is recommended to be used when redundant power supplies are used with the 7210 SAS-K 2F1C2T ETR.

Note:

When a single power supply is used, failure of that power supply brings the node down and user has an option to use EFM OAM dying gasp or SNMP IP based dying gasp for sending out power loss notification.

On the 7210 SAS-K 2F1C2T ETR, by default, the software does not generate any traps or alarms when the external power-supply failure has been detected. The user is provided with an option to configure the external power-supply and its type. Only if the user configures the power-supply type as 'ac' or 'dc' the system generates alarm or trap on a power-supply failure. The user can disable generation of alarms or traps by setting the value to none.

Note:
  • By setting the value to none, the software does not send out a trap to the management station to clear the alarm, if there was one pending. The none value only clears the trap locally and resets the LED color, if there are no other major or critical alarms pending. It is expected that the management station takes appropriate action on receiving the configuration change event or trap.

  • The 7210 SAS-K 2F1C2T ETR does not have the capability to detect whether the external power-supply type is an AC or DC version. Therefore, the user-configured value is not validated by the software. The user is responsible for ensuring whether the value is correct and corresponds to what they are using. If users provide an incorrect value, the software continues to display the configured value and generate traps or alarms on detection of the power supply failure.

  • The power-supply command is only supported on the 7210 SAS-K 2F1C2T ETR. If the power-supply command is used on the 7210 SAS-K 2F1C2T, the software returns an error message.

Parameters
power-supply-id

Specifies the power-supply for which the type is to be applied.

Values

1, 2. Identifies the optional external backup power supply on the 7210 SAS-K 2F1C2T ETR

type

Specifies the type of power-supply.

Values

ac, dc, none

System alarm commands
alarm
Syntax

alarm rmon-alarm-id variable-oid oid-string interval seconds [sample-type] [startup-alarm alarm-type] [rising-event rmon-event-id rising-threshold threshold] [falling-event rmon-event-id falling threshold threshold] [owner owner-string]

no alarm rmon-alarm-id

Context

config>system>thresholds>rmon

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures an entry in the RMON-MIB alarm Table. The alarm command controls the monitoring and triggering of threshold crossing events. In order for notification or logging of a threshold crossing event to occur there must be at least one associated rmon>event configured.

The agent periodically takes statistical sample values from the MIB variable specified for monitoring and compares them to thresholds that have been configured with the alarm command. This command configures the MIB variable to be monitored, the polling period (interval), sampling type (absolute or delta value), and rising and falling threshold parameters. If a sample has crossed a threshold value, the associated event is generated.

The no form of this command removes an rmon-alarm-id from the configuration.

Parameters
rmon-alarm-id

Specifies the rmon-alarm-id as a numerical identifier for the alarm being configured. The number of alarms that can be created is limited to 1200.

Values

1 to 65535

variable-oid oid-string

Specifies the SNMP object identifier of the particular variable to be sampled. Only SNMP variables that resolve to an ASN.1 primitive type of integer (integer, Integer32, Counter32, Counter64, Gauge, or TimeTicks) may be sampled. The oid-string may be expressed using either the dotted string notation or as object name plus dotted instance identifier. For example, ‟1.3.6.1.2.1.2.2.1.10.184582144” or ‟ifInOctets.184582144”.

The oid-string has a maximum length of 255 characters

interval seconds

Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds. In the case of delta type sampling, the interval should be set short enough that the sampled variable is very unlikely to increase or decrease by more than 2147483647 - 1 during a single sampling interval. To avoid creating unnecessary processing overhead, the interval value should not be set too low.

Values

1 to 2147483647

sample-type

Specifies the method of sampling the selected variable and calculating the value to be compared against the thresholds.

Values

absolute — Specifies that the value of the selected variable is compared directly with the thresholds at the end of the sampling interval.

delta — Specifies that the value of the selected variable at the last sample is subtracted from the current value, and the difference compared with the thresholds.

Default

absolute

startup-alarm alarm-type

Specifies the alarm that may be sent when this alarm is first created.

If the first sample is greater than or equal to the rising threshold value and startup-alarm is equal to rising or either, a single rising threshold crossing event is generated.

If the first sample is less than or equal to the falling threshold value and startup-alarm is equal to falling or either, a single falling threshold crossing event is generated.

Values

rising, falling, either

Default

either

rising-event rmon-event-id

Specifies the action to be taken when a rising threshold crossing event occurs.

If there is no corresponding event configured for the specified rmon-event-id, no association exists and no action is taken.

If the rising-event rmon-event-id has a value of zero (0), no associated event exists.

If a rising event rmon-event is configured, the CLI requires a rising-threshold to also be configured.

Values

0 to 65535

Default

0

rising-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval was less than this threshold. A single threshold crossing event is also generated if the first sample taken is greater than or equal to this threshold and the associated startup-alarm is equal to rising or either.

After a rising threshold crossing event is generated, another such event is not generated until the sampled value falls below this threshold and reaches less than or equal the falling-threshold value.

Values

-2147483648 to 2147483647

Default

0

falling-event rmon-event-id

Specifies the action to be taken when a falling threshold crossing event occurs. If there is no corresponding event configured for the specified rmon-event-id, no association exists and no action is taken. If the falling-event has a value of zero (0), no associated event exists.

If a falling event is configured, the CLI requires a falling-threshold to also be configured.

Values

-2147483648 to 2147483647

Default

0

falling-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is less than or equal to this threshold, and the value at the last sampling interval was greater than this threshold. A single threshold crossing event is also generated if the first sample taken is less than or equal to this threshold and the associated startup-alarm is equal to falling or either.

After a rising threshold crossing event is generated, another such event is not generated until the sampled value rises above this threshold and reaches greater than or equal the rising-threshold threshold value.

Values

-2147483648 to 2147483647

Default

0

owner owner

Specifies the creator of this alarm. It defaults to ‟TiMOS CLI”. This parameter is defined primarily to allow entries that have been created in the RMON-MIB alarmTable by remote SNMP managers to be saved and reloaded in a CLI configuration file. The owner is not typically configured by CLI users and can be a maximum of 80 characters.

Default

TiMOS CLI

kb-memory-use-alarm
Syntax

kb-memory-use-alarm rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]

no kb-memory-use-warn

Context

config>system>thresholds

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures memory use, in kilobytes, alarm thresholds.

The no form of this command removes the parameters from the configuration.

Parameters
rising-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval was less than this threshold. A single threshold crossing event is also generated if the first sample taken is greater than or equal to this threshold and the associated startup-alarm is equal to rising or either.

After a rising threshold crossing event is generated, another such event is not generated until the sampled value falls below this threshold and reaches less than or equal the falling-threshold value.

Values

-2147483648 to 2147483647

Default

0

falling-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is less than or equal to this threshold, and the value at the last sampling interval was greater than this threshold. A single threshold crossing event is also generated if the first sample taken is less than or equal to this threshold and the associated startup-alarm is equal to falling or either.

After a falling threshold crossing event is generated, another such event is not generated until the sampled value rises above this threshold and reaches greater than or equal the rising-threshold value.

Values

-2147483648 to 2147483647

Default

0

interval seconds

Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds

Values

1 to 2147483647

rmon-event-type

Specifies the type of notification action to be taken when this event occurs

Values

log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show system thresholds command.

trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, Telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.

both — Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.

none — No action is taken.

Default

both

startup-alarm alarm-type

Specifies the alarm that may be sent when this alarm is first created. If the first sample is greater than or equal to the rising threshold value, and the startup-alarm is equal to rising or either, then a single rising threshold crossing event is generated. If the first sample is less than or equal to the falling threshold value and startup-alarm is equal to falling or either, a single falling threshold crossing event is generated.

Values

rising, falling, either

Default

either

kb-memory-use-warn
Syntax

kb-memory-use-warn rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]

no kb-memory-use-warn

Context

config>system>thresholds

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures memory usage, in kilobytes, for warning thresholds

Parameters
rising-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval was less than this threshold. A single threshold crossing event is also generated if the first sample taken is greater than or equal to this threshold and the associated startup-alarm is equal to rising or either.

After a rising threshold crossing event is generated, another such event is not generated until the sampled value falls below this threshold and reaches less than or equal the falling-threshold value.

Values

-2147483648 to 2147483647

Default

0

falling-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is less than or equal to this threshold, and the value at the last sampling interval was greater than this threshold. A single threshold crossing event is also generated if the first sample taken is less than or equal to this threshold and the associated startup-alarm is equal to falling or either.

After a falling threshold crossing event is generated, another such event is not generated until the sampled value rises above this threshold and reaches greater than or equal the rising-threshold value.

Values

-2147483648 to 2147483647

Default

0

interval seconds

Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds

Values

1 to 2147483647

rmon-event-type

Specifies the type of notification action to be taken when this event occurs

Values

log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show system thresholds command.

trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, Telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.

both — Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.

none — No action is taken.

Default

both

startup-alarm alarm-type

Specifies the alarm that may be sent when this alarm is first created. If the first sample is greater than or equal to the rising threshold value and startup-alarm is equal to rising or either, a single rising threshold crossing event is generated. If the first sample is less than or equal to the falling threshold value and startup-alarm is equal to falling or either, a single falling threshold crossing event is generated.

Values

rising, falling, either

Default

either

cflash-cap-alarm
Syntax

cflash-cap-alarm cflash-id rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type][startup-alarm alarm-type]

no cflash-cap-alarm cflash-id

Context

config>system>thresholds

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command enables capacity monitoring of the compact flash specified in this command. The severity level is alarm. Both a rising and falling threshold can be specified.

The no form of this command removes the configured compact flash threshold alarm.

Parameters
cflash-id

Specifies the name of the cflash device to be monitored.

Values

cf1:, cf2:, uf1:, cf1-A:

rising-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval was less than this threshold. A single threshold crossing event is also generated if the first sample taken is greater than or equal to this threshold and the associated startup-alarm is equal to rising or either.

After a rising threshold crossing event is generated, another such event is not generated until the sampled value falls below this threshold and reaches less than or equal to the falling-threshold value.

Values

-2147483648 to 2147483647

Default

0

falling-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is less than or equal to this threshold, and the value at the last sampling interval was greater than this threshold. A single threshold crossing event is also generated if the first sample taken is less than or equal to this threshold and the associated startup-alarm is equal to falling or either.

After a falling threshold crossing event is generated, another such event is not generated until the sampled value raises above this threshold and reaches greater than or equal the rising-threshold value.

Values

-2147483648 to 2147483647

Default

0

interval seconds

Specifies the polling period, in seconds, over which the data is sampled and compared with the rising and falling thresholds.

Values

1 to 2147483647

rmon-event-type

Specifies the type of notification action to be taken when this event occurs.

Values

log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show system thresholds CLI command.

trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, Telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.

both — Both a entry in the RMON-MIB logTable and a TiMOS logger event are generated.

none — No action is taken.

Default

both

startup-alarm alarm-type

Specifies the alarm that may be sent when this alarm is first created.

If the first sample is greater than or equal to the rising threshold value and startup-alarm is equal to rising or either, then a single rising threshold crossing event is generated.

If the first sample is less than or equal to the falling threshold value and startup-alarm is equal to falling or either, a single falling threshold crossing event is generated.

Values

rising, falling, either

Default

either

cflash-cap-warn
Syntax

cflash-cap-warn cflash-id rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]

no cflash-cap-warn cflash-id

Context

config>system>thresholds

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command enables capacity monitoring of the compact flash specified in this command. The severity level is warning. Both a rising and falling threshold can be specified. The no form of this command removes the configured compact flash threshold warning.

Parameters
cflash-id

Specifies the name of the cflash device to be monitored.

Values

cf1:, cf2:, uf1:, cf1-A:

rising-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval was less than this threshold. A single threshold crossing event is also generated if the first sample taken is greater than or equal to this threshold and the associated startup-alarm is equal to rising or either.

After a rising threshold crossing event is generated, another such event is not generated until the sampled value falls below this threshold and reaches less than or equal the falling-threshold value.

Values

-2147483648 to 2147483647

Default

0

falling-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is less than or equal to this threshold, and the value at the last sampling interval was greater than this threshold. A single threshold crossing event is also generated if the first sample taken is less than or equal to this threshold and the associated startup-alarm is equal to falling or either.

After a falling threshold crossing event is generated, another such event is not generated until the sampled value raises above this threshold and reaches greater than or equal the rising-threshold value.

Values

-2147483648 to 2147483647

Default

0

interval seconds

Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds.

Values

1 to 2147483647

rmon-event-type

Specifies the type of notification action to be taken when this event occurs.

Values

log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show system thresholds CLI command.

trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, Telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.

both — Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.

none — No action is taken.

Default

both

startup-alarm alarm-type

Specifies the alarm that may be sent when this alarm is first created. If the first sample is greater than or equal to the rising threshold value and startup-alarm is equal to rising or either, then a single rising threshold crossing event is generated. If the first sample is less than or equal to the falling threshold value and startup-alarm is equal to falling or either, a single falling threshold crossing event is generated.

Values

rising, falling, either

Default

either

event
Syntax

event rmon-event-id [event-type] [description description-string] [owner owner-string]

no event rmon-event-id

Context

config>system>thresholds>rmon

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures an entry in the RMON-MIB event table. The event command controls the generation and notification of threshold crossing events configured with the alarm command. When a threshold crossing event is triggered, the rmon>event configuration optionally specifies if an entry in the RMON-MIB log table should be created to record the occurrence of the event. It may also specify that an SNMP notification (trap) should be generated for the event. The RMON-MIB defines two notifications for threshold crossing events: Rising Alarm and Falling Alarm.

Creating an event entry in the RMON-MIB log table does not create a corresponding entry in the TiMOS event logs. However, when the event type is set to trap, the generation of a Rising Alarm or Falling Alarm notification creates an entry in the TiMOS event logs and that is distributed to whatever TiMOS log destinations are configured: CONSOLE, session, memory, file, syslog, or SNMP trap destination.

The TiMOS logger message includes a rising or falling threshold crossing event indicator, the sample type (absolute or delta), the sampled value, the threshold value, the RMON-alarm-id, the associated RMON-event-id and the sampled SNMP object identifier.

The no form of this command removes an rmon-event-id from the configuration.

Parameters
rmon-event-type

Specifies the type of notification action to be taken when this event occurs.

Values

log — An entry is made in the RMON-MIB log table for each event occurrence.

This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show system thresholds command.

trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, Telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.

both — Both a entry in the RMON-MIB logTable and a TiMOS logger event are generated.

none — No action is taken.

Default

both

description description-string

Specifies a user configurable string that can be used to identify the purpose of this event. This is an optional parameter and can be up to 80 characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

owner owner

Specifies the creator of this alarm. It defaults to ‟TiMOS CLI”. This parameter is defined primarily to allow entries that have been created in the RMON-MIB alarmTable by remote SNMP managers to be saved and reloaded in a CLI configuration file. The owner is not typically configured by CLI users and can be a maximum of 80 characters.

Default

TiMOS CLI

memory-use-alarm
Syntax

memory-use-alarm rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]

no memory-use-alarm

Context

config>system>thresholds

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

The memory thresholds are based on monitoring the TIMETRA-SYSTEM-MIB sgiMemoryUsed object. This object contains the amount of memory currently used by the system. The severity level is Alarm.

The no form of this command removes the configured memory threshold warning.

Parameters
rising-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval was less than this threshold. A single threshold crossing event is also generated if the first sample taken is greater than or equal to this threshold and the associated startup-alarm is equal to rising or either.

After a rising threshold crossing event is generated, another such event is not generated until the sampled value falls below this threshold and reaches less than or equal the falling-threshold value.

Values

-2147483648 to 2147483647

Default

0

falling-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is less than or equal to this threshold, and the value at the last sampling interval was greater than this threshold. A single threshold crossing event is also generated if the first sample taken is less than or equal to this threshold and the associated startup-alarm is equal to falling or either.

After a falling threshold crossing event is generated, another such event is not generated until the sampled value raises above this threshold and reaches greater than or equal the rising-threshold threshold value.

Values

-2147483648 to 2147483647

Default

0

interval seconds

Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds

Values

1 to 2147483647

rmon-event-type

Specifies the type of notification action to be taken when this event occurs

Values

log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create an OS logger entry. The RMON-MIB log table entries can be viewed using the CLI command.

trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, Telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.

both — Both a entry in the RMON-MIB logTable and a TiMOS logger event are generated.

none — No action is taken.

Default

both

startup-alarm alarm-type

Specifies the alarm that may be sent when this alarm is first created. If the first sample is greater than or equal to the rising threshold value and startup-alarm is equal to rising or either, then a single rising threshold crossing event is generated. If the first sample is less than or equal to the falling threshold value and startup-alarm is equal to falling or either, a single falling threshold crossing event is generated.

Values

rising, falling, either

Default

either

memory-use-warn
Syntax

memory-use-warn rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]

no memory-use-warn

Context

config>system>thresholds

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

The memory thresholds are based on monitoring MemoryUsed object. This object contains the amount of memory currently used by the system. The severity level is Alarm.

The absolute sample type method is used.

The no form of this command removes the configured compact flash threshold warning.

Parameters
rising-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval was less than this threshold. A single threshold crossing event is also generated if the first sample taken is greater than or equal to this threshold and the associated startup-alarm is equal to rising or either. After a rising threshold crossing event is generated, another such event is not generated until the sampled value falls below this threshold and reaches less than or equal the falling-threshold value.

Values

-2147483648 to 2147483647

Default

0

falling-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is less than or equal to this threshold, and the value at the last sampling interval was greater than this threshold. A single threshold crossing event is also generated if the first sample taken is less than or equal to this threshold and the associated startup-alarm is equal to falling or either.

After a falling threshold crossing event is generated, another such event is not generated until the sampled value raises above this threshold and reaches greater than or equal the rising-threshold threshold value.

Values

-2147483648 to 2147483647

Default

0

interval seconds

Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds.

Values

1 to 2147483647

rmon-event-type

Specifies the type of notification action to be taken when this event occurs.

Values

log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show system thresholds command.

trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, Telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.

both — Both a entry in the RMON-MIB logTable and a TiMOS logger event are generated.

none — No action is taken.

Default

both

startup-alarm alarm-type

Specifies the alarm that may be sent when this alarm is first created. If the first sample is greater than or equal to the rising threshold value and startup-alarm is equal to rising or either, then a single rising threshold crossing event is generated. If the first sample is less than or equal to the falling threshold value and startup-alarm is equal to falling or either, a single falling threshold crossing event is generated.

Values

rising, falling, either

Default

either

rmon
Syntax

rmon

Context

config>system>thresholds

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure generic RMON alarms and events.

Generic RMON alarms can be created on any SNMP object-ID that is valid for RMON monitoring (for example, an integer-based datatype).

The configuration of an event controls the generation and notification of threshold crossing events configured with the alarm command.

thresholds
Syntax

thresholds

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure monitoring thresholds.

PTP commands
ptp
Syntax

ptp

Context

config>system

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context configure parameters for IEEE 1588-2008, Precision Time Protocol (PTP).

anno-rx-timeout
Syntax

anno-rx-timeout count

no anno-rx-timeout

Context

config>system>ptp

Platforms

7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the PTP announce receipt timeout count in the Announce message.

The no form of this command reverts the count to the default value.

Default

anno-rx-timeout 3

Parameters
count

Specifies the PTP announce receipt timeout count.

Values

2 to 10

clock
Syntax

clock

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context configure the source of frequency reference for PTP.

freq-source
Syntax

freq-source freq-source

no freq-source

Context

config>system>ptp>clock

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command provides a stable frequency reference obtained through one of the line references (SyncE) for the PTP clock. This is achieved by specifying ssu as the frequency source for PTP. This mode of operation where PTP is used only for time recovery and SyncE is used for frequency recovery is known as PTP hybrid mode.

If set to ssu, PTP runs in hybrid mode (if PTP is also in a no shutdown state), using the recovered frequency provided by the central clock through the configured reference (SyncE). When this parameter is set to ssu, PTP cannot be configured as a reference in the ref-order. The CLI blocks this configuration. The reverse is also true; that is, if PTP is configured under ref-order, this parameter cannot be set to ssu.

If set to ptp, PTP runs in pure mode, potentially being configured as a frequency reference in ref-order.

Note:

If the freq-source value is changed, the system must be rebooted after the configuration changes are saved in order for the new value to take effect.

The no form of this command reverts to the default value.

Default

freq-source ptp

Parameters
freq-source

Specifies if PTP is used for frequency and time recovery or only for time recovery. If ptp is specified, PTP is used for both frequency and time recovery. If ssu is specified, PTP is used only for time recovery.

The ptp option is not supported on the 7210 SAS-Dxp 12p ETR.

Values

ptp, ssu

clock-type
Syntax

clock-type boundary

clock-type ordinary slave

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the type of clock. The clock-type can only be changed when PTP is shut down.

Default

clock-type ordinary slave

Parameters
boundary

Keyword to configure the clock as a boundary clock capable of functioning as both a timeTransmitter and timeReceiver concurrently.

ordinary slave

Keyword to configure the clock as an ordinary PTP timeReceiver. This keyword is not supported on the 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, and 7210 SAS-Dxp 24p.

domain
Syntax

domain domain-value

no domain

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the PTP domain.

Note:
  • Some profiles may require a domain number in a restricted range. It is up to the operator to ensure that the value aligns with what is expected within the profile.

  • Available domain numbers are restricted by the profile that is supported on the specific 7210 SAS platform.

  • The 7210 SAS-Dxp 12p ETR supports only the G.8275.1 profile and corresponding domain numbers.

  • The IEC/IEEE 61850-9-3 and C37.238-2017 profiles and corresponding domain numbers are supported only on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p.

The domain can be changed only if PTP is shut down.

If the PTP profile is changed, the domain is changed to the default domain for the new PTP profile.

The no form of this command reverts to the default configuration.

Default

domain 0 (ieee1588-2008 or iec-61850-9-3-2016)

domain 4 (g8265dot1-2010)

domain 24 (g8275dot1-2014)

domain 254 (c37dot238-2017)

Parameters
domain-value

Specifies the PTP domain.

Values

0 to 255 (ieee1588-2008, g8265dot1-2010, iec-61850-9-3-2016, or c37dot238-2017)

24 to 43 (g8275dot1-2014)

local-priority
Syntax

local-priority priority

local-priority local-priority (under the peer context)

Context

config>system>ptp

config>system>ptp>peer (supported only on 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C)

config>system>ptp>port (supported only on 7210 SAS-Dxp 12p ETR, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C)

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the local priority used to choose between PTP timeTransmitters in the best timeTransmitter clock algorithm (BTCA). This setting is relevant when the profile is set to g8265dot1-2010 or g8275dot1-2014. The parameter is ignored when the profile is set to ieee1588-2008.

The value 1 is the highest priority and 255 is the lowest priority.

For g8265dot1-2010, this command sets the priority to select between timeTransmitter clocks with the same quality.

For g8275dot1-2014, this command sets the value of the local priority associated with the Announce messages received from the external clocks (ptp>peer or ptp>port), or the local clock (PTP).

Note:

The 7210 SAS-Dxp 12p ETR supports only the G8275.1 profile.

Default

local-priority 128

Parameters
priority

Specifies the value of the local priority.

Values

1 to 255

log-anno-interval
Syntax

log-anno-interval log-interval

no log-anno-interval

Context

config>system>ptp

Platforms

7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the PTP Announce interval.

This command applies only when the profile is set to g8275dot1-2014, iec-61850-9-3-2016, or c37dot238-2017.

Note: The IEC/IEEE 61850-9-3 and C37.238-2017 profiles are supported only on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p

The no form of this command reverts to the default value.

Default

log-anno-interval -3 (g8275dot1-2014)

log-anno-interval 0 (iec-61850-9-3-2016 or c37dot238-2017)

Parameters
log-interval

Specifies the PTP Announce interval, in seconds, as the logarithm to the base 2.

Values

–3, where –3 = 0.125 s (g8275dot1-2014)

–3 to 4, where –3 = 0.125 s, –2 = 0.25 s, –1 = 1 s, 1 = 2 s, 2 = 4 s, 3 = 8 s, 4 = 16 s (iec-61850-9-3-2016 or c37dot238-2017)

log-sync-interval
Syntax

log-sync-interval value

no log-sync-interval

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the PTP Sync and PTP Delay-Req message rate that a PTP timeReceiver requests of a PTP timeTransmitter. The value specified is used as the rate for both PTP Sync and Delay-Req messages. The user can set a lower packet rate, typically when using SyncE for frequency and PTP, for time only.

This command applies only if the profile is set to ieee1588-2008 or g8265dot1-2010. It does not apply when g8275dot1-2014 is configured. When the profile is set to g8275dot1-2014, the value is set to –4 (16 packets/s) and cannot be changed.

Note:
  • The 7210 SAS-Dxp 12p ETR supports only the G8275.1 profile.

  • The IEC/IEEE 61850-9-3 and C37.238-2017 profiles are supported only on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p.
  • For the 7210 SAS-D ETR, it is recommended that the packet rate be set to either –4 or –3.

For multicast messages used on PTP Ethernet ports, this command configures the message interval used for synchronization messages transmitted by the local node when the port is in the timeTransmitter state.

The no form of this command reverts to the default value for the profile.

Default

log-sync-interval –6 (64 pps) for ieee1588-2008 or g8265dot1-2010

log-sync-interval –4 (16 pps) for g8275dot1-2014

log-sync-interval 0 (1 pps) for iec-61850-9-3-2016 or c37dot238-2017

Parameters
value

Specifies the rate for both PTP Sync and Delay-Req messages.

Values

–6 to –3, where –6 = 64 packets/s, –5 = 32 packets/s, –4 = 16 packets/s, –3 = 8 packets/s (for the ieee1588-2008 or g8265dot1-2010 profiles)

–4, where –4 = 16 packets/s (for the g8275dot1-2014 profile)

–6 to 0, where –6 = 64 packets/s, –5 = 32 packets/s, –4 = 16 packets/s, –3 = 8 packets/s, –2 = 4 packets/s, –1 = 2 packets/s, 0 = 1 packet/s (for the iec-61850-9-3-2016 or c37dot238-2017 profiles)

network-type
Syntax

network-type {sdh | sonet}

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the codeset used to encode the QL values into PTP clockClass values when the profile is configured for G.8265.1. The codeset is defined in G.8265.1, Table 1.

This setting only applies to the range of values observed in the clockClass values transmitted out of the node in Announce messages. The 7210 SAS supports the reception of any valid value in G.8265.1, Table 1.

Default

nework-type sdh

Parameters
sdh

Specifies the values used on a G.781 Option 1 compliant network.

sonet

Specifies the values used on a G.781 Option 2 compliant network.

peer
Syntax

peer ip-address [create]

no peer ip-address

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context configure parameters associated with remote PTP peers.

Note:

The maximum supported number of PTP peers depends on the supported PTP PPS rate on 7210 SAS platforms. Contact a Nokia representative for more information.

If the clock-type is ordinary slave or boundary, and PTP is not shut down, the last peer cannot be deleted. This prevents the user from having PTP enabled without any peer configured and enabled.

The no form of this command deletes the specified peer.

Parameters
ip-address

Specifies the IPv4 address of the remote peer.

Values

a.b.c.d

create

Keyword to create the peer.

shutdown
Syntax

[no] shutdown

Context

configure>system>ptp>peer

Platforms

7210 SAS-D ETR, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command disables a specific PTP peer. Shutting down a peer sends cancel unicast negotiation messages on any established unicast sessions. When the peer is shut down, all received packets from the peer are ignored.

If the clock-type is ordinary slave or boundary, and PTP is not shut down, the last enabled peer cannot be shut down. This prevents the user from having PTP enabled without any peer configured and enabled.

The no form of this command enables a specific PTP peer.

Default

no shutdown

port
Syntax

port port-id [create]

no port port-id

Context

config>system>ptp

Platforms

7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context configure PTP over Ethernet on the physical port. The PTP process transmits and receives PTP messages through the port using Ethernet encapsulation (as opposed to UDP/IPv4 encapsulation).

The frames are transmitted with no VLAN tags even if the port is configured for dot1q or QinQ modes for encap-type. In addition, the received frames from the external PTP clock must also be untagged.

There are two reserved multicast addresses allocated for PTP messages. See IEEE 1588-2008 Annex F and the address command for more information. Either address can be configured for the PTP messages sent through this port.

This command applies only if the PTP profile is set to g8275dot1-2014, iec-61850-9-3-2016 or c37dot238-2017.

Changing the encapsulation or the port type of the Ethernet port is not permitted when PTP Ethernet multicast operation is configured on the port. To change the encapsulation or port type, the physical port must be shut down.

The no form of this command deletes the specified port.

Parameters
port-id

Specifies a physical port in the format slot/mda/port.

create

Keyword to create a port.

address
Syntax

address {01:1b:19:00:00:00 | 01:80:c2:00:00:0e}

Context

config>system>ptp>port

Platforms

7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the MAC address to be used as the multicast destination address for transmitted PTP messages.

This command applies only if profile is set to g8275dot1-2014, iec-61850-9-3-2016 or c37dot238-2017.

The IEEE 1588-2008 Annex F defines two reserved addresses for PTP messages, as follows:

  • 01-1B-19-00-00-00 — for all messages except peer delay mechanism messages

  • 01-80-C2-00-00-0E — for peer delay mechanism messages

The system accepts PTP messages received using either destination MAC address, regardless of the address configured by this command.

Default

address 01:1b:19:00:00:00

master-only
Syntax

master-only {true | false}

Context

config>system>ptp>port

Platforms

7210 SAS-Dxp 12p ETR, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command prevents the local port from ever entering the timeReceiver state. This can be used to ensure that the 7210 SAS never draws synchronization from the attached external device.

This command applies only if profile is set to g8275dot1-2014.

Parameters
true

Keyword to prevent the local port from entering the timeReceiver state.

false

Keyword to allow the local port to enter the timeReceiver state or timeTransmitter state.

shutdown
Syntax

[no] shutdown

Context

configure>system>ptp>port

Platforms

7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command disables a specific PTP port. When the PTPT port is shut down, all PTP Ethernet messages are dropped on the IOM. They are not counted in the PTP message statistics. No PTP packets are transmitted by the node toward this port.

If the clock-type is ordinary slave or boundary, and PTP is not shut down, the last enabled port cannot be shut down. This prevents the user from having PTP enabled without any means to synchronize the local clock to a parent clock.

This command applies only if profile is set to g8275dot1-2014, iec-61850-9-3-2016, or c37dot238-2017.

The no form of this command enables a specific PTP port.

Default

no shutdown

priority1
Syntax

priority1 priority

no priority1

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the priority1 value of the local clock. This command applies only if the profile is set to ieee-1588-2008, iec-61850-9-3-2016, or c37dot238-2017. This value is used by the BTCA to determine which clock should provide timing for the network. It is also used as the advertised value in Announce messages and as the local clock value in data set comparisons.

The no form of this command reverts to the default value.

Default

priority1 128

Parameters
priority

Specifies the value of the priority1 field.

Values

0 to 255

priority2
Syntax

priority2 priority

no priority2

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the priority2 value of the local clock. This parameter is only used when the profile is set to ieee1588-2008, g8275dot1-2014, iec-61850-9-3-2016, or c37dot238-2017.

This value is used by the BTCA to determine which clock should provide timing for the network. It is also used as the advertised value in Announce messages and as the local clock value in data set comparisons.

The no form of this command reverts to the default value.

Default

priority2 128

Parameters
priority

Specifies the value of the priority2 field.

Values

0 to 255

profile
Syntax

profile {g8265dot1-2010 | ieee1588-2008 | g8275dot1-2014 | iec-61850-9-3-2016 | c37dot238-2017}

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the profile for the internal PTP clock. This profile defines the BTCA behavior.

The profile cannot be changed unless PTP is shut down.

When the profile is changed, the domain is changed to the default value for the new profile. On the 7210 SAS platforms, a profile change requires a node reboot. See Configuration guidelines and restrictions for PTP for more information.

Descriptions for commands in the config>system>ptp context indicate whether the command is applicable based on the configured profile.

Default

profile g8265dot1-2010

Parameters
g8265dot1-2010

Specifies to conform to the ITU-T G.8265.1 specification.

ieee1588-2008

Specifies to conform to the 2008 version of the IEEE 1588 standard.

g8275dot1-2014

Specifies to conform to the ITU-T G.8275.1 specification. This profile is supported only on the 7210 SAS-Dxp 12p ETR, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C.

iec-61850-9-3-2016

Specifies to conform to the IEC/IEEE 61850-9-3 specification. This profile is supported only on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p.

c37dot238-2017

Specifies to conform to the C37.238-2017 specification. This profile is supported only on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p.

Date and time commands
set-time
Syntax

set-time [date] [time]

Context

admin

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures the local system time.

The time entered should be accurate for the time zone configured for the system. The system converts the local time to UTC before saving to the system clock which is always set to UTC. This command does not take into account any daylight saving offset if defined.

Parameters
date

Specifies the local date and time accurate to the minute in the YYYY/MM/DD format.

Values

YYYY is the four-digit year

MM is the two-digit month

DD is the two-digit date

time

Specifies the time (accurate to the second) in the hh:mm[:ss] format. If no seconds value is entered, the seconds are reset to 00.

Values

hh is the two-digit hour in 24 hour format (00=midnight, 12=noon)

mm is the two-digit minute

Default

0

time
Syntax

time

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure the system time zone and time synchronization parameters.

Network Time Protocol Commands
ntp
Syntax

[no] ntp

Context

config>system>time

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure Network Time Protocol (NTP) and its operation. This protocol defines a method to accurately distribute and maintain time for network elements. Furthermore this capability allows for the synchronization of clocks between the various network elements.

The no form of this command stops the execution of NTP and remove its configuration.

authentication-check
Syntax

[no] authentication-check

Context

config>system>time>ntp

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command skips the rejection of NTP PDUs that do not match the authentication key ID, type or key requirements. The default behavior when authentication is configured is to reject all NTP protocol PDUs that have a mismatch in either the authentication key ID, type or key.

When authentication-check is enabled, NTP PDUs are authenticated on receipt. However, mismatches cause a counter to be increased, one counter for type and one for key ID, one for type, value mismatches. These counters are visible in a show command.

The no form of this command allows authentication mismatches to be accepted; the counters however are maintained.

Default

authentication-checks

authentication-key
Syntax

authentication-key key-id {key key} [hash | hash2] type {des | message-digest}

no authentication-key key-id

Context

config>system>time>ntp

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command sets the authentication key ID, type and key used to authenticate NTP PDUs sent to or received by other network elements participating in the NTP protocol. For authentication to work, the authentication key ID, type and key value must match.

The no form of this command removes the authentication key.

Parameters
key-id

Specifies the authentication key ID that is used by the node when transmitting or receiving Network Time Protocol packets.

Entering the authentication-key command with a key ID value that matches an existing configuration key results in overriding the existing entry.

Recipients of the NTP packets must have the same authentication key ID, type, and key value to use the data transmitted by this node.

Values

1 to 255

key key

Specifies the authentication key associated with the configured key ID, the value configured in this parameter is the actual value used by other network elements to authenticate the NTP packet.

The key can be any combination of ASCII characters up to maximum 32 characters for message-digest (MD5) or maximum 8 characters for des (length limits are not encrypted). If spaces are used in the string, enclose the entire string in quotation marks (‟.”).

hash

Specifies that the key is entered in an encrypted form. If the hash or hash2 parameter is not used, the key is assumed to be in a non-encrypted, clear text form. For security, all keys are stored in an encrypted form in the configuration file with the hash or hash2 parameter specified.

hash2

Specifies that the key is entered in a more complex encrypted form that involves more variables than the key value alone; that is, the hash2 encrypted variable cannot be copied and pasted. If the hash or hash2 parameter is not used, the key is assumed to be in a non-encrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.

type

Specifies if DES or message-digest authentication is used.

Values

des — Specifies that DES authentication is used for this key

message-digest — Specifies that MD5 authentication in accordance with RFC 2104 is used for this key

broadcast
Syntax

broadcast [router router-name] {interface ip-int-name} [key-id key-id] [version version] [ttl ttl]

no broadcast [router router-name] {interface ip-int-name}

Context

config>system>time>ntp

Platforms

7210 SAS-D, 7210 SAS-Dxp

Description

This command configures the node to transmit NTP packets on a specific interface. Broadcast and multicast messages can easily be spoofed, therefore, authentication is strongly recommended.

The no form of this command removes the address from the configuration.

Parameters
router-name

Specifies the router name used to transmit NTP packets. Base is the default and the only router name supported currently.

Values

Base

Default

Base

ip-int-name

Specifies the local interface on which to transmit NTP broadcast packets, up to 32 characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

key-id key-id

Specifies the configured authentication key and authentication type used by this node to receive and transmit NTP packets to and from an NTP server and peers. If an NTP packet is received by this node both authentication key and authentication type must be valid otherwise the packet is rejected and an event/trap generated.

Values

1 to 255

version version

Specifies the NTP version number that is generated by this node. This parameter does not need to be configured when in client mode in which case all versions are accepted.

Values

2 to 4

Default

4

ttl ttl

Specifies the IP Time To Live (TTL) value.

Values

1 to 255

broadcastclient
Syntax

broadcastclient [router router-name] {interface ip-int-name} [authenticate]

no broadcastclient [router router-name] {interface ip-int-name}

Context

config>system>time>ntp

Platforms

7210 SAS-D, 7210 SAS-Dxp

Description

When configuring NTP, the node can be configured to receive broadcast packets on a specific subnet. Broadcast and multicast messages can easily be spoofed, therefore, authentication is strongly recommended. If broadcast is not configured then received NTP broadcast traffic is ignored. Use the show command to view the state of the configuration.

The no form of this command removes the address from the configuration.

Parameters
router-name

Specifies the router name used to receive NTP packets.

Values

Base

Default

Base

ip-int-name

Specifies the local interface on which to receive NTP broadcast packets, up to 32 characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

authenticate

Specifies whether to require authentication of NTP PDUs. When enabled, NTP PDUs are authenticated upon receipt.

ntp-server
Syntax

ntp-server [authenticate]

no ntp-server

Context

config>system>time>ntp

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures the node to assume the role of an NTP server. Unless the server command is used, this node functions as an NTP client only and does not distribute the time to downstream network elements.

Default

no ntp-server

Parameters
authenticate

Specifies authentication as a requirement. If authentication is required, the authentication key ID received in a message must have been configured in the authentication-key command, and the key ID type and value must also match.

peer
Syntax

peer ip-address [key-id key-id] [version version] [prefer]

no peer ip-address

Context

config>system>time>ntp

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures symmetric active mode for the configured peer. Although any system can be configured to peer with any other NTP node it is recommended to configure authentication and to configure known time servers as their peers.

The no form of this command removes the configured peer.

Parameters
ip-address

Specifies the IP address of the peer that requires a peering relationship to be set up. This is a required parameter.

key-id key-id

Specifies the configured authentication key and authentication type used by this node to transmit NTP packets to an NTP peer. If an NTP packet is received by this node, the authentication key ID, type, and key value must be valid, otherwise the packet is rejected and an event/trap generated. Successful authentication requires that both peers must have configured the same authentication key ID, type, and key value.

Values

1 to 255

version version

Specifies the NTP version number that is generated by this node. This parameter does not need to be configured when in client mode in which case all three nodes are accepted.

Values

2 to 4

Default

4

prefer

Specifies the preferred peer. One remote system can be configured as the preferred peer when a second peer is configured as preferred, then the new entry overrides the old entry.

server
Syntax

server {ip address | ptp} [key-id key-id] [version version] [prefer]

no server ip address

Context

config>system>time>ntp

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command is used when the node operates in client mode with the ntp server specified in the address field of this command.

Up to five NTP servers can be configured.

If the internal PTP process is to be used as a source of time for System Time and OAM time, it must be specified as a server for NTP. If PTP is specified, the prefer parameter must also be specified. After PTP has established a UTC traceable time from an external grandmaster, it is always the source for time into NTP, even if PTP goes into time holdover.

Note:

Use of the internal PTP time source for NTP promotes the internal NTP server to stratum 1 level. This may impact the NTP network topology.

The no form of this command removes the server with the specified address from the configuration.

Parameters
ip-address

Specifies the IP address of a node that acts as an NTP server to this network element. This is a required parameter.

Values

a.b.c.d

ptp

Keyword to configure the internal PTP process as a time server into the NTP process. The prefer keyword is mandatory with this server option. The ptp keyword is supported only on the 7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C.

key-id key-id

Specifies the configured authentication key and authentication type used by this node to transmit NTP packets to an NTP server. If an NTP packet is received by this node, the authentication key ID, type, and key value must be valid, otherwise the packet is rejected and an event/trap generated. This is an optional parameter.

Values

1 to 255

version version

Specifies the NTP version number that is expected by this node..

Values

2 to 4

Default

4

prefer

Specifies the preferred peer. When configuring more than one peer, one remote system can be configured as the preferred peer. When a second peer is configured as preferred, then the new entry overrides the old entry.

SNTP Commands
sntp
Syntax

[no] sntp

Context

config>system>time

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context edit the Simple Network Time Protocol (SNTP).

SNTP can be configured in either broadcast or unicast client mode. SNTP is a compact, client-only version of the NTP. SNTP can only receive the time from SNTP/NTP servers. It cannot be used to provide time services to other systems.

The system clock is adjusted automatically during system initialization and periodically to ensure that the local time is close to server’s time. However, if the time difference between the SNTP/NTP server and the system clock is more than 2.5 seconds, the software corrects the system time gradually adjusted over an interval.

SNTP is created in an administratively enabled state (no shutdown).

The no form of this command removes the SNTP instance and configuration. SNTP does not need to be administratively disabled when removing the SNTP instance and configuration.

Default

no sntp

broadcast-client
Syntax

[no] broadcast-client

Context

config>system>time>sntp

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command enables listening to SNTP/NTP broadcast messages on interfaces with broadcast client enabled at global device level.

SNTP must be shut down before changing either to or from broadcast mode.

The no form of this command disables broadcast client mode.

Default

no broadcast-client

server-address
Syntax

server-address ip-address [version version-number] [normal | preferred]

[interval seconds]

no server-address

Context

config>system>time>sntp

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command creates an SNTP server for unicast client mode.

Parameters
ip-address

Specifies the IP address of the SNTP server.

version version-number

Specifies the SNTP version supported by this server.

Values

1 to 3

Default

3

normal | preferred

Specifies the preference value for this SNTP server. When more than one time-server is configured, one server can have preference over others. The value for that server should be set to preferred. Only one server in the table can be a preferred server.

Default

normal

interval seconds

Specifies the frequency at which this server is queried.

Values

64 to 1024

Default

64

CRON Commands
cron
Syntax

cron

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context create scripts, script parameters and schedules which support the Service Assurance Agent (SAA) functions.

CRON features are saved to the configuration file on both primary and backup control modules. If a control module switchover occurs, CRON events are restored when the new configuration is loaded. If a control module switchover occurs during the execution of a CRON script, the failover behavior is determined by the contents of the script.

schedule
Syntax

[no] schedule schedule-name [owner schedule-owner]

Context

config>system>cron

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures the type of schedule to run, including one-time only (oneshot), periodic or calendar-based runs. All runs are determined by month, day of month or weekday, hour, minute and interval (seconds).

The no form of this command removes the context from the configuration.

Parameters
schedule-name

Specifies the name of the schedule.

owner schedule-owner

Specifies the owner name of the schedule.

count
Syntax

count number

Context

config>system>cron>sched

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures the total number of times a CRON ‟interval” schedule is run. For example, if the interval is set to 600 and the count is set to 4, the schedule runs 4 times at 600 second intervals.

Parameters
number

Specifies the number of times the schedule is run.

Values

1 to 65535

Default

65535

day-of-month
Syntax

[no] day-of-month {day-number [..day-number] all}

Context

config>system>cron>sched

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures which days of the month that the schedule occurs. Multiple days of the month can be specified. When multiple days are configured, each of them causes the schedule to trigger. If a day-of-month is configured without configuring the month, weekday, hour and minute commands, the event does not execute.

Using the weekday command as well as the day-of-month command causes the script to run twice. For example, consider that ‟today” is Monday January 1. If ‟Tuesday January 5” is configured, the script runs on Tuesday (tomorrow) as well as January 5 (Friday).

See the month, weekday, hour, and minute commands for more information.

The no form of this command removes the specified day-of-month from the list.

Parameters
day-number

Specifies the day of the month counting from the first of the month. The negative integers specify the day of the month counting from the last day of the month. For example, configuring day-of-month -5, 5 in a month that has 31 days configures the schedule to occur on the 27th and 5th of that month.

Integer values must map to a valid day for the month in question. For example, February 30 is not a valid date.

Values

1 to 31, -31 to -1 (maximum 62 day-numbers)

all

Specifies all days of the month.

end-time
Syntax

[no] end-time [date | day-name] time

Context

config>system>cron>sched

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command is used concurrently with type periodic or calendar. Using the type of periodic, end-time determines at which interval the schedule ends. Using the type of calendar, end-time determines on which date the schedule ends.

When no end-time is specified, the schedule runs forever.

Parameters
date

Specifies the date to schedule a command

Values

YYYY:MM:DD in year:month:day number format.

day-name

Specifies the day of the week to schedule a command.

Values

sunday, monday, tuesday, wednesday, thursday, friday, saturday

time

Specifies the time of day to schedule a command.

Values

hh:mm in hour:minute format

hour
Syntax

[no] hour {..hour-number [..hour-number]| all}

Context

config>system>cron>sched

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures which hour to schedule a command. Multiple hours of the day can be specified. When multiple hours are configured, each of them causes the schedule to trigger. Day-of-month or weekday must also be specified. All days of the month or weekdays can be specified. If an hour is configured without configuring the month, weekday, day-of-month, and minute commands, the event does not execute.

See the month, weekday, day-of-month, and minute commands for more information.

The no form of this command removes the specified hour from the configuration.

Parameters
hour-number

Specifies the hour to schedule a command.

Values

0 to 23 (maximum 24 hour-numbers)

all

Specifies all hours.

interval
Syntax

[no] interval seconds

Context

config>system>cron>sched

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures the interval between runs of an event.

Parameters
seconds

Specifies the interval, in seconds, between runs of an event.

Values

30 to 4,294,967,295

minute
Syntax

[no] minute {minute-number [..minute-number]| all}

Context

config>system>cron>sched

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures the minute to schedule a command. Multiple minutes of the hour can be specified. When multiple minutes are configured, each of them causes the schedule to occur. If a minute is configured, but no hour or day is configured, the event does not execute. If a minute is configured without configuring the month, weekday, day-of-month, and hour commands, the event does not execute. See the month, weekday, day-of-month, and hour commands for more information.

The no form of this command removes the specified minute from the configuration.

Parameters
minute-number

Specifies the minute to schedule a command.

Values

0 to 59 (maximum 60 minute-numbers)

all

Specifies all minutes.

month
Syntax

[no] month {month-number [..month-number]|month-name [..month-name]| all}

Context

config>system>cron>sched

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures the month when the event should be executed. Multiple months can be specified. When multiple months are configured, each of them causes the schedule to trigger. If a month is configured

If a minute is configured without configuring the weekday, day-of-month, hour, and minute commands, the event does not execute.

See the weekday, day-of-month, hour, and minute commands for more information.

The no form of this command removes the specified month from the configuration.

Parameters
month-number

Specifies a month number.

Values

1 to 12 (maximum 12 month-numbers)

all

Specifies all months.

month-name

Specifies a month by name.

Values

january, february, march, april, may, june, july, august, september, october, november, december (maximum 12 month names)

type
Syntax

type {schedule-type}

Context

config>system>cron>sched

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command specifies how the system should interpret the commands contained within the schedule node.

Parameters
schedule-type

Specifies the type of schedule for the system to interpret the commands contained within the schedule node.

Values

periodic — Specifies a schedule that runs at a specified interval. The interval command must be specified for this feature to run successfully.

calendar — Specifies a schedule that runs based on a calendar. The month, weekday, day-of-month, hour, and minute commands must be specified for this feature to run successfully.

oneshot — Specifies a schedule that runs one time only. As soon as the first event specified in these parameters takes place and the associated event occurs, the schedule enters a shutdown state. The month, weekday, day-of-month, hour, and minute must be specified for this feature to run successfully.

See interval, month, weekday, day-of-month, hour and minute for more information.

Default

periodic

weekday
Syntax

[no] weekday {weekday-number [..weekday-number]|day-name [..day-name]| all}

Context

config>system>cron>sched

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures the days of the week on which the schedule runs. Multiple days of the week can be specified. When multiple days are configured, each of them causes the schedule to occur. If a weekday is configured without configuring the month, day-of-month, hour, and minute, the event does not run.

Using the weekday command as well as the day-of-month command causes the script to run twice. For example, consider that ‟today” is Monday January 1. If ‟Tuesday January 5” is configured, the script runs on Tuesday (tomorrow) as well as January 5 (Friday).

See the month, day-of-month, hour, and minute commands for more information.

The no form of this command removes the specified weekday from the configuration.

Parameters
day-number

Specifies a weekday number.

Values

1 to 7 (maximum 7 week-day-numbers)

day-name

Specifies a day by name.

Values

sunday, monday, tuesday, wednesday, thursday, friday, saturday (maximum 7 weekday names)

all

Specifies all days of the week.

Time Range Commands
time-range
Syntax

[no] time-range name [create]

Context

config>system>cron

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures a time range.

The no form of this command removes the name from the configuration.

Parameters
name

Specifies a name for the time range, up to 32 characters.

absolute
Syntax

absolute start start-absolute-time end end-absolute-time

no absolute start absolute-time

Context

config>system>cron>time-range

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures an absolute time interval that does not repeat.

The no form of this command removes the absolute time range from the configuration.

Parameters
start absolute-time

Specifies starting parameters for the absolute time-range.

Values

absolute-timeyear/month/day,hh:mm

year — 2005 to 2099

month — 1 to 12

day — 1 to 31

hh — 0 to 23

mm — 0 to 59

end absolute-time

Specifies end parameters for the absolute time-range.

Values

absolute-timeyear/month/day,hh:mm

year — 2005 to 2099

month — 1 to 12

day — 1 to 31

hh — 0 to 23

mm — 0 to 59

daily
Syntax

daily start start-time-of-day end end-time-of-day

no daily start start-time-of-day

Context

config>system>cron>time-range

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures the start and end of a schedule for every day of the week. To configure a daily time-range across midnight, use a combination of two entries. An entry that starts at hour zero takes over from an entry that ends at hour 24.

The no form of this command removes the daily time parameters from the configuration.

Parameters
start-time-of-day

Specifies the starting time for the time range.

Values

start-time-of-day hh:mm

hh — 0 to 23

mm — 0 to 59

end-time-of-day

Specifies the ending time for the time range.

Values

end-time-of-day hh:mm

hh — 0 to 23

mm — 0 to 59

weekdays
Syntax

weekdays start start-time-of-day end end-time-of-day

no weekdays start start-time-of-day

Context

config>system>cron>time-range

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures the start and end of a weekday schedule.

The no form of this command removes the weekday parameters from the configuration.

Parameters
start-time-of-day

Specifies the starting time for the time range.

Values

start-time-of-day hh:mm

hh — 0 to 23

mm — 0 to 59

end-time-of-day

Specifies the ending time for the time range.

Values

end-time-of-day hh:mm

hh — 0 to 23

mm — 0 to 59

weekend
Syntax

weekend start start-time-of-day end end-time-of-day

no weekend start start-time-of-day

Context

config>system>cron>time-range

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures a time interval for every weekend day in the time range.

The resolution must be at least one minute apart, for example, start at 11:00 and end at 11:01. An 11:00 start and end time is invalid. This example configures a start at 11:00 and an end at 11:01 on both Saturday and Sunday.

The no form of this command removes the weekend parameters from the configuration.

Parameters
start-time-of-day

Specifies the starting time for the time range.

Values

start-time-of-day hh:mm

hh — 0 to 23

mm — 0 to 59

end-time-of-day

Specifies the ending time for the time range.

Values

end-time-of-day hh:mm

hh — 0 to 23

mm — 0 to 59

weekly
Syntax

weekly start start-time-in-week end end-time-in-week

no weekly start start-time-in-week

Context

config>system>cron>time-range

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures a weekly periodic interval in the time range.

The command configures the start and end of a schedule for the same day every week, for example, every Friday. The start and end dates must be the same. The resolution must be at least one minute apart, for example, start at 11:00 and end at 11:01. A start time and end time of 11:00 is invalid.

The no form of this command removes the weekly parameters from the configuration.

Default

no time-range

Parameters
start-time-in-week

Specifies the start day and time of the week.

Values

start-time-in-weekday,hh:mm

day — sun, mon, tue, wed, thu, fri, sat

sunday, monday, tuesday, wednesday, thursday, friday, saturday

hh — 0 to 23

mm — 0 to 59

end-time-in-week

Specifies the end day and time of the week.

Values

end-time-in-weekday,hh:mm

day — sun, mon, tue, wed, thu, fri, sat

sunday, monday, tuesday, wednesday, thursday, friday, saturday

hh — 0 to 23

mm — 0 to 59

Time of Day Commands
tod-suite
Syntax

[no] tod-suite tod-suite name create

Context

config>system>cron

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context modify time of day (TOD) parameters.

Default

no tod-suite

egress
Syntax

egress

Context

config>system>cron>tod-suite

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command enables the TOD suite egress parameters.

ingress
Syntax

ingress

Context

config>system>cron>tod-suite

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command enables the TOD suite ingress parameters.

filter
Syntax

filter ip ip-filter-id [time-range time-range-name] [priority priority]

filter mac mac-filter-id [time-range time-range-name] [priority priority]

filter ipv6 ipv6-filter-id [time-range time-range-name] [priority priority]

no ip ip-filter-id [time-range time-range-name]

no ipv6 ipv6-filter-id [time-range time-range-name]

no filter mac mac-filter-id [time-range time-range-name]

Context

config>system>cron>tod-suite>egress

config>system>cron>tod-suite>ingress

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command creates time-range based associations of previously created filter policies. Multiple policies may be included and each must be assigned a different priority; in case time-ranges overlap, the priority is used to determine the prevailing policy. Only a single reference to a policy may be included without a time-range.

Parameters
ip-filter ip-filter-id

Specifies an IP filter for this tod-suite.

Values

1 to 65535

ipv6-filter ip-filter-id

Specifies an IPv6 filter for this tod-suite.

Values

1 to 65535

time-range time-range-name

Specifies a name for the time-range, up to 32 characters. If the time-range is not populated, the system assumes the assignment to mean ‟all times”. Only one entry without a time-range is allowed for every type of policy. The system does not allow the user to specify more than one policy with the same time-range and priority.

priority priority

Specifies the priority of the time-range. Only one time-range assignment of the same type and priority is allowed.

Values

1 to 10

mac mac-filter-id

Specifies a MAC filter for this tod-suite.

Values

1 to 65535

qos
Syntax

qos policy-id [time-range time-range-name] [priority priority]

no qos policy-id [time-range time-range-name] [

Context

config>system>cron>tod-suite>ingress

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command creates time-range based associations of previously created QoS policies. Multiple policies may be included and each must be assigned a different priority; in case time-ranges overlap, the priority is used to determine the prevailing policy. Only a single reference to a policy may be included without a time-range.

The no form of this command reverts to the default.

Parameters
policy-id

Specifies an egress QoS policy for this tod-suite.

Values

1 to 65535

time-range time-range-name

Specifies a name for the time-range, up to 32 characters. If the time-range is not populated, the system assumes the assignment to mean ‟all times”. Only one entry without a time-range is allowed for every type of policy. The system does not allow the user to specify more than one policy with the same time-range and priority.

Default

‟NO-TIME-RANGE” policy

priority priority

Specifies the priority of the time-range. Only one time-range assignment of the same type and priority is allowed.

Values

1 to 10

Default

5

Script Control Commands
script-control
Syntax

script-control

Context

config>system

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context configure command script parameters.

script-policy
Syntax

[no] script-policy policy-name [owner policy-owner]

Context

config>system>script-control

config>system>cron>schedule

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command is used to configure the CLI script policy.

Parameters
policy-name

Specifies the name of the policy. Can be up to 32 characters.

owner policy-owner

Specifies the name of the policy owner, up to 32 characters. The owner is an arbitrary name and not necessarily a username. Commands in the scripts are not authorized against the owner. The configure system security cli-script authorization x cli-user command determines the user context against which commands in the scripts are authorized.

Default

‟TiMOS CLI”

expire-time
Syntax

expire-time {seconds | forever}

Context

config>system>script-control>script-policy

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the maximum amount of time to keep the run history status entry from a script run.

Default

expire-time 3600

Parameters
seconds

Specifies the time to keep the run history status entry, in seconds.

Values

0 to 21474836

forever

Specifies to keep the run history status entry indefinitely.

lifetime
Syntax

lifetime {seconds | forever}

Context

config>system>script-control>script-policy

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the maximum amount of time that a script may run.

Default

lifetime 3600

Parameters
seconds

Specifies the maximum amount of time that a script may run, in seconds.

Values

0 to 21474836

forever

Specifies to allow a script to run indefinitely.

max-completed
Syntax

max-completed unsigned

Context

config>system>script-control>script-policy

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the maximum number of script run history status entries to keep.

Default

max-completed 1

Parameters
unsigned

Specifies the maximum number of script run history status entries to keep.

Values

1 to 1500

Default

1

results
Syntax

results file-url

no results

Context

config>system>script-control>script-policy

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the location where the system writes the output of an event script’s execution.

The no form of this command removes the file location from the configuration. Scripts do not execute if there is no result location defined.

Default

no results

Parameters
file-url

Specifies the location to send CLI output from script runs. The file-url is a location, directory, and filename prefix to which a data and timestamp suffix is added when the results files are created during a script run, as follows: file-url_YYYYMMDD-hhmmss.uuuuuu.out where:

YYYYMMDD — date hhmmss — hours, minutes, and seconds uuuuuu — microseconds (padded to 6 characters with leading zeros)

Values

file-url — local-url | remote-url

local-url — [cflash-id/] [file-path]

200 chars maximum, including cflash-id

directory length 99 characters maximum each

remote url — [{ftp:// | tftp://}login:password@remote-location/][file-path] 255 characters maximum directory length 99 characters maximum each

remote-location — [hostname | ipv4-address | ipv6-address]

ipv4-addressa.b.c.d

ipv6-address — x:x:x:x:x:x:x:x[-interface]

  • x:x:x:x:x:x:d.d.d.d[-interface]
  • x — 0 to FFFF (hexadecimal)
  • d — 0 to 255 (decimal)

interface — 32 characters maximum, for link local addresses

cflash-id — cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

script
Syntax

script script-name [owner script-owner]

no script

Context

config>system>script-control>script-policy

config>system>script-control

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures a script to be run.

The no form of this command removes the script.

Default

no script

Parameters
script-name

Specifies the name of the script, up to 32 characters.

script-owner

Specifies the name of the script owner, up to 32 characters.

The owner is an arbitrary name and not necessarily a username. Commands in the scripts are not authorized against the owner. The configure system security cli-script authorization x cli-user command determines the user context against which commands in the scripts are authorized.

Default

‟TiMOS CLI”

location
Syntax

location file-url

no location

Context

config>system>script-control>script

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command identifies the location of a script to be scheduled.

The no form of this command removes the location.

Default

no location

Parameters
file-url

Specifies the location to search for scripts.

Values

file-url — local-url | remote-url

local-url — [cflash-id/] [file-path]

200 chars maximum, including cflash-id

directory length 99 characters maximum each

remote url — [{ftp:// | tftp://}login:password@remote-location/][file-path] 255 characters maximum directory length 99 characters maximum each

remote-location — [hostname | ipv4-address | ipv6-address]

ipv4-addressa.b.c.d

ipv6-address — x:x:x:x:x:x:x:x[-interface]

  • x:x:x:x:x:x:d.d.d.d[-interface]
  • x — 0 to FFFF (hexadecimal)
  • d — 0 to 255 (decimal)

interface — 32 characters maximum, for link local addresses

cflash-id — cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

System Time Commands
dst-zone
Syntax

[no] dst-zone [std-zone-name | non-std-zone-name]

Context

config>system>time

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures the start and end dates and offset for summer time or daylight savings time to override system defaults or for user defined time zones.

When configured, the time is adjusted by adding the configured offset when summer time starts and subtracting the configured offset when summer time ends.

If the time zone configured is listed in System-defined time zones , then the starting and ending parameters and offset do not need to be configured with this command unless it is necessary to override the system defaults. The command returns an error if the start and ending dates and times are not available either in System-defined time zones on or entered as optional parameters in this command.

Up to five summer time zones may be configured, for example, for five successive years or for five different time zones. Configuring a sixth entry returns an error message. If no summer (daylight savings) time is supplied, it is assumed no summer time adjustment is required.

The no form of this command removes a configured summer (daylight savings) time entry.

Parameters
std-zone-name

Specifies the standard time zone name. The standard name must be a system-defined zone in System-defined time zones . For zone names in the table that have an implicit summer time setting, for example MDT for Mountain Daylight Saving Time, the remaining start-date, end-date and offset parameters need to be provided unless it is necessary to override the system defaults for the time zone.

Values

std-zone-name ADT, AKDT, CDT, CEST, EDT, EEST, MDT, PDT, WEST, NDT, NZDT

non-std-zone-name

Specifies the non-standard time zone name, up to 5 characters. See the zone command for more information about creating a user-defined name.

end
Syntax

end {end-week} {end-day} {end-month} [hours-minutes]

Context

config>system>time>dst-zone

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures start of summer time settings.

Parameters
end-week

Specifies the starting week of the month when the summer time ends.

Values

first, second, third, fourth, last

Default

first

end-day

Specifies the starting day of the week when the summer time ends.

Values

sunday, monday, tuesday, wednesday, thursday, friday, saturday

Default

sunday

end-month

Specifies the starting month of the year when the summer time takes effect.

Values

january, february, march, april, may, june, july, august, september, october, november, december

Default

january

hours

Specifies the hour at which the summer time ends.

Values

0 to 24

Default

0

minutes

Specifies the number of minutes, after the hours defined by the hours parameter, when the summer time ends.

Values

0 to 59

Default

0

offset
Syntax

offset offset

Context

config>system>time>dst-zone

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command specifies the number of minutes that are added to the time when summer time takes effect. The same number of minutes are subtracted from the time when the summer time ends.

Parameters
offset

Specifies the number of minutes added to the time at the beginning of summer time and subtracted at the end of summer time, expressed as an integer.

Values

0 to 60

Default

60

start
Syntax

start {start-week} {start-day} {start-month} [hours-minutes]

Context

config>system>time>dst-zone

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures start of summer time settings.

Parameters
start-week

Specifies the starting week of the month when the summer time takes effect.

Values

first, second, third, fourth, last

Default

first

start-day

Specifies the starting day of the week when the summer time takes effect.

Values

sunday, monday, tuesday, wednesday, thursday, friday, saturday

Default

sunday

start-month

Specifies the starting month of the year when the summer time takes effect.

Values

january, february, march, april, may, june, july, august, september, october, november, december

Default

january

hours

Specifies the hour at which the summer time takes effect.

Values

0 to 23

Default

0

minutes

Specifies the number of minutes, after the hours defined by the hours parameter, when the summer time takes effect.

Values

0 to 59

Default

0

zone
Syntax

zone [std-zone-name | non-std-zone-name] [hh [:mm]]

no zone

Context

config>system>time

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command sets the time zone and time zone offset for the device.

The 7210 SAS supports system-defined and user-defined time zones. The system-defined time zones are listed in System-defined time zones .

For user-defined time zones, the zone and the UTC offset must be specified.

The no form of this command reverts to the default of Coordinated Universal Time (UTC). If the time zone in use was a user-defined time zone, the time zone is deleted. If a dst-zone command has been configured that references the zone, the summer commands must be deleted before the zone can be reset to UTC.

Default

zone utc

Parameters
std-zone-name

Specifies the standard time zone name. The standard name must be a system-defined zone in System-defined time zones . For zone names in the table that have an implicit summer time setting, for example MDT for Mountain Daylight Saving Time, the remaining start-date, end-date and offset parameters need to be provided unless it is necessary to override the system defaults for the time zone.

For system-defined time zones, a different offset cannot be specified. If a new time zone is needed with a different offset, the user must create a new time zone. Note that some system-defined time zones have implicit summer time settings which causes the switchover to summer time to occur automatically; configuring the dst-zone parameter is not required.

Values

GMT, BST, IST, WET, WEST, CET, CEST, EET, EEST, MSK, MSD, AST, ADT, EST, EDT, ET, CST, CDT, CT, MST, MDT, MT, PST, PDT, PT, HST, AKST, AKDT, WAST, CAST, EAST

non-std-zone-name

Specifies the non-standard time zone name, up to 5 characters.

hh [:mm]

Specifies the hours and minutes offset from UTC time, expressed as integers. Some time zones do not have an offset that is an integral number of hours. In these instances, the minutes-offset must be specified. For example, the time zone in Pirlanngimpi, Australia is UTC + 9.5 hours.

Values

hh — –11 to 12

mm — 0 to 59

Default

hh — 0

mm — 0

System synchronization commands
sync-if-timing
Syntax

sync-if-timing

Context

config>system

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context create or modify timing reference parameters. The ref-order must be specified in order for this command to be enabled.

Default

disabled

abort
Syntax

abort

Context

config>system>sync-if-timing

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command discards changes that have been made to the synchronous interface timing configuration during a session.

begin
Syntax

begin

Context

config>system>sync-if-timing

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command creates or edits the system synchronous interface timing configuration.

commit
Syntax

commit

Context

config>system>sync-if-timing

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command saves changes made to the system synchronous interface timing configuration.

ptp
Syntax

[no] ptp

Context

config>system>sync-if-timing

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context configure parameters for system timing via IEEE 1588-2008, Precision Time Protocol (PTP). PTP is not supported on 7210 SAS-Dxp.

ql-override
Syntax

ql-override {prs | stu | st2 | tnc | st3e | st3 | sec | prc | ssu-a | ssu-b}

no ql-override

Context

config>system>sync-if-timing>ptp

config>system>sync-if-timing>ref1

config>system>sync-if-timing>ref2

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the reference selection based on the quality level (QL) value. This value overrides any value received by that reference's SSM process.

Default

no ql-override

Parameters
prs

Specifies SONET Primary Reference Source Traceable.

stu

Specifies SONET Synchronous Traceability Unknown.

st2

Specifies SONET Stratum 2 Traceable.

tnc

Specifies SONET Transit Node Clock Traceable.

st3e

Specifies SONET Stratum 3E Traceable.

st3

Specifies SONET Stratum 3 Traceable.

prc

Specifies SDH Primary Reference Clock Traceable.

ssu-a

Specifies SDH Primary Level Synchronization Supply Unit Traceable.

ssu-b

Specifies SDH Second Level Synchronization Supply Unit Traceable.

sec

Specifies SDH Synchronous Equipment Clock Traceable.

ql-selection
Syntax

[no] ql-selection

Context

config>system>sync-if-timing

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command enables the selection of the system timing reference to take into account the quality level. This command turns SSM encoding on or off as a means of timing reference selection.

Default

no ql-selection

ref-order
Syntax

ref-order first second third

ref-order ptp

no ref-order

Context

config>system>sync-if-timing

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

The synchronous equipment timing subsystem can lock to different timing reference inputs, those specified in the ref1, ref2, and ptp command configuration. This command organizes the priority order of the timing references.

If a reference source is disabled, then the clock from the next reference source as defined by ref-order is used. If all reference sources are disabled, then clocking is derived from a local oscillator.

If a sync-if-timing reference is linked to a source port that is operationally down, the port is no longer qualified as a valid reference. Depending on the platform used, either SFP or Fixed copper ports can be used as a reference.

The no form of this command reverts the reference order to the default values.

Note:

On the 7210 SAS-D ETR, ref1 must be configured to use one of ports 1/1/1 to 1/1/4 and ref2 must be configured to use either port 1/1/5 or 1/1/6. The software enforces this check. Ports 1/1/7 to 1/1/10 can be configured as either ref1 or ref2.

Default

ref1 ref2 ptp

Parameters
first

Specifies the first timing reference to use in the reference order sequence.

second

Specifies the second timing reference to use in the reference order sequence.

third

Specifies the third timing reference to use in the reference order sequence. This parameter is only supported on 7210 SAS-K devices.

ptp

Specifies that PTP must be used as a timing reference. PTP is not supported on 7210 SAS-Dxp.

ref1
Syntax

ref1

Context

config>system>sync-if-timing

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context configure parameters for the first timing reference.

ref2
Syntax

ref2

Context

config>system>sync-if-timing

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context configure parameters for the second timing reference.

revert
Syntax

[no] revert

Context

config>system>sync-if-timing

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command enables the clock to revert to a higher priority reference if the current reference goes offline or becomes unstable.

If revertive switching is enabled, the highest-priority valid timing reference is used. If a reference with a higher priority becomes valid, a reference switch over to that reference is initiated. If a failure on the current reference occurs, the next highest reference takes over.

If non-revertive switching is enabled, the valid active reference always remains selected, even if a higher-priority reference becomes available. If this reference becomes invalid, a reference switch over to a valid reference with the highest priority is initiated. When the failed reference becomes operational, it is eligible for selection.

Default

no revert

source-port
Syntax

source-port port-id

no source-port

Context

config>system>sync-if-timing>ref1

config>system>sync-if-timing>ref2

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the source port for timing reference ref1 or ref2. If the port is unavailable or the link is down, then the reference sources are re-evaluated according to the reference order configured in the ref-order command.

The no form of this command deletes the source port from the reference.

Parameters
port-id

Specifies the physical port.

Values

slot/mda/port

System port LAG MAC assignment commands for 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C
port-lag-mac-assignment
Syntax

port-lag-mac-assignment [v1-enable]

no port-lag-mac-assignment

Context

config>system

Platforms

7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command enables new MAC address assignments to avoid an overlap between port MAC addresses and LAG MAC addresses.

In the current default assignments of MAC addresses to ports and LAGs, the MAC addresses that are allocated to the LAGs overlap with the MAC addresses of the physical ports; for example, the MAC address assigned by the system to LAG 1 is the same as the MAC address of port 27.

Use this command to change the MAC address assignment scheme to ensure that the LAG MAC addresses are not the same as the MAC addresses of the physical ports. The new scheme is referred to in the system as ‟v1.”

A reboot is required for this command to take effect.

WARNING:

The MAC address for some ports will change after this command is run. Ensure required changes are made to other service objects (for example, CFM up MEPs, and so on) that reference local MAC addresses, and to MAC addresses that reference remote peer devices, if required. Failure to make such changes could result in unpredictable behavior.

The no form of this command reverts to the default MAC address assignment scheme for ports and LAGs. The use of the default configuration is not recommended; it is available only to maintain the current mode of operation, if absolutely necessary.

Parameters
v1-enable

Mandatory keyword that forces the system to use the new scheme of MAC address assignment.

System administration commands
admin
Syntax

admin

Context

<root>

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure administrative system parameters. Only authorized users can execute the commands in the admin context.

check-golden-bootstrap
Syntax

check-golden-bootstrap

Context

admin

Platforms

7210 SAS-D

Description

This command validates the current golden bootstrap image, and displays its version, if found to be valid. If the golden bootstrap image is not found to be a valid, an error message is displayed to that effect.

auto-init
Syntax

auto-init stop

Context

admin

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command can potentially use the TiMOS images available on the local flash to boot up and provide a user login prompt when the system boots up for the first-time. With this command, the user is provided with an option to stop the auto-init process and complete successful boot. After executing this command, the system saves the BOF with the BOF parameter primary-image pointing to the both.tim on the local flash.

If the user does not use this command to stop the auto-init process, the system reboots and attempts to find the BOF again using DHCP.

debug-save
Syntax

debug-save file-url

Context

admin

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command saves existing debug configuration. Debug configurations are not preserved in configuration saves.

Parameters
file-url

Specifies the file URL location to save the debug configuration.

Values

file-url — local-url | remote-url

local-url — [cflash-id/ | usb-flash-id][file-path],

200 chars maximum, including the cflash-id directory length, 99 chars maximum each

remote-url — [{ftp://} login:pswd@remote-locn][file-path]

remote-locn — [hostname | ipv4-address]

ipv4-addressa.b.c.d

cflash-id — cf1:

usb-flash-id — uf1:

disconnect
Syntax

disconnect {address ip-address | username user-name | console | telnet | ftp | ssh | netconf}

Context

admin

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command disconnects a user from a console, Telnet, FTP, SSH, or NETCONF session.

If any of the console, Telnet, FTP, SSH, or NETCONF options are specified, only the respective console, Telnet, FTP, SSH, or NETCONF sessions are affected.

If no console, Telnet, FTP, SSH, or NETCONF options are specified, all sessions from the IP address or from the specified user are disconnected.

Any task that the user is executing is terminated. FTP files accessed by the user are not removed.

A major severity security log event is created specifying what was terminated and by whom.

Parameters
address ip-address

Specifies the IP address to disconnect.

Values

ipv4-address — a.b.c.d

ipv6-address — x:x:x:x:x:x:x:x (eight 16-bit pieces)

  • x:x:x:x:x:x:d.d.d.d
  • x — 0 to FFFF (hexadecimal)
  • d — 0 to 255 (decimal)
username user-name

Specifies the name of the user.

console

Keyword to disconnect the console session.

telnet

Keyword to disconnect the Telnet session.

ftp

Keyword to disconnect the FTP session.

ssh

Keyword to disconnect the SSH session.

netconf

Keyword to disconnect the NETCONF session. This keyword is supported only on the 7210 SAS-K 2F1C2T and 7210 SAS-K 2F6C4T.

display-config
Syntax

display-config [detail | index]

Context

admin

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command displays the system’s running configuration.

By default, only non-default settings are displayed.

Parameters
detail

Displays default and non-default configuration parameters.

index

Displays only persistent-indices.

reboot
Syntax

reboot [upgrade] [auto-init] [now]

Context

admin

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command reboots the system or initiates an upgrade of the firmware along with a reboot of the node or initiate an auto-init boot procedure along with a reboot of the node.

If no options are specified, the user is prompted to confirm the reboot operation.

If the now option is specified, boot confirmation messages appear.

Parameters
upgrade

Keyword to enable card firmware (CPLD and ROM) to be upgraded during chassis reboot. The 7210 SAS OS and the boot.tim support functionality to perform automatic firmware upgrades. The automatic upgrade must be enabled in the 7210 SAS OS Command Line Interface (CLI) when rebooting the system.

When the upgrade keyword is specified, a chassis flag is set for the BOOT Loader (boot.tim) and on the subsequent boot of the 7210 SAS OS on the chassis, any firmware images requiring upgrading is upgraded automatically.

If an 7210 SAS is rebooted with the admin reboot command (without the upgrade keyword), the firmware images are left intact.

During any firmware upgrade, automatic or manual, it is imperative that during the upgrade procedure:

  • Power must NOT be switched off or interrupted.

  • The system must NOT be reset.

  • No cards are inserted or removed.

Any of the above conditions may render cards inoperable requiring a return of the card for resolution.

now

Keyword to forces a reboot of the router immediately without an interactive confirmation.

auto-init

Keyword to reset the BOF and initiate a reboot.

save
Syntax

save [file-url] [detail] [index]

Context

admin

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command saves the running configuration to a configuration file.

By default, the running configuration is saved to the primary configuration file.

Parameters
file-url

Specifies the file URL location to save the configuration file.

Values

file-urllocal-url | remote-url (255 characters max)

local-url — [cflash-id/ | usb-flash-id][file-path],

200 chars maximum, including the cflash-id directory

length, 99 chars maximum each

remote-url — [{ftp://|tftp://}login:pswd@ remote-locn] [file-path]

remote-locn — [hostname | ipv4-address]

ipv4-addressa.b.c.d

ipv6-address — x:x:x:x:x:x:x:x [-interface]

  • x:x:x:x:x:x:d.d.d.d [-interface]
  • x — 0 to FFFF (hexadecimal)
  • d — 0 to 255 (decimal)

interface — a string up to 32 characters, for link local addresses

cflash-id — cf1:

usb-flash-id — uf1:

Default

the primary configuration file location

detail

Keyword to save both default and non-default configuration parameters.

index

Keyword to save of the persistent index file regardless of the persistent status in the BOF file. The index option can also be used to avoid an additional boot required while changing your system to use the persistence indices.

enable-tech
Syntax

[no] enable-tech

Context

admin

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command enables the shell and kernel commands.

Note:

This command should only be used with authorized direction from the Nokia Technical Assistance Center (TAC).

tech-support
Syntax

tech-support file-url

Context

admin

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command creates a system core dump.

Note:

This command should only be used with authorized direction from the Nokia Technical Assistance Center (TAC).

Parameters
file-url

Specifies the file URL location to save the binary file.

Values

file-url — local-url | remote-url

local- url — [cflash-id/ | usb-flash-id][file-path],

200 chars maximum, including the cflash-id directory

length, 99 chars maximum each

remote-url — [{ftp://} login:pswd@remote-locn][file-path]

remote-locn — [hostname | ipv4-address]

ipv4-addressa.b.c.d

cflash-id — cf1:

usb-flash-id — uf1:

update-golden-bootstrap
Syntax

update-golden-bootstrap [file-url]

Context

admin

Platforms

7210 SAS-D

Description

This command updates the golden bootstrap image with the file-url, after validating it as a bootstrap image for the 7210 SAS platforms. Only on newer 7210 SAS-D platforms, the admin>update-golden-bootstrap CLI command does not update the golden-bootstrap image with the boot.tim specified in the parameter value, if the boot.tim is not a newer image.

Default

cf1:/boot.tim

Parameters
file-url

Specifies the file URL.

System alarm contact commands
alarm-contact-input
Syntax

alarm-contact-input alarm-contact-input-id

Context

config>system>alarm-contact-input

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure one of four available alarm contact input pins.

Parameters
alarm-contact-input-id

Specifies the alarm contact input pin.

Values

console-1 (when using console as alarm input pin) (7210 SAS-D, 7210 SAS-Dxp 12p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C)

1 to 3 (7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p)

alarm-output-severity
Syntax

[no] alarm-output-severity {critical | major | minor | none}

Context

config>system>alarm-contact-input

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command relays alarms from the alarm-contact input to the alarm-contact output by associating an appropriate alarm-contact output with the alarm-contact input. The system generates or clears the alarm-contact output when it triggers or clears the alarm for the associated alarm-contact input.

If multiple alarm-contact input pins share an alarm-contact output, the system generates the alarm-contact output even if any one of the alarm-contact input pins is triggered, and the system clears alarm-contact output only when all the alarm-contact input pins are cleared.

Note:

The system relays the alarm-contact input to the appropriate alarm-contact output only if the alarm-contact output is available on the platform.

The no form of this command reverts to the default value.

Default

alarm-output-severity major

Parameters
critical

Specifies that a critical alarm output is generated or cleared.

major

Specifies that a major alarm output is generated or cleared.

minor

Specifies that a minor alarm output is generated or cleared.

none

Specifies that no alarm output is generated or cleared.

clear-alarm-msg
Syntax

[no] clear-alarm-msg {alarm-msg-text}

Context

config>system>alarm-contact-input

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures a text message for use along with SNMP trap and Log message that are sent when the system clears an alarm. The system generates a default message if the message is not configured.

The no form of this command causes the system to not generate a trap or log.

Parameters
alarm-msg-text

Specifies a printable character string, up to 80 characters.

description
Syntax

description description-string

no description

Context

config>system>alarm-contact-input

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command describes an alarm contact input pin. The description provides an indication of the usage or attribute of the pin. It is stored in the CLI configuration file and helps the user identify the purpose of the pin.

The no form of this command removes the description string.

Parameters
description-string

Specifies the description character string, up to 80 characters.

normal-state
Syntax

normal-state [open | closed]

Context

config>system>alarm-contact-input

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures the normal state to be associated with the alarm-contact input. When the system detects a transition from the normal state, an alarm is generated. The alarm is cleared when the system detects a transition is back to the normal state.

Default

normal-state open

Parameters
open

Specifies that the normal state is identified as ‟open”. When the system detects a transition to the ‟closed” state, an alarm is generated. The alarm is cleared when the system detects a transition back to the ‟open” state.

closed

Specifies that the normal state is identified as ‟closed”. When the system detects a transition to the ‟open” state, and alarm is generated. The alarm is cleared when the system detects a transition back to the ‟closed” state.

shutdown
Syntax

[no] shutdown

Context

config>system>alarm-contact-input

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command stops tracking the state changes associated with the alarm contact input. The system does not generate or clear the alarms for the alarm-contact input, but if an alarm is generated for the alarm-contact input, the system clears the alarm when the shutdown command is executed.

The no form of this command starts tracking the state changes associated with the alarm-contact input.

Default

shutdown

trigger-alarm-msg
Syntax

[no] trigger-alarm-msg {alarm-msg-text}

Context

config>system>alarm-contact-input

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures a text message for use with an SNMP trap and log message that are sent when the system generates an alarm. The system generates a default message if the message is not configured.

The no form of this command causes the system to not generate a trap or log.

Parameters
alarm-msg-text

Specifies a printable character string, up to 80 characters.

LLDP system commands
lldp
Syntax

lldp

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure system-wide Link Layer Discovery Protocol parameters.

lldp-med
Syntax

lldp-med

Context

config>system>lldp

Platforms

7210 SAS-Dxp

Description

This command creates the context to configure system-wide LLDP Media Endpoint Discovery (LLDP-MED) information.

network-policy
Syntax

network-policy network-policy-id [create]

no network-policy network-policy-id

Context

config>system>lldp>lldp-med

Platforms

7210 SAS-Dxp

Description

This command configures network policies, which send configuration information using LLDP-MED TLVs. The configured policy specifies the network policy configuration that must be provided to the LLDP-MED endpoint device. Multiple policies can be configured with different application types.

By default, the system creates network policy 1, which is not associated with a port. The user must explicitly configure a policy for use with a port, or use the default network policy 1, and enable transmission and reception of LLDP-MED TLVs on the port.

The no form of the command removes the configured network policy ID.

Parameters
network-policy-id

Specifies the network policy ID.

Values

1 to 65535

create

Keyword to create a network policy.

application-type
Syntax

application-type {voice | voice-signaling | guest-voice | guest-voice-signaling | soft-phone-voice | video-conferencing | streaming-video | video-signaling}

no application-type

Context

config>system>lldp>lldp-med>network-policy

Platforms

7210 SAS-Dxp

Description

This command configures the application type for the specified network policy.

The configured application-type is used to match with the application type received from an LLDP-MED endpoint device and provides the endpoint device with the network policy configured for the requested application type.

The no form of this command configures the Network Policy TLV to send the application type value ‟not_specified” to the LLDP-MED endpoint device.

Default

no application-type