6.13. System Command Reference

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 can be deleted.

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

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.

This command enables the context to configure system-wide ATM parameters.

This command indicates the location ID for ATM OAM.

Refer to the 7705 SAR Quality of Service Guide, “ATM QoS Traffic Descriptor Profiles”, for information on ATM QoS policies and the 7705 SAR Services Guide, “VLL Services” for information on ATM-related service parameters.

Use this command to configure a URL for a CLI script to execute 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 (re)boots and are included in the configuration saves (admin>save).

Also refer to the related command exec.

Use this command to configure a URL for a CLI script to execute following the success of a boot-up configuration.

Also refer to the related command exec.

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

No CLLI validity checks other than truncating or padding the string to 11 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 the command removes the CLLI code.

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

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

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 CSM is performed for all configurations and their associated persistent index files.

The no form of the command returns the configuration to the default value.

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 will overwrite the previous entry.

The no form of the command reverts to the default.

This command creates a text string that identifies the system coordinates for the device location. For example, the command coordinates “37.390 -122.0550” 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 the command reverts to the default value.

This command configures a static system identifier for the 7705 SAR. The system identifier can be used to uniquely identify the 7705 SAR in the network instead of the system IP address, as a system IP address can change dynamically using DHCP when the 7705 SAR is acting as a DHCP client and the DHCP server-facing interface is unnumbered. To prevent management systems (for example, the NSP NFM-P) from rediscovering a node based on a system IP address that has been changed via DHCP, and thus losing historical data attributed to a specific system IP address, a static system identifier should be configured.

The system identifier takes the form of an IPv4 address. This address is not advertised in IGP or BGP and is used solely as a node identifier.

The no form of the command deletes the system identifier.

This command configures system-wide Layer 4 load balancing. The configuration at the system level can enable or disable load balancing across all IP interfaces. When enabled, Layer 4 source and destination port fields of incoming TCP/UDP packets are included in the hashing calculation to randomly determine the distribution of packets.Adding the Layer 4 source and destination port fields to the hashing algorithm generates a higher degree of randomness and a more even distribution of packets across the available ECMP paths or LAG ports.

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 the command reverts to the default value.

This command configures system-wide LSR load balancing. Hashing can be enabled on the IP header at an LSR to send labeled packets over multiple equal-cost paths in an LDP LSP and/or over multiple links of a LAG group in all types of LSPs.

The bottom-of-stack option determines the significance of the bottom-of-stack label (VC label) based on which label stack profile option is specified.

When LSR load balancing is enabled, the default configuration for the hashing algorithm is label-only (lbl-only) hashing, and the default configuration for the bottom-of-stack hashing treatment is profile-1.

The use-ingress-port option, when enabled, specifies that the ingress port will be used by the hashing algorithm at the LSR. This option should be enabled for ingress LAG ports because packets with the same label stack can arrive on all ports of a LAG interface. In this case, using the ingress port in the hashing algorithm will result in better egress load balancing, especially for pseudowires.

The option should be disabled for LDP ECMP so that the ingress port is not used by the hashing algorithm. For ingress LDP ECMP, if the ingress port is used by the hashing algorithm, the hash distribution could be biased, especially for pseudowires.

LSR load-balancing configuration on an interface overrides the system-wide LSR load-balancing settings for the interface.

This command creates a system name string for the device.

For example, system-name parameter ALU-1 for the name command configures the device name as ALU-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 the command reverts to the default value.

This command suppresses power feed monitoring and alarms on the secondary input power feed of a chassis when that power feed is not in use. Use this command when monitoring and raising alarms on the unused power input is not required. Suppressing monitoring and alarms on an unused input power feed results in the following:

Power feed monitoring and alarming is enabled by default.

This command enables the use of the system IP address in the hash algorithm to add a per-system variable. This can help to guard against cases where multiple routers, in series, will end up hashing traffic to the same ECMP or LAG path. The algorithm based on the system IP address is included by default.

This command enables the context to configure monitoring thresholds.

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

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 alarm.

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 Warning.

The absolute sample type method is used.

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

This command enables 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.

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

This command enables the context to configure persistence parameters on the system.

The persistence feature allows lease information on DHCP servers to be kept across reboots. This information can include data such as the IP address, MAC binding information, and lease length information.

This command configures DHCP server persistence parameters.

This command instructs the system where to write the file. The name of the file is dhcp-serv.001. On boot-up, the system scans the file systems looking for dhcp-serv.001. If the system finds the file, it loads it.

