5.16.  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 may 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 7450 ESS, 7750 SR, 7950 XRS, and VSR Services Overview Guide for information about ATM QoS policies and ATM-related service parameters.

This command configures system-wide ATM parameters.

This command specifies the number of seconds between periodic loopback attempts on an ATM endpoint that has periodic loopback enabled.

This command specifies the number of OAM loopback attempts that must fail after the periodic attempt before the endpoint will transition to AIS-LOC state.

The retry values are configured on a system wide basis and are affective on the next period cycle of any ATM VC SAP using periodic-loopback, if changed. The timeout for receiving a loopback response from the remote peer and declaring the loopack failed is 1 second and is not configurable.

This command specifies the number of consecutive OAM loopback attempts that must succeed after the periodic attempt before the endpoint will transition the state to up.

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

Related Commands

exec — This command executes the contents of a text file as if they were CLI 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.

Related Commands

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

This command is retained for historic reasons, and was used to control the set of features and scaling available based on the variants of IOMs present in the node. As of release 15.0, the set of supported IOMs no longer requires this differentiation using this command. The command still exists but the mode is fixed at chassis mode d.

This command creates a Common Language Location Identifier (CLLI) code string for the SR-series 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 the command removes the CLLI code.

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

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

xyz.cfg xyz.cfg.1 xyz.cfg.2 xyz.cfg.3 xyz.cfg.4 xyz.cfg.5 xyz.ndx

Each persistent index file is updated at the same time as the associated configuration file. When the index file is updated, then the save is performed to xyz.cfg and the index file is created as xyz.ndx. Synchronization between the active and standby CPM 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 default.

This command enables the context to configure cpm-http-redirect settings for enabling or disabling the optimized-mode.

This command enables the cpm-http-redirect optimized-mode. The optimized-mode improves the scale of HTTP redirect sessions supported system wide.

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

This command configures the DNS address resolving order preference. By default DNS names are queried for A-records only (address-preference is IPv4-only).

If the address-preference is set to IPv6-first, the DNS server will be queried for AAAA-records (IPv6) first and if a successful replied is not received, then the DNS server is queried for A-records. IPv6 applies only to the 7750 SR and 7950 XRS.

This command configures system Domain Name System Security Extensions (DNSSEC) settings.

This command enables validation of the presence of the AD-bit in responses from the DNS servers, and reports a warning to the SECURITY log if DNSSEC validation was not possible.

This command requires either the fall-through or drop parameters be configured. When the fall-through parameter is supplied, the system will allow DNS responses that do not pass DNSSEC validation to be accepted and logged. When the drop parameter is specified, the system will reject and log DNS responses that do not pass DNSSEC validation and the resolution will appear to fail.

This command enables vendor specific extensions to ICMP.

This command configures system-wide IP router parameters.

This command is a system-wide option that allows the creation of network interfaces on a QinQ encapsulated VLAN.

When enabled, the maximum number of allowed MPLS labels is reduced by 1 to allow for the additional VLAN tag at egress processing.

The no form of this command reverts the option to the default value, which is to not allow network interfaces on QinQ encapsulated VLANs.

This command enables the options to force the creation of IP interface indexes so that they are globally unique across all routing contexts. In addition, the command ensures that any interface created using SNMP also has a system-wide unique IP interface index.

If this command is issued but the system has previously existing interface indexes that conflict, the command will be rejected until all the conflicts are removed. Pre-existing persistency tables should also be removed before enabling this system option.

The no form of the command disables this option and returns the system to the default behavior.

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 enables the load-balancing context to configure the interface per-flow load balancing options that will apply to traffic entering this interface and egressing over a LAG/ECMP on system-egress. This is a per interface setting. For load-balancing options that can also be enabled on the system level, the options enabled on the interface level overwrite system level configurations.

This command enables the inclusion of the L2TPv2 session ID into the load-balancing hash algorithm to induce more variation and better load distribution over available links and next-hops.

