System Command Reference

This command allows the user to enable a supply of +24V output power on the +24VDC pin of the Alarm Interface Port of the CPM. When enabled, the power supplied through the +24VDC output pin can be used as a source voltage for the alarm contact input pins. The +24VDC output can be used to supply power for monitoring external sensor devices such as cabinet door sensors instead of using an external power source. If users want to use a separate external power source, they should disable the supply of power to the +24VDC output pin by using this CLI command.

This command provides the context to configure one of four available alarm contact input pins.

This command allows the user to configure a text message for use along with SNMP trap and log event messages that are sent when the system clears an alarm. The system generates the default message "Alarm Input Cleared" if no message is configured. The clear-alarm-msg string is included in the log event when the pin changes to the normal state.

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 in identifying the purpose of the pin. The description is included in the log event when the pin changes state (the string “Pin x” is used in the log events if no description is configured).

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 back to the normal state.

Configure the normal state as closed if an external power source is used to power the inputs.

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, the system clears the alarm when the shutdown command is executed. The no form of the command starts tracking the state changes associated with the alarm contact input.

This command allows the user to configure a text message for use along with SNMP trap and log event messages that are sent when the system generates an alarm. The system generates the default message "Alarm Input Triggered" if no message is configured. The trigger-alarm-msg string is included in the log event when the pin changes from the normal state.

The alarm command configures an entry in the RMON-MIB alarmTable. 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. 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.

Use the no form of this command to remove an rmon-alarm-id from the configuration.

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.

This command enables capacity monitoring of the compact flash specified in this command. The usage is monitored as a percentage of the capacity of the compact flash. 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.

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.

This command enables capacity monitoring of the compact flash specified in this command. The usage is monitored as a percentage of the capacity of the compact flash.

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.

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

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

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

The event 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.

Use the no form of this command to remove an rmon-event-id from the configuration.

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 absolute sample type method is used.

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

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.

This command creates the context to 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.

This command enables the context to configure monitoring thresholds.

This command sets the local system 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. This command does not take into account any daylight saving offset if defined.

If SNTP or NTP is enabled (no shutdown) then this command cannot be used.

This command enables the context to configure the system time zone and time synchronization parameters.

This command enables the context to 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. Use the no form of the command to stop the execution of NTP and remove its configuration.

This command provides the option to skip 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.

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 the command removes the authentication key.

This command configures the node to transmit NTP packets on a given interface. Broadcast and multicast messages can easily be spoofed, thus, authentication is strongly recommended.

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

When configuring NTP, the node can be configured to receive broadcast packets on a given subnet. Broadcast and multicast messages can easily be spoofed, thus, authentication is strongly recommended. If broadcast is not configured then received NTP broadcast traffic will be ignored. Use the show command to view the state of the configuration.

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

This command configures NTP the node to transmit multicast packets on the CPM/CCM MGMT port. Broadcast and multicast messages can easily be spoofed; authentication is strongly recommended.

The no form of this command removes the multicast address from the configuration.

This command configures the node to receive multicast NTP messages on the CPM MGMT port. If multicastclient is not configured, received NTP multicast traffic will be ignored. Use the show command to view the state of the configuration.

The no construct of this message removes the multicast client for the specified interface from the configuration.

This command configures the node to assume the role of an NTP server. Unless the server command is used, this node will function as an NTP client only and will not distribute the time to downstream network elements.

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 it is recommended to configure authentication and to configure known time servers as their peers.

The no form of the command removes the configured peer.

This command is used when the node should operate in client mode with the ntp server specified in the address field of this command. The no construct of this command removes the server with the specified address from the configuration.

If the internal PTP process is to be used as a source of time for System Time and OAM time then it must be specified as a server for NTP. If PTP is specified then the prefer parameter must also be specified. Once PTP has established a UTC traceable time from an external grandmaster then it shall always be the source for time into NTP even if PTP goes into time holdover. PTP applies only to the 7450 ESS and 7750 SR.

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

This command creates or edits the context to create or modify timing reference parameters.

This command is required to discard changes that have been made to the synchronous interface timing configuration during a session.

This command is required in order to enter the mode to create or edit the system synchronous interface timing configuration.

This command enables the context to configure parameters for the Building Integrated Timing Supply (BITS). The settings specified under this context apply to both the BITS input and BITS output ports and to both the bits1 and bits2 ports on the 7750 SR-c4.

The bits command subtree is only available on the 7450 ESS-7, 7450 ESS-12, 7750 SR-7, 7750 SR-12, 7750 SR-12e, 7750 SR-c4, 7950 XRS-20, 7950 XRS-40, 7950 XRS-16c, 7750 SR-a4, 7750 SR-a8, 7750 SR-1e, 7750 SR-2e, and 7750 SR-3e.

This command saves changes made to the system synchronous interface timing configuration.

This command configures the Building Integrated Timing Source (BITS) timing reference.

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

This command configures the interface type of the BITS timing reference.

This command is only supported on the 7750 SR-c12.

The no form of the command reverts to the default configuration

This command provides a context to enable or disable the external BITS timing reference inputs to the central clock of the router. In redundant systems with BITS ports, there are two possible BITS-in interfaces, one for each CPM or CCM. In the 7750 SR-c4 system, there are two bits ports on the CFM. The two BITS-in interfaces are configured together, but they are displayed separately in the show command.

