6.12.  System Command Reference

Note: The config>redundancy>multi-chassis>peer and config>redundancy>multi-chassis>peer>mc-lag contexts are not supported on 7210 SAS platforms configured in the access-uplink operating mode

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.

Note: The config>redundancy>multi-chassis>peer context is not supported on 7210 SAS platforms configured in the access-uplink operating mode

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

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

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.

This command allows the users to configure the type of IMM they plan to use with the chassis. On the 7210 SAS-R6, a mix of IMMv1 and IMMv2 is not allowed to be used in the same chassis. In other words, the user can populate the chassis with either all IMMv1 IMMs or with all IMMv2 IMMs. The type of IMM planned to be used in a chassis needs to be configured up-front, so that on system boot, the software can allocate appropriate resources based on the IMM type.

The software checks that the IMMs provisioned (and equipped) in the chassis is a member of the IMM family type currently configured (active value) by the user. If the user provisioned IMM does not match the IMM types allowed, the software detects a errors in provisioning mismatch and marks the operational state of the IMM to be down.

Note: The chassis by default will support IMMv1 family (that is, 1st generation of 7210 SAS-R6 IMMs). The default profile of the chassis remains the same, unless modified by the user. The user can add in support for any IMM family type by repeated execution of this command. IMM Family type will be added, only if the current supported family types are compatible with each other, else an error is returned. In other words, if the user specifies both IMMv1 and IMMv2 the command errors out when the user executes the command to add the IMM family IMMv2. A change in the current value of IMM family requires a reboot of the node to take effect. therefore, the user configured value for IMM family type takes effect only after the next reboot.

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

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

For example, assume 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, 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 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 this 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 this command reverts to the default value.

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.

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.

This command enables the context to configure login control.

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.

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 form of the command can be executed.

This command enables the context to configure hold time information.

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.

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.

This command enables the context to configure the shelf information for 1830 VWM clip-on device.

The user must create the VWM clip-on device and provision the shelf ID to allow the 7210 SAS software to communicate with the shelf and retrieve information. The value specified in the vwm-shelf-id parameter must match the shelf ID set using the rotary dial on the clip-on device. If these shelf IDs do not match, the 7210 SAS devices will not be able to interact to the device and does not provide any information about the device. The software cannot detect a mismatch between the value of the configured vwm-shelf-id and the shelf ID set on the rotary dial.

In prior releases, the software allows user to configure only a single clip-on device for management by specifying a single shelf ID. The software does not allow for configuration of more than a single clip-on shelf.

A fixed number of 1830 VWM devices can be managed by the 7210 SAS devices. The limit depends on the interface used to connect to the 1830 device. The user must provision all the shelves that are connected to the 7210 SAS device.

The no form of this command removes the configured shelf ID and the software removes all the information it has for the shelf.

This command enables the context to configure the shelf information for 1830 VWM clip-on device.

The user must create the VWM clip-on device and provision the shelf ID to allow the 7210 SAS software to communicate with the shelf and retrieve information. The value specified in the vwm-shelf-id parameter must match the shelf ID set using the rotary dial on the clip-on device. If these shelf IDs do not match, the 7210 SAS devices will not be able to interact to the device and does not provide any information about the device. 7210 SAS software cannot detect a mismatch between the value of the configured vwm-shelf-id and the shelf ID set on the rotary dial.

A fixed number of 1830 VWM devices can be managed by the 7210 SAS devices. The limit depends on the interface used to connect to the 1830 device. The user must provision all the shelves that are connected to the 7210 SAS device.

The vmw-type enables the context to configure the shelf type information for 1830 VWM clip-on device. The user must provision the shelf-type of the connected 1830 device. The software uses this information to match with the shelf-type retrieved from the device and raise a trap/event when there is a mismatch and marks the shelf as operationally down. Additionally, in a cascaded configuration, if there is a mismatch in provisioning of the shelf, the 7210 SAS does not attempt to retrieve information of the shelves that follow the mis-configured shelf.

The no form of this command removes the configured shelf ID and the software removes all the information it has for the shelf.

This command enables the context to provision the information for the modules that can be plugged into the slots on the 1830 VWM clip-on device.

This command provides the user better control over the modules plugged into the 1830 CWDM device slots. The user can preprovision acceptable modules by configuring the card-type parameter with the appropriate vwm-acronym. Modules are identified using the card type acronyms listed in Table 42 and Table 43.

The no form of this command removes the configured card ID and the software forgets all the information it has for the card. The software will not raise any events/traps/alarms for the card and clear all pending events/traps/alarms/LEDs.

This command administratively disables the management of the clip-on device identified by the parameter vwm-shelf-id. When this command is executed, the software will clear all pending events/traps/alarms related to this shelf.

The no form of this command administratively enables the management of the clip-on device. The software raises appropriate events/traps/alarms for the device.

This command provides the user a better control over the modules plugged into the 1830 CWDM device slots. The user can preprovision acceptable modules by configuring the card-type parameter with the appropriate card-type vwm-acronym. The modules are identified using the acronyms listed below.

The 7210 SAS validates the configured card-types with the card-type acronym retrieved from the clip-on device and checks the following.

If the user set the card to administratively up and the module is missing, the 7210 SAS raises an event/trap. The event results in a major alarm with the major LED set to the appropriate color. If the user has preprovisioned the card and administratively shut it down, the software does not attempt to match the module’s identifier (if the module is equipped in the slot) and clears any pending alarms. The software retrieves any information about the equipped module to aid the user with provisioning.