The no form of this command returns the system to the default.

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.

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

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 Table 23, 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 Table 23 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 will return an error message. If no summer (daylight savings) time is supplied, it is assumed no summer time adjustment is required.

The no form of the command removes a configured summer (daylight savings) time entry.

This command configures the end of summer time settings.

This command specifies the number of minutes that will be added to the time when summer time takes effect. The same number of minutes will be subtracted from the time when the summer time ends.

This command configures start of summer time settings.

This command enables the context to create or modify gnss parameters for time.

This command specifies a GNSS receiver port as a synchronous timing source. The specific GNSS receiver port is identified by port-id and has an assigned priority-value.

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, one for key ID, and 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.

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 enables more accurate timestamping for in-band NTP packets. When enabled, timestamping is performed on an adapter card by the network processor as packets ingress and egress the router. This reduces packet delay variability. This command can only be set if NTP is shut down and the NTP servers are not associated with an authentication key. This command is only supported on Ethernet-based adapter cards. This command does not change the behavior of NTP over the management port.

The no form of this command returns the system to its default behavior of having NTP packets timestamped by the CSM.

This command configures the node to receive multicast NTP messages on the CSM Management 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 form of this command removes the multicast client for the specified interface from the configuration.

This command is used when the node should operate in client mode with the NTP server specified in the address field of this command. Only the IP address parameter is required; the other parameters are optional. The no form of this command removes the server with the specified address from the configuration.

Up to five NTP servers can be configured.

This command enables the context to create or modify ptp parameters for time.

This command specifies the PTP (Precision Time Protocol) source as an option for recovered time for the 1pps (1 pulse per second) port. The specific PTP clock is identified by clock-id and has an assigned priority-value.

This command enables the context to 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 automatically adjusted at system initialization time or when the protocol first starts up.

When the time differential between the SNTP/NTP server and the system is more than 2.5 seconds, the time on the system is gradually adjusted.

SNTP is created in an administratively enabled state (no shutdown).

The no form of the command removes the SNTP instance and configuration. SNTP does not need to be administratively disabled when removing the SNTP instance and configuration.

This command enables listening to SNTP/NTP broadcast messages on interfaces with broadcast client enabled at global device level.

When this global parameter is configured, then the ntp-broadcast parameter must be configured on selected interfaces on which NTP broadcasts are transmitted.

SNTP must be shut down prior to changing either to or from broadcast mode.

The no form of the command disables broadcast client mode.

This command creates an SNTP server for unicast client mode.

This command enables the context to create or modify tod-1pps connector parameters.

This command specifies the format for the Time of Day message that is transmitted out the time of day (ToD) or ToD/PPS Out port on the following:

This Time of Day message output is only available when the router is configured with an active IP PTP slave clock or boundary clock. It is not available when Time of Day is recovered from an Ethernet PTP clock or integrated GNSS.

This command specifies whether the 1pps output is enabled. When disabled, neither the 1pps nor the RS-422 serial port is available.

This command sets the time zone and/or time zone offset for the device.

The 7705 SAR supports system-defined and user-defined time zones. The system-defined time zones are listed in Table 23.

For user-defined time zones, the zone and the UTC offset must be specified.

The no form of the 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 will be 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.

This command enables the context to create scripts, script parameters and schedules that 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 will be determined by the contents of the script.

This command configures action parameters for a script.

This command configures the maximum amount of time to keep the results from a script run.

This command configures the maximum amount of time a script may run.

This command specifies the maximum number of completed sessions to keep in the event execution log. If a new event execution record exceeds the number of records specified by this command, the oldest record is deleted.

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

This command specifies 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.

This command creates action 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.

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

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 the command removes the context from the configuration.

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.

This command specifies which days of the month that the schedule will occur. Multiple days of the month can be specified. When multiple days are configured, each of them will cause the schedule to trigger. If a day-of-month is configured without configuring month, weekday, hour and minute, the event will not execute.

Using the weekday command as well as the day-of-month command will cause the script to run twice. For example, consider that “today” is Monday January 1. If “Tuesday January 5” is configured, the script will run on Tuesday (tomorrow) as well as January 5 (Friday).

The no form of this command removes the specified day-of-month from the list.

This command is used concurrently with type periodic or calendar. Using the type of periodic, end-time determines at which interval the schedule will end. Using the type of calendar, end-time determines on which date the schedule will end.

When no end-time is specified, the schedule runs forever.