The no form of this command disables the inclusion of the session-id.

This command configures system-wide Layer 4 load balancing. The configuration at the system level can enable or disable load balancing based on Layer 4 fields. If enabled, the Layer 4 source and destination port fields will be included in hashing calculation for TCP/UDP packets.

The hashing algorithm addresses finer spraying granularity where many hosts are connected to the network.

To address more efficient traffic distribution between network links (forming a LAG group), a hashing algorithm extension takes into account L4 information (that is, src/dst L4-protocol port).

The hashing index can be calculated according to the following algorithm:

This algorithm will be used in all cases where IP information in per-packet hashing is included (refer to “LAG and ECMP Hashing” in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Interface Configuration Guide). However, the Layer 4 information (TCP/UDP ports) will not be used for fragmented packets.

This command configures system-wide LSR load balancing. Hashing can be enabled on the label stack and/or IP header at an LSR for spraying labeled IP packets over multiple equal cost paths and/or over multiple links of a LAG group.

The LSR hash routine operates on the label stack and the IP header if a packet is IPv4. An LSR will consider a packet to be IPv4 if the first nibble following the bottom of the label stack is 4. The hash on label and IPv4 and IPv6 headers can be enabled or disabled at the system level or incoming network IP interface level.

This command enables enhanced egress multicast load balancing behavior for Layer 3 multicast. When enabled, the router will spray the multicast traffic using as hash inputs from the packet based on lsr-load-balancing, l4-load-balancing and system-ip-load-balancing configurations. That is, an ingress LER or IP PE will spray traffic based on the IP hash criteria: SA/DA + optional Layer 4 port + optional system IP egress LER or LSR - will spray traffic based on label or IP hash criteria outlined above or both based on configuration of lsr-load-balancing, l4-load-balancing, and system-ip-load-balancing.

The no form of the command preserves the default behavior for per flow hashing of multicast traffic.

This command enables enhanced VLL LAG service ID hashing. This command improves the LAG spraying of VLL service packets and is applied only when both ECMP and LAG hashing are performed by the same router. By default, the ECMP interface and LAG link for all packets on the VLL service are selected based on a direct modulo operation of the service ID. This command enhances distribution and hashes the service ID prior to the LAG link modulo operation when an ECMP link modulo operation is performed.

The no form of the command preserves the default behavior of VLL LAG service ID hashing.

This command enables the use of the system IP address in the ECMP hash algorithm to add a per system variable. This can help guard against cases where multiple routers, in series, will end up hashing traffic to the same ECMP/LAG path.

This command is set at a system wide basis, however if certain IOMs do not support the new load-balancing algorithm, they will continue to use the default algorithm. By default, the IPv4 system IP address is used in the hash algorithm. When no IPv4 system IP address is configured, the IPv6 system IP address, when configured, is used in the hash algorithm.

The no form of the command resets the system wide algorithm to default.

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

This command specifies the location and name of the CLI script file executed following a redundancy switchover from the previously active CPM 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 (excluding mirroring settings), and other commands not maintained by the configuration redundancy.

The following commands are not supported in the switchover-exec file: clear, configure, candidate, oam, tools, oam, ping, traceroute, mstat, mtrace and mrinfo.

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

This parameter creates or edits the context to configure intra-node port connections.

This command is used for satellites. It identifies to the SR OS that there is an internal connection between two ports.

Permitted pairings of the two ports are:

For satellites, this command configures the binding between a host port ID and the satellite uplink from the satellite chassis. The port topology can be configured with the host connected to a satellite uplink or the satellite uplink port connected to the specified host port. Both configurations are supported, as shown in the following examples:

The no form of the command removes the internal connection.

This command configures information about the type of power supply used for each power feed connection on the router chassis. The information is used to populate queries made using the show>chassis detail and show>chassis power-supply commands.

This command enables the satellite configuration context. Within the satellite context, the administrator can specify the configuration details for a satellite chassis that is hosted by the associated local system.