This command provides a context to configure and enable or disable the external BITS timing reference output to the central clock of the router. On redundant systems, there are two possible BITS-out interfaces, one for each CPM or CCM. On the 7750 SR-c4 system, there are two possible BITS-out interfaces on the chassis front panel. The two BITS-out interfaces are configured together, but they are displayed separately in the show command.

This command configures the line-length parameter of the BITS output, This is the distance in feet between the network element and the office clock (BITS/SSU). There are two possible BITS-out interfaces, one for each CPM. They are configured together, but they are displayed separately in the show command. This command is only applicable when the interface-type is DS1.

This command configures the values used to identity the source of the BITS (Building Integrated Timing Supply) output. This is either the signal recovered directly from ref1, ref2 or ptp, or it is the output of the node’s central clock. The directly recovered signal would be used when the BITS output signal is feeding into an external stand alone timing distribution device (BITS/SASE). The specific directly recovered signal used is the best of the available signals based of the QL and/or the ref-order. The central clock output would be used when no BITS/SASE device is present and the BITS output signal is used to monitor the quality of the recovered clock within the system.

This command configures which sa-bit to use for conveying SSM information when the interface-type is E1.

This command configures the QL value to be used for the reference for SETS input selection and BITS output. This value overrides any value received by that reference's SSM process.

When enabled the selection of system timing reference and BITS output timing reference takes into account quality level. Quality level is conveyed via the SSM or forced using the ql-override command.

This command enables the context to configure parameters for system timing via IEEE 1588-2008, Precision Time Protocol. This command only applies to the 7450 ESS-7, 7450 ESS-12, and all 7750 SRs except for the 7750 SR-1e, 7750 SR-2e, and 7750 SR-3e.

The synchronous equipment timing subsystem can lock to different timing reference inputs, those specified in the ref1, ref2, bits and ptp (ptp applies only to the 7450 ESS and 7750 SR) 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.

For 7450 ESS and 7750 SR systems with two SF/CPM modules, the system distinguishes between the BITS inputs on the active and standby CPMs. The active CPM will use its BITS input port providing that port is qualified. If the local port is not qualified, then the active CPM will use the BITS input port from the standby CPM as the next priority reference. For example, the normal ref-order of bits ref1 ref2 will actually be bits (active CPM), followed by bits (standby CPM), followed by ref1, followed by ref2.

For 7750 SR-c4 systems, the system distinguishes between the two BITS inputs on the CFM. The CFM will use its BITS input port bits1 providing that port is qualified. If port bits1 is not qualified, then the CFM will use the BITS input port bits2 as the next priority reference. For example, the normal ref-order of bits ref1 ref2 will actually be bits1 followed by bits2, followed by ref1, followed by ref2.

For 7950 XRS systems with two SF/CPMs and two CCMs, the system distinguishes between the BITS inputs on the CCMs associated with the active and standby CPMs. The active CPM will use the BITS input port on the associated CCM, provided that the port is qualified. If the local port is not qualified, then the active CPM will use the BITS input port from the CCM associated with the standby CPM as the next priority reference. For example, the normal ref-order of bits ref1 ref2 will actually be bits (active CCM), followed by bits (standby CCM), followed by ref1, followed by ref2.

The no form of the command resets the reference order to the default values.

The bits option is not supported on the 7750 SR-c12 chassis.

This command enables the context to configure parameters for the first timing reference. The source ports for ref1 and ref2 must be on different slots. Note that for the 7750 SR-a4, 7750 SR-c4, and 7750 SR-c12, the source ports for ref1 and ref2 may be on the same slot.

The ref1 and ref2 cannot be configured on the same MDA/CMA for the 7750 SR-a, 7750 SR-c12, or 7750 SR-c4. On a 7950 XRS-40 system, the source ports for ref1 and ref2 must reside on the master chassis.

The restrictions on the location for the source-port or source-bits for ref1 and ref2 are listed in Table 42.

This command enables the context to configure parameters for the second timing reference. There are restrictions on the source-port and source-bits locations for ref2 based on the platform. The restrictions on the location for the source-port or source-bits for ref1 and ref2 are listed in Table 42.

This command allows the clock to revert to a higher priority reference if the current reference goes offline or becomes unstable. When the failed reference becomes operational, it is eligible for selection. When the mode is non-revertive, a failed clock source is not selected again.

This command configures the source bits for the first (ref1) or second (ref2) timing reference. This command is only applicable to the 7750 SR-c12 chassis. There are restrictions on the source-bits location for ref1 and ref2 based on platform. Refer to the description of the ref1 command for details.

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.

In addition to physical port on the 7750 SR, T1 or E1 channels on a Channelized OC3/OC12/STM1/STM4 Circuit Emulation Service port can be specified if they are using adaptive timing.

There are restrictions on the source-port location for ref1 and ref2 based on platform. Refer to the description of the ref1 command for details.

The context to configure administrative system commands. Only authorized users can execute the commands in the admin context.

This command enables the context to perform application-assurance operations and only applies to the 7450 ESS and 7750 SR.

This command loads a new protocol list from the isa-aa.tim file into the CPM and only applies to the 7450 ESS and 7750 SR.

This command requires an ISA-AA reboot.

This command allows an authorized administrator to clear an exclusive policy lock. This will reset the lock flag and end the policy editing session in progress, aborting any policy edits.

This command saves existing debug configuration (configuration done under the debug branch of CLI). Debug configurations are not saved by the admin save command and not preserved across a node reboot. The debug-save command makes the debug configuration available for the operator to execute after a reboot by using the exec command, if desired.