This command specifies which hour to schedule a command. Multiple hours of the day can be specified. When multiple hours are configured, each of them will cause 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 month, weekday, day-of-month, and minute, the event will not execute.

The no form of this command removes the specified hour from the configuration.

This command specifies the interval between runs of an event.

This command specifies the minute to schedule a command. Multiple minutes of the hour can be specified. When multiple minutes are configured, each of them will cause the schedule to occur. If a minute is configured, but no hour or day is configured, the event will not execute. If a minute is configured without configuring month, weekday, day-of-month, and hour, the event will not execute.

The no form of this command removes the specified minute from the configuration.

This command specifies the month when the event should be executed. Multiple months can be specified. When multiple months are configured, each of them will cause the schedule to trigger. If a month is configured without configuring weekday, day-of-month, hour and minute, the event will not execute.

The no form of this command removes the specified month from the configuration.

This command specifies how the system should interpret the commands contained within the schedule node.

This command specifies which days of the week that the schedule will fire on. Multiple days of the week can be specified. When multiple days are configured, each of them will cause the schedule to occur. If a weekday is configured without configuring month, day-of-month, hour and minute, the event will not execute.

Using the weekday command as well as the day-of month command will cause the script to run twice. For example, consider that “today” is Monday January 1. If “Tuesday January 5” is configured, the script will run on Tuesday (tomorrow) as well as January 5 (Friday).

The no form of this command removes the specified weekday from the configuration.

This command configures the name associated with this script.

This command configures the location of script to be scheduled.

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 BITS timing on the 7705 SAR-18. The BITS input and output ports can be configured for T1/E1 or 2 MHz G.703 signals.

This command enables the context to configure BITS input timing ports parameters on the 7705 SAR-18.

This command specifies the signal type for the BITS input and output ports. If you configure the signal type as ds1, the system automatically defaults to esf. If you configure the signal type as e1, the system automatically defaults to pcm30crc.

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

This command enables the context to configure BITS output port parameters on the 7705 SAR-18.

This command configures the line length, in feet, between the network element and the central clock (BITS/SSU).

This command is only applicable when the interface-type is DS1.

This command configures the source of the BITS output ports in the 7705 SAR-18.

By default the source is configured as internal-clock, which provides a filtered signal from the output of the node’s central clock. The central clock output is usually used when no BITS/SASE device is present. When an external BITS/SASE clock is present, it is often desirable to provide an unfiltered clock reference to it by configuring line-ref. When the line-ref parameter is configured, the recovered clock from ref1 or ref2 (based on configuration of the ref-order and ql-selection commands) is transmitted directly out the BITS output port without filtering.

This command configures a static quality level value. This value overrides any dynamic quality level value received by the Synchronization Status Messaging (SSM) process.

This command configures which Sa-bit to use for conveying Synchronization Status Messaging (SSM) information when the interface type is E1.

This command is required in order to save the changes made to the system synchronous interface timing configuration.

This command enables the context to configure parameters for external timing via the port on the CSM. This can be used to reference external synchronization signals.

This command enables the context to configure parameters for external input timing interface via the port on the CSM.

This command configures the impedance of the external input timing port. The command is only applicable to the 7705 SAR-8, 7705 SAR-H, and 7705 SAR-M.

This command configures the interface type of the external timing port.

The no form of the command reverts to the default.

This command enables the context to configure parameters for external output timing interface via the port on the CSM.

This command enables SSM encoding as a means of timing reference selection.

The synchronous equipment timing subsystem can lock to three different timing reference inputs, those specified in the ref1, ref2, external, and bits 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 the 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 will no longer be qualified as a valid reference.

For unfiltered BITS output (T4), all reference sources are valid options, except the BITS input, which is excluded to avoid a timing loop. Because the same priority order is used for the SETG output (T0), the BITS input option must be set as the first (highest-priority) reference option.

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

This command enables the context to configure parameters for the first timing reference.

This command enables the context to configure parameters for the second timing reference.

This command configures the source port for timing reference ref1 or ref2.

The timing reference can either be timing extracted from the receive port (line-timed) or packetized data of a TDM PW (adaptive). If the adaptive option is not selected, the system uses line timing mode. If the line timing is from a port that becomes unavailable or the link goes down, then the reference sources are re-evaluated according to the reference order configured by the ref-order command.

Line timing is supported on T1/E1 ports of the 7705 SAR-M and 7705 SAR-A (variants with T1/E1 ports) and on the T1/E1 ports of the 7705 SAR-H 4-port T1/E1 and RS-232 Combination module.