This command enables the specified Ethernet satellite configuration context.

The no form of the command deletes the specified Ethernet satellite.

This command enables specific satellite functionality that may have specific satellite requirements, such as software version.

The no form of this command disables the specific satellite functionality.

This command creates a local-forward instance.

A local-forward instance creates a traffic bypass within the Ethernet satellite, which allows traffic to be forwarded between satellite client ports.

The no form of this command deletes the specified local-forward instance.

This command configures a satellite access point in the local-forward instance.The no form of this command removes the satellite access point from the local-forward instance.

This command creates a new port template context to define the port usage for a specific satellite type. A port template is specific to the specified satellite type. Port templates must be configured separately using different template names for each different satellite chassis type.

The no form of this command deletes the specified port template.

This command specifies the satellite port to be reconfigured.

The no form of this command deletes the specified port configuration.

This command configures the role that the associated port is to take on.

This command configures the uplink association to be used for the associated satellite port.

This command enters the specified TDM satellite configuration context.

The no form of the command deletes the specified TDM satellite.

This command defines a description string for the associated satellite.

The no form of the command deletes the associated description string.

This command configures the MAC address for the associated satellite chassis. This MAC address is used to validate the identity of an satellite that attempts to associate with the local host.

The no form of the command deletes the MAC address for the associated satellite.

This command configures the mapping between a satellite client port and its associated uplink. This command allows both a primary and an optional secondary uplink to be configured.

If a secondary uplink is configured, it is used to forward traffic if the primary uplink is down for any reason.

Before an uplink can be used as either a primary or secondary uplink, it must be configured using the port-topology configuration command.

To return the uplink association to its default the port-map client-port-id system-default command should be used.

This command enables the ethernet satellite IEEE1588 transparent clock function. This provides increased accuracy on the PTP event messages transiting the satellite. When a IEEE1588 event message transits the ethernet satellite, the correction field of the message is updated with the residence time of that message. This is used in PTP time calculations. The ethernet satellite shall perform the transparent clock function on PTP messages with Ethernet and UDP/IP encapsulation. All ports of the satellite are enabled for this capability with the one setting. This feature must be enabled to allow the assignment of one of the satellite’s client ports as a PTP port under config>system>ptp>port. Only PTP using Ethernet encapsulation is supported from the host.

To enable this command, the satellite must have first been configured to support the feature using the config>system>satellite>eth-sat>feature transparent-clock-eth and must have been enabled for synchronous ethernet with config>system>satellite>eth-sat>sync-e.

All host ports connecting to this satellite must support 1588 port-based timestamping.

The no version of this command disables the specific satellite functionality.

This command configures the type of satellite variant for the associated satellite chassis.

The no form of the command deletes the sat-type configuration.

This command disables the associated satellite.

If the associated satellite is active, the satellite will not be reset but all satellite client ports will be shut down.

If the satellite is not active but attempts to associate with the host, the satellite chassis will be brought up according to the satellite configuration but all client ports will be shut down.

The no form of this command removes the shutdown state and all client ports on active satellites will be brought back up.

This command binds the specified software repository to the associated satellite. The software repository is used to locate and serve the correct software image to the satellite at boot time.

The configured software repository is only used when the satellite boots. Changing the software repository for an active satellite does not have an effect until the next time a satellite boots.

A satellite cannot be booted if there is no software repository defined for it.

The no form of the command removes the software repository.

This command enables the Ethernet satellite for synchronous Ethernet operation so that the transmit timing of the satellite access ports use the frequency of the host router’s central clock.

To enable this functionality, both host ports on the router that connect to the U1 and U2 ports of the satellite must be synchronous Ethernet-capable ports.

When the Ethernet satellite is configured for synchronous Ethernet, ESMC frames are enabled on the host ports. The SSM code-type used between the host and the satellite should be manually configured on the host ports to match the code-type desired on the satellite client ports. The code-type setting on the host ports does not restrict the code-type used on the satellite client ports, as those may be configured on an individual port basis.