The no form of this command removes and clears the card-type information. Until the card-type is provisioned, the software does not raise any events/traps/alarms for the card and clears all pending events/traps/alarms/LEDs.

Table 42 lists the acronyms defined by the optical group. For more information, see the Product overview guide for 1830 VWM. This is used to preprovision the acceptable modules that can be equipped in the slots of the clip-on device.

This command allows the user to administratively disable the management of a specific module inserted in a slot on the clip-on device. When this command is executed, the 7210 SAS software clears all pending events/traps/alarms/LED related to this card.

The no form of this command allows the user to administratively enable the management of the card on the clip-on device. The software raises appropriate events/traps/alarms for the card.

This command enables the context to configure VC parameters.

This command configures an IMM-only node in a virtual chassis (VC) configuration. This command is performed on the active CPM node in the VC to which the IMM-only node belongs.

An IMM-only node in a VC is identified by its slot-number and its MAC address. The slot number assigned to the node can be an arbitrary number from 1 to 8. It is used in service provisioning to identify ports on a VC member node, and on service objects on those ports. The port on a VC member node is identified using the format slot-id/1/port-id. For example, port 20 on the front panel of a VC member node in slot 4 is identified as 4/1/20; SAPs configured on those ports are identified as 4/1/20:300.

Slot numbers are unique to each VC which are identified by their vc-stack-node, and can be reused across different VCs. The software ensures the uniqueness of the slot number in each VC by raising an error if two nodes in the same VC are assigned the same slot number.

The MAC address used for VC configuration is the chassis MAC address printed on the label of the node. The MAC address of the IMM-only node is also visible using the console connection.

When an IMM-only node boots up, it uses the MAC address and slot number received in the VC discovery messages sent by the CPM node so that it can boot up in VC mode.

The no form of this command removes the IMM-node from the VC.

This command configures a MAC address for a VC. This command provides an option to assign a MAC address other than the chassis MAC belonging to the CPM-A node. By assigning the MAC address instead of using the chassis MAC address belonging to the CPM-A node, operators do not need to change the MAC address when the CPM-A card is physically replaced with another card.

The no form of this command reverts the value to the default MAC address specified in the BOF.

This command enables the context to configure monitoring thresholds.

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

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

This command configures memory usage, in kilobytes, for warning 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 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 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.

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

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

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.

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

This command enables the context to configure parameters for IEEE 1588-2008, Precision Time Protocol.

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.

This command enables the context to configure the source of frequency reference for PTP.

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

If the frequency reference is set to ssu, PTP is running in hybrid mode (if PTP is also in a no shutdown state), using the recovered frequency provided by the central clock through either of the configured references (SyncE or BITS, whichever is configured as a reference for the central clock). When this parameter is set to ssu, PTP cannot be configured as a reference in the ref-order. The CLI will block 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 is running in pure mode, potentially being configured as a frequency reference in ref-order.

Note: See Configuration Guidelines and Restrictions for PTP for information on the restrictions when using this command.

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

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

When changing the clock-type to or from a boundary clock on the 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Mxp, and 7210 SAS-T platforms, the node must be rebooted for the change to take effect. Ensure that measures are taken to minimize service disruption during the reboot process.

This command configures the PTP domain.

The no form of this command reverts to the default configuration.The default value is dependent on the configured profile.

The domain cannot be changed unless PTP is shut down.

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

This command configures the local priority used to choose between PTP masters in the best master clock algorithm (BMCA). 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 master clocks with the same quality.

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

This command configures the PTP Announce interval.

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

This command configures the message interval used for transmission of multicast synchronization messages.

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.

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

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

This command configures the codeset to be used for the encoding of 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 configuration 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.

This command enables the context to configure parameters associated with remote PTP peers.

Up to 20 remote PTP peers can be configured.

The no form of this command deletes the specified peer.

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.

This command disables or enables a specific PTP peer. Shutting down a peer sends cancel unicast negotiation messages on any established unicast sessions. When 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.

This command configures 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, as defined in Annex F IEEE Std 1588-2008 (see 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.

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

This command configures the MAC address to be used as the multicast destination MAC address for transmitted PTP messages.

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

The IEEE Std 1588-2008 Annex F defines two reserved addresses for PTP messages:

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

This command prevents the local port from ever entering the slave state. This can be used to ensure that the 7210 SAS never draws synchronization from the attached external device.

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

If the clock-type command is set to ordinary slave, the master-only value is set the false.

This command disables or enables a specific PTP port. When 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 only applies if the profile is set to g8275dot1-2014.

This command configures the priority1 value of the local clock. This parameter is only used when the profile is set to ieee1588-2008 or This command configures the priority1 value of the local clock. The command applies only if the profile is set to ieee1588-2008. 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.This value is used by the BMCA to determine which clock should provide timing for the network

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

This command configures the priority2 value of the local clock. This parameter is only used when the profile is set to ieee1588-2008 or g8275dot1-2014. 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.

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

This command configures the profile to be used for the internal PTP clock. This principally defines the BMCA 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. A change of profile requires a reboot of the node on some 7210 SAS platforms. See Configuration Guidelines and Restrictions for PTP for more information.

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.