Line timing is also supported in the form of synchronous Ethernet on all RJ-45 and optical SFP Ethernet ports on the 7705 SAR-M (all variants), 7705 SAR-H, 7705 SAR-Hc, 7705 SAR-W, 7705 SAR-Wx (all variants), 7705 SAR-X, and 7705 SAR-Ax. The 7705 SAR-A (all variants) supports line timing on its synchronous Ethernet capable ports (1 to 8) when they are fixed RJ-45 or optical SFP.

In addition, line timing is supported on the following modules when they are installed in chassis variants with module slots:

On the 7705 SAR-8 or 7705 SAR-18, line timing is supported on:

Adaptive timing is supported on the T1/E1 ports on the 7705 SAR-X and the 7705 SAR-M and 7705 SAR-A (variants with T1/E1 ports). On the 7705 SAR-8 and 7705 SAR-18, adaptive timing is supported on the 16-port T1/E1 ASAP Adapter card and the 32-port T1/E1 ASAP Adapter card configured with one or more TDM PWs. (The 16-port T1/E1 ASAP Adapter card, version 1, is not supported on the 7705 SAR-18.) Adaptive timing is also supported on the T1/E1 ports of the 4-port T1/E1 and RS-232 Combination module when it is installed in the 7705 SAR-H.

Note: The PW terminated on channel group 1 will be used to extract the ACR timing.

Synchronous Ethernet ports can supply a timing reference on the 7705 SAR-M (all variants), 7705 SAR-A (both variants), 7705 SAR-Ax, 7705 SAR-W, 7705 SAR-Wx (all variants), and 7705 SAR-X. Two T1/E1 ports can supply a timing reference on the 7705 SAR-X and on the 7705 SAR-M and 7705 SAR-A (variants with T1/E1 ports).

On the 7705 SAR-H and 7705 SAR-Hc, all RJ-45 Ethernet ports and SFP ports support synchronous Ethernet and can supply a timing reference to be used as a source of node synchronization. When the 4-port T1/E1 and RS-232 Combination module is installed in the 7705 SAR-H, a single T1/E1 port on the module can supply a timing reference.

When the 2-port 10GigE (Ethernet) module or 6-port SAR-M Ethernet module is installed in the 7705 SAR-M (variants with module slot), the ports on the module can supply a timing reference.

The 7705 SAR-8 and 7705 SAR-18 can receive one or two timing references depending on the port and card type supplying the reference. The 7705 SAR-8 supports two timing references only if a CSMv2 is installed. On the 7705 SAR-8 or 7705 SAR-18, a timing reference can come from:

The no form of this command deletes the source port from the reference. An example of when the no form would be used is if the user wants to change the reference to a source IP interface in order to enable PTP. In this case, the user would first delete the PTP using the no source-port command, then configure the source IP interface using the source-ptp-clock command.

This command configures the reference source clock using the clock ID configured by the PTP clock command.

This command allows the clock to revert to a higher-priority reference if the current reference goes offline or becomes unstable. With revertive switching enabled, the highest-priority valid timing reference will be used. If a reference with a higher priority becomes valid, a reference switchover to that reference will be initiated. If a failure on the current reference occurs, the next highest reference takes over. With non-revertive switching, the active reference will always remain selected while it is valid, even if a higher-priority reference becomes available. If this reference becomes invalid, a reference switchover to a valid reference with the highest priority will be initiated. When the failed reference becomes operational, it is eligible for selection.

This command enables the context to configure system-wide Link Layer Discovery Protocol (LLDP) parameters.

This command configures the interval between LLDPDU transmissions by the LLDP agent during a fast transmission period.

The fast transmission period begins when a new neighbor is detected. During the fast transmission period, LLDPDUs are transmitted at shorter intervals than the standard tx-interval to ensure that more than one LLDPDU is sent to the new neighbor. The first transmission occurs as soon as the new neighbor is detected. The length of the fast transmission period is determined by the number of LLDPDU transmissions (configured by the message-fast-tx-init command) and the interval between them.

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

This command configures the number of LLDPDUs to send during a fast transmission period.

The fast transmission period begins when a new neighbor is detected. During the fast transmission period, LLDPDUs are transmitted at shorter intervals than the standard tx-interval to ensure that more than one LLDPDU is sent to the new neighbor. The first transmission occurs as soon as the new neighbor is detected. The length of the fast transmission period is determined by the number of LLDPDU transmissions and the interval between them (configured by the message-fast-tx command).

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