This command creates or deletes an instance of a software repository. The instance is identified by a repository name.

A software repository is used to obtain files to upgrade software on certain subsystems of the router (for example, Ethernet satellites).

Up to three locations can be specified within a software repository for the router to access files in the repository. The router will first attempt to access the file at the primary location. If the primary location is not configured or the files are not found at the primary location, then the router will attempt to access the files at the secondary location. If the secondary location is not configured or the files are not found at the secondary location, then the router will attempt to access the files at the tertiary location. If the tertiary location is not configured or the files are not found at the tertiary location, then the software repository access will fail.

The no form of the command removes the software repository.

This command defines a description string for the software repository.

The no form of the command deletes the associated description string.

This command configures the primary location for the files in the software repository. See the software-repository command description for more information.

The no form of the command removes the primary location.

This command configures the secondary location for the files in the software repository. See the software-repository command description for more information.

The no form of the command removes the secondary location.

This command configures the tertiary location for the files in the software repository. See the software-repository command description for more information.

The no form of the command removes the tertiary location.

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.

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

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.

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.

This command enables the context for configuring Bluetooth console attributes.

When the power is enabled, this timer controls the amount of time the Bluetooth device will advertise that is ready to pair. If an external device does not complete the pairing within this time, then the pairing must be re-initiated.

The no form of this command disables the timeout.

This command is used to add and remove devices from the Bluetooth whitelist or to enter the context to configure the MAC. The router only accepts pairing requests with devices that are in the whitelist. The devices are identified through their IEEE 802 MAC addresses. There can be up to six devices defined in the whitelist.

The create keyword must be used to add a new device.

The no form of this command removes the indicated device from the whitelist.

This command creates a text description for a configuration context to help identify the content in the configuration file.

The no form of this command removes any description string from the context.

This command enters the context to define Bluetooth parameters for the specific CPM slot.

This command defines an identifier string to be used to advertise the Bluetooth module during pairing operations.

If there is no identifier specified by the user, the default is derived from the platform type, the CPM slot, and the serial number of the chassis.

For example, a device with a platform field of 7750, SR-12 chassis, and a CPM serial number of NS23456 would have a Bluetooth identifier of "7750-SR-12-CPM-A-NS23456." for the CPM in slot A.

The no form of the command resets the identifier back to the default.

This command is used to allow or block the function of the pairing button. This can be used to block the accidental triggering of a pairing operation while there is already a paired device.

The actual behavior of the Bluetooth pairing is dependent on both this command and the power command.

If normal operation is to use the pairing button on the router and on the external device to initiate the Bluetooth connection, then set:

     config>system>bluetooth>power enabled-manual

     config>system>bluetooth>pairing-button enable

If normal operation is to only require the pairing to be initiated by the external device, then set:

     config>system>bluetooth>power enabled-automatic

     config>system>bluetooth>pairing-button disable

If normal operation is to not allow the local operator to connect without permission from the central management location, then set:

     config>system>bluetooth>power enabled-manual

     config>system>bluetooth>pairing-button disable

Then when a connection is desired, the central management station must change the configuration to one of the two options shown above for the time the local operator is connecting. The central management station can change the setting back to block local access after the operations is complete.

This command is used to define the Bluetooth pass key that is used during paring. This passkey must match in both devices attempting the pairing operation.

This command sets the operating mode of the Bluetooth module. This can be powered off or powered on but requires the pairing button to initiate the pairing operation, or powered on and continuously pairing.

The pairing-button setting also impacts how pairing operations work.

This command sets the desired capability for the associated slot and card. The capability is used along with mixed-mode to enable additional features on certain cards and slots.

By default, the capability will be set to that of the base chassis type. To set this to a non-default value, the mixed-mode command must be enabled at the system level.

Changing the capability of a slot or card will result in the associated slot being reset. The card-type must first be configured before the capability command can be issued.

This command enables chassis support for features with a mixture of IOMs and IMMs.

The no form of the command disables mixed mode support.

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

The persistence feature enables state on information learned through DHCP snooping across reboots to be retained. This information includes data such as the IP address and MAC binding information, lease-length information, and ingress sap information (required for VPLS snooping to identify the ingress interface).

If persistence is enabled when there are no DHCP relay or snooping commands enabled, it will simply create an empty file.

This command configures ANCP persistence parameters.

This command configures application assurance persistence parameters.

This command configures DHCP server persistence parameters.

This command configures NAT port forwarding persistence parameters.

This command enables the CLI context to configure persistence options parameters.

This command configures Dynamic Data Persistence (DDP) compact flash access optimization for DHCP leases.

The DHCP lease-time threshold controls the eligibility of a DHCP lease for persistency updates when no data other than the lease expiry time is to be updated. When the offered lease time of the DHCP lease is less than the configured threshold, the lease is flagged to skip persistency updates and will be installed with its full lease time upon a persistency recovery after a reboot.

The dhcp-leasetime-threshold command controls persistency updates for DHCPv4 and DHCPv6 leases for a DHCP relay or proxy and DHCPv4 leases for DHCP snooping (enabled with subscriber-mgmt) and a DHCP server (enabled with dhcp-server).

The no form of the command disables the DHCP lease time threshold.

This command configures Python policy cache persistency parameters.

This command configures subscriber management persistence parameters.

This command instructs the system where to write the persistency files for the corresponding application. Each application creates two files on the flash card, one with suffix .i<version>, referencing an index file, and the other with suffix .0<version>, where <version> is a 2-digit number reflecting the file version. These versions are not related to the SROS release running on the node. The <version> can remain the same over two major releases, for example, when no format change is made to the persistency file. On boot, the system scans the file systems looking for the corresponding persistency files, and the load begins.

For example, in the subscriber management context, the location specifies the flash device on a CPM card where the data for handling subscriber management persistency is stored.

The no form of this command returns the system to the default. If there is a change in file location while persistence is running, a new file will be written on the new flash, and then the old file will be removed.

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

This command is only available on the control assemblies that support 1588.

This command configures the announceReceiptTimeout value for all peer associations. This defines the number of Announce message intervals that must expire with no received Announce messages before declaring an ANNOUNCE_RECIPT_TIMEOUT event.

The announce-rx-timeout cannot be changed unless PTP is shut down.

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

The clock-type cannot be changed to ordinary master if the PTP reference is no shutdown. In addition, the clock-type cannot be changed to ordinary master if there are peers configured. The clock-type is restricted based on the profile. See the profile command description for the details of the restrictions.

This command configures the PTP domain.

The no form of the command reverts to the default configuration. The default value is dependent upon the configured profile, as detailed below.

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

Domain cannot be changed unless PTP is shutdown. 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 either g8265dot1-2010 or g8275dot1-2014. The parameter is ignored when any other profile is selected.

The value 1 is the highest priority and 255 is the lowest priority. The priority of a peer cannot be configured if the PTP profile is ieee1588-2008.

For g8265dot1-2010, this parameter configures the priority used to choose between master clocks with the same quality (refer to G.8265.1 for more details).

For g8275dot1-2014, this parameter 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). Refer to G.8275.1 for detailed information.

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

For unicast messages, it 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, used on PTP Ethernet ports, this 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.

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

Note: In order to minimize BMCA driven reconfigurations, the IEEE recommends that the announce-interval should be consistent across the entire 1588 network.

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 Table 1/G.8265.1. This setting only applies to the range of values observed in the clockClass values transmitted out of the node in Announce messages. The router will support the reception of any valid value in Table 1/G.8265.1

This command configures a remote PTP peer. It provides the context to configure parameters for the remote PTP peer.

Up to 20 remote PTP peers may be configured.

The no form of the command deletes the specified peer.