This command configures the minimum time between change notifications. A change notification is a trap message sent to SNMP whenever a change occurs in the database of LLDP information.

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

This command configures the time before reinitializing LLDP on a port.

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

This command configures the maximum number of consecutive LLDPDUs that can be transmitted at any time.

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

This command configures the multiplier of the transmit interval defined by the tx-interval command.

The transmit interval time multiplied by the tx-hold-multiplier is the TTL value in the LLDPDU. The TTL value determines the amount of time the receiving device retains LLDP packet information in local information databases before discarding it.

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

This command configures the LLDP transmit interval time.

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

This command enables the context to create or modify PTP timing parameters.

This command creates a PTP clock, which can be set to a master, slave, boundary, or transparent clock using the clock-type command. The clock-id can be a numeric value (1 to 16) or it can be the keyword csm.

Use the numeric value for PTP clocks that transmit and receive PTP messages using IPv4 encapsulation. On the 7705 SAR-M, 7705 SAR-H, 7705 SAR-Hc, 7705 SAR-A, 7705 SAR-Ax, 7705 SAR-W, 7705 SAR-Wx, and 7705 SAR-X, only one PTP instance can be master, slave, or boundary.

Use the csm keyword when the PTP clock transmits and receives PTP messages using Ethernet encapsulation. Ethernet-encapsulated PTP messages are processed on the CSM module or CSM functional block.

The no form of the command deletes a PTP clock when the clock-id is set to a numeric value. The CSM PTP clock cannot be removed.

This command defines the number of announce timeouts that need to occur on a PTP slave port or boundary clock port in slave mode before communication messages with a master clock are deemed lost and the master clock is considered not available. One timeout in this context is equal to the announce interval in seconds, calculated using the logarithm 2^log-anno-interval.

The no form of this command returns the configuration to the default value.

This command configures the adapter card slot that performs the IEEE 1588v2 clock recovery. On the 7705 SAR-M, 7705 SAR-H, 7705 SAR-Hc, 7705 SAR-A, 7705 SAR-Ax, 7705 SAR-W, and 7705 SAR-Wx, this slot is always 1/1. On the 7705 SAR-X, this slot is always either 1/2 or 1/3.

This command is only available when the clock-id parameter value is 1 to 16.

The no form of this command clears the clock recovery adapter card.

This command configures the type of clock. The no form of the command returns the configuration to the default (ordinary slave). The clock type can only be changed when PTP is shut down.

To enable transparent clock processing at the node level, configure a PTP clock with the transparent-e2e clock type. The transparent-e2e clock type is only available for a PTP clock that transmits and receives PTP messages using IPv4 encapsulation.

This command defines the PTP device domain as an integer. A domain consists of one device or multiple PTP devices communicating with each other as defined by the protocol. A PTP domain defines the scope of PTP message communication, state, operations, data sets and timescale. A domain is configured because it is possible that a deployment could require two PTP instances within a single network element to be programmed with different domain values.

The no form of this command returns the configuration to the default value. The default value varies depending on the configuration of the profile command.

This command allows a slave clock to connect to the master clock without the master being aware of it. Once connected, the master clock or boundary clock assigns the slave a PTP port and/or peer ID dynamically.

This command is only available when the clock-id parameter value is 1 to 16.

Dynamic peers are not stored in the configuration file. If a master clock with dynamic peers goes down and comes back up, the slave clocks renegotiate to it and are reassigned resources on the master clock or boundary clock.

The no form of this command disables dynamic peers. In this case, the user must manually program any slave peer clocks into the master clock or boundary clock in order for those clocks to accept those slaves.

This command specifies the administrative frequency source to use for a given PTP clock. This selection influences the operational frequency source selected by the system for the given PTP clock. If PTP is only used for time of day and the node SSU is being synchronized through a better frequency source externally (for example, through the external timing input port) or through line timing (for example, through a synchronous Ethernet or T1/E1 port), SSU may be configured as the frequency source for the PTP clock. This option allows PTP to use the SSU frequency where available.

This command is only available when the clock-id parameter value is 1 to 16.

The no form of the command returns the configuration to the default setting.

This command configures the local priority used to choose between PTP masters in the best master clock algorithm (BMCA). If the PTP profile is set to ieee1588-2008 or itu-telecom-freq, this parameter is ignored. The priority of the port or local clock can only be configured if the PTP profile is set to g8275dot1-2014. The value of the highest priority is 1 and the value of the lowest priority is 255.