If the clock-type is ordinary slave or boundary, and PTP is no shutdown, the last peer cannot be deleted. This prevents the user from having PTP enabled without any peer configured and enabled.

Peers are created within the routing instance associated with the context of this command. All configured PTP peers must use the same routing instance.

This command configures the message interval used for unicast event messages. It defines the message interval for both Sync and Delay_Resp messages that are requested during unicast negotiation to the specific peer. This controls the Sync and Delay_Resp message rate sent from remote peers to the local node. It does not affect the Sync or Delay_Resp packet rate that may be sent from the local node to remote peers. Remote peers may request a Sync or Delay_Resp packet rate anywhere within the acceptable grant range.

The log-sync-interval cannot be changed unless the peer is shutdown.

This command disables or enables a specific PTP peer. Shutting down a peer sends cancel unicast negotiation messages on any established unicast sessions. When shutdown, all received packets from the peer are ignored.

If the clock-type is ordinary slave or boundary, and PTP is no shutdown, the last enabled peer cannot be shutdown. This prevents the user from having PTP enabled without any peer configured & enabled

This command specifies an upper limit to the number of discovered peers permitted within the routing instance. This can be used to ensure that a routing instance does not consume all the possible discovered peers and blocking discovered peers in other routing instances.

If it is desired to reserve a fixed number of discovered peers per router instance, then all router instances supporting PTP should have values specified with this command and the sum of all the peer-limit values must not exceed the maximum number of discovered peers supported by the system.

If the user attempts to specify a peer-limit, and there are already more discovered peers in the routing instance than the new limit being specified, the configuration will not be accepted.

This command configures PTP over Ethernet on the physical port. The PTP process shall transmit and receive PTP messages through the port using Ethernet encapsulation (as opposed to UDP/IPv4 encapsulation).

The frames are transmitted with no VLAN tags even if the port is configured for dot1q or qinq modes for encap-type. In addition, the received frames from the external PTP clock must also be untagged.

There are two reserved multicast addresses allocated for PTP messages (see Annex F IEEE Std 1588™-2008). Either address can be configured for the PTP messages sent through this port.

A PTP port may not be created if the PTP profile is set g8265dot1-2010.

If the port specified in the port-id supports 1588 port based timestamping, then a side effect of enabling PTP over Ethernet on the port shall be the enabling of Synchronous Ethernet on that port.

De-provisioning of the card or MDA containing the specified port is not permitted while the port is configured within PTP.

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 allocate an ethernet satellite client port as a PTP port, the ethernet satellite must first be enabled for the transparent clock function. For more information, see the ptp-tc command.

This command allows for the specification of the mac-address to be used for the destination MAC address of the transmitted ptp messages.

IEEE Std 1588-2008 Annex F defines two reserved addresses for 1588 messages. These are:

Both addresses are supported for reception independent of the address configured by this command.

The no form of this command sets the address to the default address.

This command configures the minimum interval used for multicast Delay_Req messages. This parameter is applied on a per port basis. For ports in a slave state, it shall be the interval used, unless the parent port indicates a longer interval. For a port in master state, it shall be the interval advertised to external slave ports as the minimum acceptable interval for Delay_Req messages from those slave ports.

It is a requirement of the 1588 standard that a port in Slave state shall check the logMessageInterval field of received multicast Delay_Resp messages. If the value of the logMessageInterval field of those messages is greater than the value programmed locally for the generation of Delay_Req messages, then the Slave must change to use the greater value (i.e. longer interval) for the generation of Delay_Req messages. This requirement is supported in the router.

The parameter is only applicable to ports and not to peers.

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

For multicast messages used on PTP Ethernet ports, this configures the message interval used for Sync messages transmitted by the local node when the port is in Master state.

This command is used to restrict the local port to never enter the slave state. Use the command to ensure that the 7750 SR never draws synchronization from the attached external device.

This parameter is only effective when the profile is set to g8275dot1-2014.