The no form of this command returns the configuration to the default value.

This command configures the announce message interval used for unicast and multicast messages.

For unicast messages, this command defines the announce message interval that is requested during unicast negotiation to any peer. This controls the announce message rate sent from remote peers to the local node. It does not affect the announce message rate that may be sent from the local node to remote peers. Remote peers may request an announce message rate anywhere within the acceptable grant range.

For multicast messages on PTP Ethernet ports, this command configures the message interval used for announce messages transmitted by the local node.

This value also defines the interval between executions of the BMCA within the node. In order to minimize BMCA-driven reconfigurations, the IEEE Std 1588-2008 recommends that the announce interval be consistent across the entire IEEE 1588 network.

The announce message interval cannot be changed unless PTP is shut down.

The log-anno-interval is calculated using the binary logarithm of the value of the interval in seconds before message reception. For example, for an announce message interval of 8 packets/s (one packet every 0.125 seconds), set this field to log(base2) (0.125) = –3.

The no form of this command returns the configuration to the default value. The default value varies depending on the configuration of the profile command.

This command configures whether to use SDH or SONET values for encoding synchronous status messages. This command only applies to synchronous Ethernet ports and is not configurable on SONET/SDH ports.

This command is only available when the clock-id parameter is defined as csm.

This command configures PTP over Ethernet on the physical port, so that PTP messages are sent and received over the port using Ethernet encapsulation. There are two reserved multicast addresses allocated for PTP messages (see Annex F of IEEE Std 1588- 2008 and the address command). Either address can be configured for the PTP messages sent through this port.The adapter card, module, or fixed platform containing the specified port cannot be deprovisioned while the port is configured for PTP. A port configured for dot1q or qinq encapsulation can be configured as the physical port for PTP over Ethernet. The encapsulation type and the Ethernet port type cannot be changed when PTP Ethernet multicast operation is configured on the port.

This command is only available when the clock-id parameter is defined as csm.

This command configures the MAC address to be used as the multicast destination MAC address for transmitted PTP messages. The IEEE Std 1588-2008 Annex F defines the two reserved addresses for PTP messages as:

The system will accept PTP messages received using either destination MAC address, regardless of the address configured by this command.

The no form of this command returns the address to the default value.

This command configures the minimum interval between multicast Delay_Req messages for PTP with Ethernet encapsulation. This parameter is applied on a per-port basis and does not apply to peers. PTP slave ports use this interval unless the parent port indicates a longer interval. PTP master ports advertise this interval to external slave ports as the minimum acceptable interval for Delay_Req messages from those slave ports. The 7705 SAR supports the IEEE 1588 requirement that a port in slave mode check the logMessageInterval field of received multicast Delay_Resp messages. If the value of the logMessageInterval field for those messages is greater than the value configured locally to generate Delay_Req messages, then the slave port must use the longer interval for generating Delay_Req messages.

The log-delay-interval is calculated using the binary logarithm of the value of the interval in seconds.

The log-delay-interval is only applicable when the clock-id is csm. For PTP with IP encapsulation (clock-id is 1 to 16), the value configured for the log-sync-interval is also used as the interval for Delay-Req messages.

The no form of this command returns the configuration to the default value. The default value varies depending on the configuration of the profile command.

This command configures the interval between transmission of synchronization packets for a PTP port in a master state. For PTP with IP encapsulation (clock-id is 1 to 16), this value is also used as the interval for Delay-Req messages for this clock.

The no form of this command returns the configuration to the default value. The default value varies depending on the configuration of the profile command.

This command prevents the local port from ever entering the slave state. This ensures that the 7705 SAR never draws synchronization from an attached external device.

This command only applies when the profile command is set to g8275dot1-2014.

If the clock-type command is set to ordinary slave, the master-only value is set to false and cannot be changed. Similarly, if the clock-type command is set to ordinary master, the master-only value is set to true and cannot be changed.

This command configures the first priority value of the local clock. This value is used by the BMCA 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.

When the profile command is set to g8275dot1-2014, the priority1 value is set to the default value of 128 and cannot be changed.

The no form of the command returns the configuration to the default value.

This command configures the second priority value of the local clock. This value is used by the BMCA 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.

When the profile command is set to g8275dot1-2014 and the clock-type is configured as ordinary slave, the priority2 value is set to the default value of 255 and cannot be changed.

The no form of the command returns the configuration to the default value.

This command defines the specification rules to be used by PTP. Configuring the profile changes the BMCA and SSM/QL mappings to match the settings in the specification. The profile can only be changed when PTP is shut down. Changing the profile changes the domain to the default value of the new profile.

The no form of the command returns the configuration to the default setting.

This command configures an IEEE 1588v2 logical port in the system. It also enables the context to configure parameters for IEEE 1588v2. PTP ports are created when the clock type is set with the clock-type command.

This command is only available when the clock-id parameter value is 1 to 16.

When the clock type is set to ordinary slave, one port with 2 peers is created. When the clock type is set to ordinary master, one port with 50 peers is created. When the clock type is set to boundary clock, 50 ports each with one peer are created.

Note: When the clock type is set to transparent, PTP is associated with all ports on the 7705 SAR-M, 7705 SAR-H, 7705 SAR-Hc, 7705 SAR-A, 7705 SAR-Ax, 7705 SAR-W, 7705 SAR-Wx, or 7705 SAR-X, rather than on individual ports, as transparent clock is a system-wide setting.

This command enables the context to configure parameters associated with remote PTP peers such as grand master clocks.

For ordinary slave clocks, 2 peers are automatically created. For ordinary master clocks, 50 peers are automatically created. For boundary clocks, 1 peer per PTP port is automatically created.

The no form of the command removes the IP address from the PTP peer.

This command configures a remote PTP peer address and enables the context to configure parameters for the remote PTP peer.

Up to two remote PTP peers may be configured on a PTP port.

The no form of the command removes the IP address from the PTP peer.

This command specifies whether the slave clock is to initiate a unicast request to the master clock or wait for announce and synchronization messages from the master clock.

The no form of this command disables unicast-negotiate. In this case, the user must specify the slave clock information when configuring the 7705 SAR master node in order for communication between the slave clock and master clock to take place.

This command defines the IP interface that provides the IEEE 1588 packets to the clock recovery mechanism on the adapter card or port. The interface must be PTP-enabled.

This command only applies when the clock-id parameter value is 1 to 16.

If the ip-if-name refers to a loopback or system address, then the remote peer must send packets to ingress on this particular loopback or system address. If the ip-if-name refers to an interface that is associated with a physical port or VLAN, then the remote peer must send packets to ingress on this particular IP interface.

This command enables or disables the transmission of Announce messages to downstream clocks if the PTP network has not yet stabilized. In some cases, it may be important for a downstream boundary clock or slave clock to know whether the PTP network has stabilized or is still “synchronization uncertain”.

To indicate the synchronization certainty state, the synchronizationUncertain flag in the Announce message is set to TRUE if the clock is in a “synchronization uncertain” state and is set to FALSE if the clock is in a “synchronization certain” state.

However, because the synchronizationUncertain flag is newly agreed upon in standards, most base station slave clocks do not look at this bit. Therefore, in order to ensure that the downstream clocks are aware of the state of the network, the PTP clock may be configured to transmit Announce and Sync messages only if the clock is in a “synchronization certain” state. This is done using the no form of this command.

This command configures whether the PTP clock will generate event messages based on system time.

To enable ToD/phase distribution capability in a master or boundary clock, select use-node-time. This allows PTP master or boundary clocks to use the node system time from GNSS or PTP. For a 7705 SAR with an active GNSS receiver port, PTP boundary clocks in use-node-time mode will function similar to a grand master clock with GNSS traceability.

This command only applies to master or boundary clocks when:

This command enables the context to configure administrative system commands. Only authorized users can execute the commands in the admin context.

This command saves existing debug configuration. Debug configurations are not preserved in configuration saves.

This command disconnects a user from a console, Telnet, FTP, SSH, SFTP, or MPT craft terminal (MCT) session.

If any of the console, Telnet, FTP, SSH, or MCT options are specified, then only the respective sessions are affected. The ssh keyword disconnects users connected to the node via SSH or SFTP.

If no console, Telnet, FTP, SSH, or MCT options are specified, then 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 will not be removed. A major severity security log event is created, specifying what was terminated and by whom.

This command displays the system’s running configuration.

By default, only non-default settings are displayed.

Specifying the detail option displays all default and non-default configuration parameters.

This command reboots the router including redundant CSMs or upgrades the boot ROMs.

If no options are specified, the user is prompted to confirm the reboot operation. For example:

If the now option is specified, no boot confirmation messages appear.

This command saves the running configuration to a configuration file. For example:

By default, the running configuration is saved to the primary configuration file.

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).