Note: The ITU-T G.8275.1 (07/2014) recommendation used the term 'notSlave' for this functionality; however, the IEEE has added this capability into the next edition of the 1588 standard using the term masterOnly. These are equivalent.

This command disables or enables a specific PTP port. When shutdown, all PTP Ethernet messages are dropped on the IOM They will not be 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 no shutdown, the last enabled port or peer cannot be shutdown. This prevents the user from having PTP enabled without any means to synchronize the local clock to a parent clock.

This command configures the priority1 value of the local clock. This parameter is only used when the profile is set to ieee1588-2008. This value is used by the Best Master Clock Algorithm to determine which clock should provide timing for the network.

This value is used for the value to advertise in the Announce messages and for the local clock value in data set comparisons.

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

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. The parameter is ignored when any other profile is selected.

This value is used by the Best Master Clock algorithm to determine which clock should provide timing for the network.

Note: This value is used for the value to advertise in the Announce messages and for local clock value in data set comparisons.

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

This command configures the profile to be used for the internal PTP clock. It defines the Best Master Clock Algorithm (BMCA) behavior.

The profile cannot be changed unless PTP is shutdown.

When you change the profile, the domain changes to the default value for the new profile. The clock-type is restricted based on the profile. If the profile is ieee1588-2008, then the clock-type is not restricted. If the profile is g8265dot1-2010, then the clock type may only be ordinary slave or ordinary master; boundary clock is not allowed. If the profile is g8275dot1-2014, then the clock-type may only be boundary clock or ordinary slave; ordinary master is not allowed.

When you change the profile, if any of the command parameters are set to default for the original profile, then the parameter will be changed to the default for the new profile. This applies to the following:

If the parameter is set to a value other than the default for the original profile, then its value will remain unchanged

This command disables or enables the PTP protocol. If PTP is disabled, the router will not transmit any PTP packets, and will ignore all received PTP packets. If the user attempts execute a no shutdown command on hardware that does not support PTP, an alarm will be raised to indicate limited capabilities.

When PTP is shutdown, the PTP slave port is not operational. It shall not be considered as a source for system timing.

On assemblies supporting a 1 PPS output interface, this command controls the presentation of a signal on that interface. When PTP is enabled, the 1 PPS port is enabled, and it generates a pulse whose rising edge represented the second rollover of the internal PTP time scale (that is, whenever the fractional second of the time is exactly zero). When PTP is disabled, no signal is presented on the 1 PPS interface.

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 sets the preference to use local or UTC time in the system. This preference is applied to objects such as log file names, created and completed times reported in log files, and rollback times displayed in show routines.

Note: The format used for the date-time strings may change when the prefer-local-time option is enabled. For example, when enabled, all date-time strings include a suffix of three to five characters that indicates the timezone used for the presentation. This suffix may not be present if the option in not enabled.

Note: The time format for timestamps on log events is controlled on a per-log basis using the config>log>log-id>time-format {utc | local} CLI command and not via prefer-local-time. Also an operator may force the timezone used for show outputs during a CLI session using an environment variable in the environment>time-display {utc | local} command.

The no form of this command indicates preference for UTC time.

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 specified subnet. This command configures a specific interface to listen for broadcast NTP messages. The interface may exist within a VPRN service.

Broadcast and multicast messages can easily be spoofed, so authentication is strongly recommended. If broadcast is not configured, then any 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 interface 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.

This command configures symmetric active mode for an NTP peer. It is recommended to configure authentication and to only configure known time servers as peers. Peers may exist within a VPRN service.

Note: For symmetric peering to operate correctly with a peer accessible through a VPRN, local NTP server functionality must be enabled within the VPRN using the config>service>vprn>ntp command.

The no form of the command removes the configured peer.

This command configures the node to operate in client mode with the NTP server specified in the address field of this command.

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. After PTP has established a UTC traceable time from an external grandmaster then it will 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, which may impact the NTP network topology.

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