This command creates a system core dump.

If the file-url is omitted, and a ts-location has previously been defined, the tech-support file will get an automatic 7705 SAR generated filename based on the system name, date, and time, and the file will be saved to the directory indicated by the configured ts-location.

The format of the auto-generated filename is ts-xxxxx.yyyymmdd.hhmmUTC.dat, where:

Note: This command should only be used with authorized direction from the Nokia Technical Assistance Center (TAC).

This command specifies a location for the auto-generated filename that is created if the file-url parameter is not used in the tech-support command. The file is automatically assigned a name and saved to the configured location only if this ts-location command has first been configured; otherwise, the file-url parameter must be configured in the tech-support command to provide this information.The directory specified for the ts-location is not automatically created by the 7705 SAR; it must already exist.

This command upgrades the boot loader file on the system. The command checks that the new boot.ldr is a valid image and that it is at least a minimum supported variant for the hardware platform on which it is being loaded. Once this has been verified, the command overwrites the boot.ldr file that is stored on the system.

Nokia recommends that the boot loader file on all 7705 SAR platforms be upgraded using this command. This command is mandatory on all 7705 SAR platforms that do not have a removable compact flash drive and is part of a mechanism that protects the boot loader file from accidental overwrites on these platforms.

Warning: The file upgrade command takes several minutes to complete. Do not reset or power down the system, or insert or remove cards or modules, while the upgrade is in progress, as this could render the system inoperable.

Refer to the 7705 SAR OS 7.0.Rx Software Release Notes, part number 3HE10099000xTQZZA, “Standard Software Upgrade Procedure” for complete instructions.

This command enters the context to allow the user to perform redundancy operations.

This command forces a switchover to the standby CSM card. The primary CSM reloads its software image and becomes the secondary CSM.

This command specifies the location and name of the CLI script file executed following a redundancy switchover from the previously active CSM card. A switchover can happen because of a fatal failure or by manual action.

The CLI script file can contain commands for environment settings, debug settings, and other commands not maintained by the configuration redundancy.

When the file-url parameter is not specified, no CLI script file is executed.

This command performs a synchronization of the standby CSM’s images and/or config files to the active CSM. Either the boot-env or config parameter must be specified.

In the admin>redundancy context, this command performs a manually triggered standby CSM synchronization.

In the config>redundancy context, this command performs an automatically triggered standby CSM synchronization.

When the standby CSM takes over operation following a failure or reset of the active CSM, it is important to ensure that the active and standby CSMs have identical operational parameters. This includes the saved configuration and CSM images.

The active CSM ensures that the active configuration is maintained on the standby CSM. However, to ensure smooth operation under all circumstances, runtime images and system initialization configurations must also be automatically synchronized between the active and standby CSM.

If synchronization fails, alarms and log messages that indicate the type of error that caused the failure of the synchronization operation are generated. When the error condition ceases to exist, the alarm is cleared.

Only files stored on the router are synchronized. If a configuration file or image is stored in a location other than on a local compact flash, the file is not synchronized (for example, storing a configuration file on an FTP server).

This command enables the context to configure multi-chassis parameters.

This command configures a multi-chassis redundancy peer.

This command configures the authentication key used between this node and the multi-chassis peer. The authentication key can be any combination of letters or numbers.

This command configures a text description and associates it with a configuration context to help identify the content in a configuration file.

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

This command enables the context to configure multi-chassis LAG parameters.

The no form of this command administratively disables multi-chassis LAG. The no mc-lag command can only be issued only when MC-LAG is shut down.

Sets the number of keep alive intervals the standby 7705 SAR will wait for packets from the active node before assuming a redundant neighbor node failure. This delay in switchover operation is required to accommodate different factors influencing node failure detection rate, such as IGP convergence or high availability switchover times, and to prevent the standby node from take over prematurely.

The no form of the command sets this parameter to its default value.

This command sets the interval at which keepalive messages are exchanged between two systems participating in an MC-LAG. These keepalive messages are used to determine remote-node failure. The interval is set in deciseconds.

The no form of the command sets the interval to its default value.

This command defines a LAG that is forming a redundant pair for MC-LAG with a LAG configured on the given peer. The same LAG group can be defined only in the scope of one peer.

The same lacp-key, system-id, and system-priority must be configured on both nodes of the redundant pair in order for MC-LAG to become operational. If there is a mismatch, MC-LAG remains operationally down.

This command specifies the source address used to communicate with the multi-chassis peer.