5.16.  System Command Reference

5.16.1. Command Hierarchies

5.16.1.2. System Information Commands

config
— system
atm
atm-location-id location-id
oam
loopback-period period
retry-down retries
— no retry-down
retry-up retries
— no retry-up
boot-bad-exec file-url
boot-good-exec file-url
chassis-mode chassis-mode [force]
clli-code clli-code
— no clli-code
config-backup count
contact contact-name
— no contact
coordinates coordinates
dns
address-pref {ipv4-only | ipv6-first}
dnssec
ad-validation {fall-through | drop}
[no] ad-validation
ip
lacp-system-priority lacp-system-priority
lsr-load-balancing hashing-algorithm
location location
— no location
name system-name
— no name
port port-id to port-id [create]
— no port port-id
power-supply power-supply-id type
software-repository repository-name [create]
— no software-repository repository-name
description description-string
— no description
primary-location file-url
secondary-location file-url
tertiary-location file-url

5.16.1.3. Satellite Commands

config
— system
eth-sat sat-id [create]
— no eth-sat sat-id
description description-string
— no description
[no] feature feature-name
mac-address mac-address
port-map client-port-id primary primary-uplink-port-id [secondary secondary-uplink-port-id]
port-map client-port-id system-default
[no] ptp-tc
sat-type sat-type [port-template template-name]
— no sat-type
[no] shutdown
software-repository repository-name
[no] sync-e
local-forward local-forward-id [create]
— no local-forward local-forward-id
description description-string
— no description
sap sap-id create]
— no sap sap-id
description description-string
— no description
[no] shutdown
port-template template-name sat-type sat-type [create]
— no port-template template-name
description description-string
port port-id
role role-type
uplink port-id
uplink system-default
uplink none
[no] shutdown
tdm-sat sat-id [create]
— no tdm-sat sat-id
description description-string
— no description
mac-address mac-address
sat-type sat-type
— no sat-type
[no] software-repository repository-name
[no] shutdown

5.16.1.4. System Alarm Contact Input Commands

config
— system
alarm-contact-in-power {on | off}
alarm-contact-input input-pin-number
clear-alarm-msg message-string
description description-string
normal-state {open | closed}
[no] shutdown
trigger-alarm-msg message-string

5.16.1.5. System Threshold Alarm Commands

config
— system
thresholds
cflash-cap-alarm cflash-id rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
— no cflash-cap-alarm cflash-id
cflash-cap-alarm-pct cflash-id rising-threshold percentage [falling-threshold percentage] interval seconds [rmon-event-type event-type] [startup-alarm alarm-type]
— no cflash-cap-alarm-pct cflash-id
cflash-cap-warn cflash-id rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
— no cflash-cap-warn cflash-id
cflash-cap-warn-pct cflash-id rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type rmon-event-type] [startup-alarm alarm-type]
— no cflash-cap-warn-pct cflash-id
kb-memory-use-alarm rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
kb-memory-use-warn rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
memory-use-alarm rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
memory-use-warn rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
[no] rmon
alarm rmon-alarm-id variable-oid oid-string interval seconds [sample-type] [startup-alarm alarm-type] [rising-event rmon-event-id rising-threshold threshold] [falling-event rmon-event-id falling-threshold threshold] [owner owner-string]
— no alarm rmon-alarm-id
event rmon-event-id [event-type] [description description-string] [owner owner-string]
— no event rmon-event-id

5.16.1.6. System Bluetooth Commands

config
— system
advertising-timeout seconds
device ieee-address [create]
— no device ieee-address
description description-string
— no description
module cpm-slot
identifier identifier
— no identifier
pairing-button admin-state
passkey pass-key
power power-state

5.16.1.7. Mixed Mode Configuration Commands

Note:

The commands listed in this section apply only to the 7450 ESS.

config
— card
capability {sr | ess} [now]
config
system
[no] mixed-mode

5.16.1.8. Persistence Commands

Note:

The commands in this section only apply to the 7750 SR.

config
— system
ancp
description description-string
location cflash-id
no location
description description-string
location cflash-id
no location
description description-string
location cflash-id
no location
description description-string
location cflash-id
no location
dhcp-leasetime-threshold [days days] [hrs hours] [min minutes] [sec seconds]
description description-string
location cflash-id
no location
description description-string
location cflash-id
no location

5.16.1.9. PTP Commands

Note:

The commands in this section apply to the 7450 ESS and 7750 SR, except the 7750 SR-1e, 7750 SR-2e, and 7750 SR-3e.

config
— system
ptp
anno-rx-timeout count
clock-type boundary
clock-type ordinary {master | slave}
domain domain-value
— no domain
local-priority priority
log-anno-interval log-interval
network-type {sdh | sonet}
peer ip-address [create]
— no peer ip-address
local-priority local-priority
log-sync-interval log-interval
[no] shutdown
peer-limit limit
— no peer-limit
port port-id [create]
— no port port-id
address {01:1b:19:00:00:00 | 01:80:c2:00:00:0e}
local-priority priority
log-delay-interval log-interval
log-sync-interval log-interval
master-only {true | false}
[no] shutdown
priority1 priority-value
— no priority1
priority2 priority-value
— no priority2
profile {g8265dot1-2010 | ieee1588-2008 | g8275dot1-2014}
[no] shutdown

5.16.1.10. System Time Commands

— admin
set-time date time
config
— system
time
[no] dst-zone {std-zone-name | non-std-zone-name}
end end-week end-day end-month hours-minutes
offset offset
start start-week start-day start-month hours-minutes
[no] ntp
authentication-key key-id key key [hash | hash2] type {des | message-digest}
— no authentication-key key-id
broadcast [router router-name] {interface ip-int-name} [key-id key-id] [version version] [ttl ttl]
— no broadcast [router router-name] {interface ip-int-name}
broadcastclient [router router-instance | service-name service-name] {interface ip-int-name} [authenticate]
— no broadcastclient [router router-instance | service-name service-name] {interface ip-int-name}
multicast [key-id key-id] [version version]
— no multicast
multicastclient [authenticate]
ntp-server [authenticate]
— no ntp-server
peer [router router-instance | service-name service-name] {ip-address | ipv6-address} [key-id key-id] [version version] [prefer]
— no peer [router router-instance | service-name service-name] {ip-address | ipv6-address}
server [router router-instance | service-name service-name] {ip-address | ipv6-address | ptp} [key-id key-id] [version version] [prefer]
— no server [router router-instance | service-name service-name] {ip-address | ipv6-address | ptp}
[no] shutdown
[no] sntp
server-address ip-address [version version-number] [normal | preferred] [interval seconds]
— no server-address ip-address
[no] shutdown
zone {std-zone-name | non-std-zone-name} [hh [:mm]]
— no zone

5.16.1.11. Cron Commands

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

5.16.1.12. Script Control Commands

config
— system
[no] script script-name [owner script-owner]
description description-string
location file-url
— no location
[no] shutdown
[no] script-policy policy-name [owner policy-owner]
expire-time {seconds | forever}
lifetime {seconds | forever}
max-completed unsigned
results file-url
— no results
script script-name [owner script-owner]
— no script
[no] shutdown

5.16.1.13. System Synchronization Commands

config
system
abort
begin
bits
input
[no] shutdown
interface-type {ds1 [{esf | sf}] | e1 [{pcm30crc | pcm31crc}]}
output
line-length {110 | 220 | 330 | 440 | 550 | 660}
ql-minimum {prs | stu | st2 | tnc | st3e | st3 | prc | ssua | ssub | sec | eec1 | eec2}
— no ql-minimum
[no] shutdown
source {line-ref | internal-clock}
[no] squelch
ql-override {prs | stu | st2 | tnc | st3e | st3 | prc | ssua | ssub | sec}
ssm-bit sa-bit
commit
ptp
ql-override {prs | stu | st2 | tnc |st3e | st3 | prc | ssua | ssub | sec}
[no] shutdown
ql-minimum {prs | stu | st2 | tnc | st3e | st3 | prc | ssua | ssub | sec | eec1 | eec2}
— no ql-minimum
[no] ql-selection
ref-order first second [third [fourth]]
— no ref-order
ref1
bits-interface-type {ds1 [{esf | sf}] | e1 [{pcm30crc | pcm31crc}]}
ql-override {prs | stu | st2 | tnc | st3e | st3 | prc | ssua | ssub | sec | eec1 | eec2}
[no] shutdown
source-bits slot/mda
source-port port-id
ssm-bit sa-bit
ref2
bits-interface-type {ds1 [{esf | sf}] | e1 [{pcm30crc | pcm31crc}]}
ql-override {prs | stu | st2 | tnc | st3e | st3 | prc | ssua | ssub | sec | eec1 | eec2}
[no] shutdown
source-bits slot/mda
source-port port-id
ssm-bit sa-bit
[no] revert
wait-to-restore minutes

5.16.1.14. System Administration (Admin) Commands

— admin
group aa-group-id
url-list url-list-name upgrade
debug-save [file-url]
disconnect [address ip-address | session-id session-id | username user-name | {console | bluetooth | telnet | ftp | ssh | netconf | grpc}]
display-config [detail | index]
[no] enable-tech
nat
reboot [active | standby | upgrade] [hold] [now]
force-switchover [now] [ignore-status]
synchronize cert
synchronize {boot-env | config}
satellite [eth-sat sat-id] reboot [upgrade] [now]
satellite [eth-sat sat-id] [sync-boot-env]
satellite [eth-sat sat-id] [tech-support file-url]
save [file-url] [detail] [index]
tech-support [file-url]
admin
system
activate [file-url] [now]
validate [file-url]
config
— system
— security
— tech-support
ts-location file-url

5.16.1.15. High Availability (Redundancy) Commands

— admin
display-config [detail |index]
force-switchover [now] [ignore-status]
synchronize cert
synchronize {boot-env | config}
config
system
switchover-exec file-url
boot-timer seconds
boot-timer seconds
— no boot-timer
site-min-down-timer min-down-time
[no] cert-sync
mgmt-ethernet [revert seconds]
peer ip-address [create]
— no peer ip-address
authentication-key [authentication-key | hash-key] [hash | hash2]
description description-string
[no] mc-endpoint
[no] bfd-enable
boot-timer interval
no boot-timer
keep-alive-interval interval
[no] passive-mode
[no] shutdown
system-priority value
[no] mc-lag
keep-alive-interval interval
lag lag-id lacp-key admin-key system-id system-id [remote-lag remote-lag-id] system-priority system-priority source-bmac-lsb use-lacp-key
lag lag-id lacp-key admin-key system-id system-id [remote-lag remote-lag-id] system-priority system-priority source-bmac-lsb MAC-Lsb
lag lag-id lacp-key admin-key system-id system-id [remote-lag remote-lag-id] system-priority system-priority
lag lag-id [remote-lag remote-lag-id]
— no lag lag-id
[no] shutdown
peer-name name
no peer-name
[no] shutdown
source-address ip-address
[no] sync
[no] igmp
[no] igmp-snooping
[no] ipsec
[no] l2tp
[no] mc-ring
[no] mld-snooping
pim-snooping [saps] [spoke-sdps]
[no] pim-snooping
port port-id [sync-tag sync-tag] [create]
no port port-id
range encap-range sync-tag sync-tag
no range encap-range
[no] python
sdp sdp-id [sync-tag sync-tag] [create]
[no] sdp sdp-id
range vc-id-range sync-tag sync-tag
[no] range vc-id-range
[no] shutdown
[no] srrp
[no] sub-host-trk
sub-mgmt [ipoe] [pppoe]
no sub-mgmt
[no] rollback-sync
synchronize {boot-env | config}

5.16.1.16. LLDP System Commands

configure
— system
lldp
reinit-delay time
[no] shutdown
tx-credit-max count
tx-hold-multiplier multiplier
tx-interval interval

5.16.1.17. LLDP Ethernet Port Commands

configure
— port port-id
— ethernet
lldp
dest-mac {nearest-bridge | nearest-non-tpmr | nearest-customer}
admin-status {rx | tx | tx-rx | disabled}
[no] notification
port-id-subtype {tx-if-alias | tx-if-name | tx-local}
tx-mgmt-address [system] [system-ipv6]
tx-tlvs [port-desc] [sys-name] [sys-desc] [sys-cap]
— no tx-tlvs

5.16.1.18. System Router Instance Commands

config
router [router-instance] [create]
— no router [router-instance]

5.16.2. System Command Reference

5.16.2.1. Generic Commands

shutdown

Syntax 
[no] shutdown
Context 
config>system>cron>sched
config>system>satellite>local-forward>sap
config>system>satellite>port-template
config>system>time>ntp
config>system>time>sntp
config>system>script-control>script-policy
config>system>script-control>script
config>system>sync-if-timing>ref1
config>system>sync-if-timing>ref2
config>system>sync-if-timing>ptp
config>system>sync-if-timing>bits>input
config>system>sync-if-timing>bits>output
config>system>persistence>app-assure
config>system>persistence>dhcp-server
config>system>persistence>nat-port-forward
config>system>persistence>python-policy-cache
config>system>persistence>subscriber-mgmt
config>redundancy>multi-chassis>peer
config>redundancy>multi-chassis>peer>mc-lag
config>redundancy>multi-chassis>peer>sync
config>redundancy>mc>peer>mcr>node>cv
config>system>lldp
config>redundancy>multi-chassis>peer>mc-ep
Description 

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

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

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

Default 

shutdown

description

Syntax 
description description-string
no description
Context 
config>redundancy>multi-chassis>peer
config>system>cron>sched
config>system>persistence>ancp
config>system>persistence>app-assure
config>system>persistence>dhcp-server
config>system>persistence>nat-fwd
config>system>persistence>python-policy-cache
config>system>persistence>sub-mgmt
config>system>script-control>script
Description 

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

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

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

Default 

no description

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

5.16.2.2. System Information Commands

atm

Syntax 
atm
Context 
config>system
Description 

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

atm-location-id

Syntax 
atm-location-id location-id
no atm-location-id
Context 
config>system>atm
Description 

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.

Default 

no atm-location-id

Parameters 
location-id—
Specifies the 16 octets that identifies the system loopback location ID as required by the ATM OAM Loopback capability. This textual convention is defined in ITU-T standard I.610. The loopback location ID should be entered in the following format: xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx.

Invalid values include a location ID where the first octet is: 00, FF, 6A Acceptable location-ids include values where the first octet is: 01, 03 Other values are not accepted.

oam

Syntax 
oam
Context 
config>system>atm
Description 

This command configures system-wide ATM parameters.

loopback-period

Syntax 
loopback-period period
no loopback-period
Context 
config>system>atm>oam
Description 

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

Default 

no loopback-period

Parameters 
period—
Specifies the time, in seconds, between periodic loopback attempts.
Values—
1 to 40

 

Default—
10

retry-down

Syntax 
retry-down retries
no retry-down
Context 
config>system>atm>oam
Description 

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.

Default 

no retry-down

Parameters 
retries—
Specifies the number of failed loopback attempts before an ATM VC goes down.
Values—
0 to 10 (A zero value means that the endpoint will transition to AIS-LOC state immediately if the periodic loopback attempt fails.)

 

Default—
4

retry-up

Syntax 
retry-up retries
no retry-up
Context 
config>system>atm>oam
Description 

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.

Default 

no retry-up

Parameters 
retries—
Specifies the number of successful loopback replies before an ATM VC goes up.
Values—
0 to 10 (A zero value means that the endpoint will transition to the up state immediately if the periodic loopback attempt succeeds.)

 

Default—
2

boot-bad-exec

Syntax 
boot-bad-exec file-url
no boot-bad-exec
Context 
config>system
Description 

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.

Default 

no boot-bad-exec

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

Ipv6-address only applies to the 7750 SR and 7950 XRS.

Values—

file url

local-url | remote-url

255 chars max

local-url

[cflash-id/][file-path]

remote-url

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

remote-locn

[hostname | ipv4-address | [ipv6- address]]

ipv4-address

a.b.c.d

ipv6-address

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x - [0 to FFFF]H

d - [0 to 255]D

interface - 32 chars max, for link local addresses

cflash-id

cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

boot-good-exec

Syntax 
boot-good-exec file-url
no boot-good-exec
Context 
config>system
Description 

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.

Default 

no boot-good-exec

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

Ipv6-address only applies to the 7750 SR and 7950 XRS and ipv4-address applies to the 7450 ESS.

Values—

file url

local-url | remote-url

255 chars max

local-url

[cflash-id/][file-path]

remote-url

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

remote-locn

[hostname | ipv4-address | [ipv6- address]]

ipv4-address

a.b.c.d

ipv6-address

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x - [0 to FFFF]H

d - [0 to 255]D

interface - 32 chars max, for link local addresses

cflash-id

cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

chassis-mode

Syntax 
chassis-mode chassis-mode [force]
Context 
config>system
Description 

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.

Default 

chassis-mode d

Parameters 
chassis-mode—
Specifies the chassis modes:

d: This mode corresponds to scaling and feature set associated with iom3-xp.

force—
Forces an upgrade from a lesser scaling and feature set to a greater one.

clli-code

Syntax 
clli-code clli-code
no clli-code
Context 
config>system
Description 

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.

Default 

no clli-code

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

config-backup

Syntax 
config-backup count
no config-backup
Context 
config>system
Description 

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

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

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

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

Default 

no config-backup

Parameters 
count—
Specifies the maximum number of backup revisions.
Values—
1 to 9

 

contact

Syntax 
contact contact-name
no contact
Context 
config>system
Description 

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

Only one contact can be configured, if multiple contacts are configured the last one entered will overwrite the previous entry.

The no form of the command reverts to default.

Default 

no contact

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

cpm-http-redirect

Syntax 
cpm-http-redirect
Context 
config>system
Description 

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

optimized-mode

Syntax 
[no] optimized-mode
Context 
config>system>cpm-http-redirect
Description 

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

Default 

optimized-mode

coordinates

Syntax 
coordinates coordinates
no coordinates
Context 
config>system
Description 

This command creates a text string that identifies the system coordinates for the device location. For example, the command coordinates37.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.

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

dns

Syntax 
dns
Context 
config>system
Description 

This command configures DNS settings.

address-pref

Syntax 
address-pref {ipv4-only | ipv6-first}
no address-pref
Context 
config>system>dns
Description 

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.

Default 

address-pref ipv4-only

dnssec

Syntax 
dnssec
Context 
config>system>dns
Description 

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

ad-validation

Syntax 
ad-validation {fall-through | drop}
no ad-validation
Context 
config>system>dns>dnssec
Description 

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.

Default 

no ad-validation

Parameters 
fall-through—
Specifies that the DNSSEC validator should allow non-DNSSEC responses to fall-through to permit resolution in case of validation failure.
drop—
Specifies that the DNSSEC validator should drop non-DNSSEC responses in case of validation failure.

enable-icmp-vse

Syntax 
[no] enable-icmp-vse
Context 
config>system
Description 

This command enables vendor specific extensions to ICMP.

Default 

no enable-icmp-vse

ip

Syntax 
ip
Context 
config>system
Description 

This command configures system-wide IP router parameters.

allow-qinq-network-interface

Syntax 
[no] allow-qinq-network-interface
Context 
config>system>ip
Description 

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.

Default 

no allow-qinq-network-interface

enforce-unique-if-index

Syntax 
[no] enforce-unique-if-index
Context 
config>system>ip
Description 

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.

Default 

no enforce-unique-if-index

lacp-system-priority

Syntax 
lacp-system-priority lacp-system-priority
no lacp-system-priority
Context 
config>system
Description 

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

Default 

lacp-system-priority 32768

Parameters 
lacp-system-priority—
Specifies the LACP system priority.
Values—
1 to 65535

 

load-balancing

Syntax 
load-balancing
Context 
config>system
Description 

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.

l2tp-load-balancing

Syntax 
[no] l2tp-load-balancing
Context 
config>system>load-balancing
Description 

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.

l4-load-balancing

Syntax 
[no] l4-load-balancing
Context 
config>system>load-balancing
Description 

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:

Example:
If [(TCP or UDP traffic) & enabled]
hash (TCP/UDP ports, IP addresses)
else if (IP traffic)
hash (IP addresses)
else
hash (MAC addresses)
endif

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.

Default 

no l4-load-balancing

lsr-load-balancing

Syntax 
lsr-load-balancing hashing-algorithm
no lsr-load-balancing
Context 
config>system>load-balancing
Description 

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.

Default 

no lsr-load-balancing

Parameters 
lbl-only—
Specifies that only the label is used in the hashing algorithm
lbl-ip —
Specifies that the IP header is included in the hashing algorithm
ip-only—
Specifies that the IP header is used exclusively in the hashing algorithm
eth-encap-ip—
Specifies that the hash algorithm parses down the label stack (up to 3 labels supported) and once it hits the bottom, the stack assumes Ethernet II non-tagged header follows. At the expected Ethertype offset location, the algorithm checks whether the value present is IPv4/v6 (0x0800 or 0x86DD). If the check passes, the hash algorithm checks the first nibble at the expected IP header location for IPv4/IPv6 (0x0100/0x0110). If the secondary check passes, the hash is performed using IP SA/DA fields in the expected IP header; if any of the checks fail, the label-stack hash is performed.
lbl-ip-l4-teid—
Specifies that this hashing algorithm hashes based on label, IP header, Layer 4 header and GTP header (TEID) in order. The algorithm uses all the supported headers that are found in the header fragment of incoming traffic.

mc-enh-load-balancing

Syntax 
[no] mc-enh-load-balancing
Context 
config>system>load-balancing
Description 

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.

Default 

no mc-enh-load-balancing

service-id-lag-hashing

Syntax 
[no] service-id-lag-hashing
Context 
config>system>load-balancing
Description 

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.

Default 

no service-id-lag-hashing

system-ip-load-balancing

Syntax 
[no] system-ip-load-balancing
Context 
config>system>load-balancing
Description 

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.

Default 

no system-ip-load-balancing

location

Syntax 
location location
no location
Context 
config>system
Description 

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

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

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

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

name

Syntax 
name system-name
no name
Context 
config>system
Description 

This command creates a system name string for the device.

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

ABC>config>system# name "ALA-1"
ALA-1>config>system#

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.

Default 

no name

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

switchover-exec

Syntax 
switchover-exec file-url
no switchover-exec
Context 
config>system
Description 

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.

Default 

no switch-over-exec

Parameters 
file-url—
Specifies the location and name of the CLI script file.
Values—

local-url | remote-url

local-url

[cflash-id/][file-path] 200 chars max, including cflash-id

directory length 99 chars max each

remote-url

[{ftp:// | tftp://}login:pswd@remote-locn/][file-path]

243 chars max

directory length 99 chars max each

remote-locn

[hostname | ipv4-address | ipv6-address]

ipv4-address

a.b.c.d

ipv6-address

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x - [0 to FFFF]H

d - [0 to 255]D

interface - 32 chars max, for link local addresses

cflash-id

cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

port-topology

Syntax 
port-topology
Context 
config>system
Description 

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

Default 

disabled

port

Syntax 
port port-id to port-id [create]
no port port-id
Context 
config>system>port-topology
Description 

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:

First port

Second port

Router port

Satellite uplink port

Satellite uplink port

Router port

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:

*A:Dut-A# configure system port-topology port esat-1/1/u4 to 1/2/2 create 
*A:Dut-A# configure system port-topology no port esat-1/1/u4 
*A:Dut-A# configure system port-topology port 1/2/2 to esat-1/1/u4 create 
*A:Dut-A# configure system port-topology no port 1/2/2

The no form of the command removes the internal connection.

Default 

no port port-id

Parameters 
port-id—
Specifies one port of an internal port connection. These ports can be router ports or Ethernet satellite uplink ports. Acceptable pairings are defined in the command description.
Values—

port-id

(Router port)

slot/mda/port

slot

The slot number of the card in the chassis. The maximum slot number is platform dependent. Refer to the Install Guides for more information.

mda

[1 to 2]

port

[1 to 160] (depending on the MDA type)

(Ethernet satellite uplink port)

esat-id/slot/uport

esat

keyword

id

[1 to 20]

slot

[1]

u

keyword for up-link port

port

[1 to 4]

 

create—
Specifies the keyword required to create the binding between the two ports.

power-supply

Syntax 
power-supply power-supply-id type
Context 
config>system
Description 

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.

Parameters 
power-supply-id—
Specifies the power feed connection.
Values—
1, 2

 

type—
Specifies the type of power source that is connected to the power feed connection.
Values—
dc — Specifies that a single DC power source is connected to the power feed connector.
ac single — Specifies that a single AC power source is connected to the power feed connector.
ac multiple — Specifies that multiple AC power sources are connected to the power feed connector.
default — Reverts the configured information to the default power source type for the chassis.
none — Specifies that no power source is connected to the power feed connector.

 

satellite

Syntax 
satellite
Context 
config>system
Description 

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.

eth-sat

Syntax 
eth-sat sat-id [create]
no eth-sat sat-id
Context 
config>system>satellite
Description 

This command enables the specified Ethernet satellite configuration context.

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

Parameters 
sat-id
Specifies the satellite ID for the associated Ethernet satellite.
Values—
1 to 20

 

create—
Creates a new Ethernet satellite context.

feature

Syntax 
[no] feature feature-name
Context 
config>system>satellite>eth-sat
Description 

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.

Parameters 
feature-name—
Specifies the functionality to enable.
Values—
local-forward

 

Values—
transparent-clock-eth

 

local-forward

Syntax 
local-forward local-forward-id [create]
no local-forward local-forward-id
Context 
config>system>satellite
Description 

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.

Parameters 
local-forward-id—
Specifies the ID number for the local-forward instance.
Values—
1 to 10240

 

create—
Creates a new local-forward instance.

sap

Syntax 
sap sap-id [create]
no sap sap-id
Context 
config>system>satellite>local-forward
Description 

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.

Parameters 
eth-sat-id—
esat-id/slot/port
Values—

esat

keyword

id

1 to 20

 

lag-id—
lag-id
Values—

lag

keyword

id

1 to 800

 

qtag1—
Specifies the qtag value.
Values—
1 to 4094

 

port-template

Syntax 
port-template template-name sat-type sat-type [create]
no port-template template-name
Context 
config>system>satellite
Description 

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.

Parameters 
template-name—
Specifies the name for the associated port template. This value must be unique in the network.
sat-type—
Specifies the type of satellite chassis associated with the port-template.
Values—
es24-1gb-sfp, es24-1gb-tx, es24-sass-1gb-sfp, es48-1gb-sfp, es48-1gb-tx, es48-sass-1gb-sfp, es64-10gb-sfpp+4-100gb-cfp4, es24-sasmxp-1gb-sfp

 

create—
Creates a new port template.

port

Syntax 
port port-id
Context 
config>system>satellite>port-template
Description 

This command specifies the satellite port to be reconfigured.

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

Parameters 
port-id—
Specifies the satellite physical port ID. This must use the format slot/mda/port. Currently, all satellites have a single slot and a single MDA, so these values will always be 1. For example, port 10 would be specified as 1/1/10.

role

Syntax 
role role-type
Context 
config>system>satellite>port-template>port
Description 

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

Parameters 
none—
Clears the role association for the associated port.
uplink—
Specifies that the associated satellite port is assigned the role of an uplink port.
client—
Specifies that the associated satellite port is assigned the role of a satellite client port.
system-default—
Specifies that the associated satellite port is returned to the system default.

uplink

Syntax 
uplink port-id
uplink system-default
uplink none
Context 
config>system>satellite>port-template>port
Description 

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

Parameters 
port-id—
Specifies the satellite physical port ID. This must use the format slot/mda/port. All satellites have a single slot and a single MDA, so these values will always be 1. For example, port 10 would be specified as 1/1/10.
system-default—
Specifies that the uplink association is returned to the system default.
none—
Clears the uplink association.

tdm-sat

Syntax 
tdm-sat sat-id [create]
no tdm-sat sat-id
Context 
config>system>satellite
Description 

This command enters the specified TDM satellite configuration context.

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

Parameters 
sat-id
Specifies the satellite ID for the associated TDM satellite.
Values—
1 to 20

 

create—
Creates a new TDM satellite context.

description

Syntax 
description description-string
no description
Context 
config>system>satellite>eth-sat
config>system>satellite>local-forward
config>system>satellite>local-forward>sap
config>system>satellite>port-template
config>system>satellite>tdm-sat
Description 

This command defines a description string for the associated satellite.

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

Default 

no description

Parameters 
description-string
Specifies the satellite description, up to 80 characters.

mac-address

Syntax 
mac-address mac-address
no mac-address
Context 
config>system>satellite>eth-sat
config>system>satellite>tdm-sat
Description 

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.

Parameters 
mac-address
Specifies the MAC address of the associated satellite chassis; do not use a broadcast or multicast MAC. Enter the MAC address in either of the following formats: xx:xx:xx:xx:xx:xx or xx-xx-xx-xx-xx-xx.

port-map

Syntax 
port-map client-port-id primary primary-uplink-port-id [secondary secondary-uplink-port-id]
port-map client-port-id system-default
Context 
config>system>satellite>eth-sat
Description 

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.

Parameters 
client-port-id—
Specifies the satellite client port associated with the port mapping, in the format esat-id/slot/port.
primary-uplink-port-id—
Specifies the primary satellite uplink to be associated with the associate client port, in the format esat-id/slot/uport where id is 1 to 20.
secondary-uplink-port-id—
Specifies the secondary satellite uplink to be associated with the associate client port, in the format esat-id/slot/uport where id is 1 to 20.
system-default—
Specifies to set the port map to the system default.

ptp-tc

Syntax 
[no] ptp-tc
Context 
config>system>satellite>eth-sat
Description 

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.

Default 

no ptp-tc

sat-type

Syntax 
sat-type sat-type [port-template template-name]
no sat-type
Context 
config>system>satellite>eth-sat
config>system>satellite>tdm-sat
Description 

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

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

Default 

no sat-type

Parameters 
sat-type
Specifies the satellite type. Configuration of the following variants is supported:
es24-1gb-sfp —
Specifies the 24xGE (SFP) + 4x10GE Ethernet satellite.
es48-1gb-sfp —
Specifies the 48xGE (SFP) + 4x10GE Ethernet satellite.
es24-sass-1gb-sfp —
Specifies the SAS-S 24xGE (SFP) + 4x10GE Ethernet satellite.
es48-sass-1gb-sfp —
Specifies the SAS-S 48xGE (SFP) + 4x10GE Ethernet satellite.
es24-1gb-tx —
Specifies the 24xGE (copper) + 4x10GE Ethernet satellite.
es48-1gb-tx —
Specifies the 48xGE (copper) + 4x10GE Ethernet satellite.
es24-1gb-tx—
Specifies the 24-port copper + PoE Ethernet satellite.
es48-1gb-tx—
Specifies the 48-port copper + PoE Ethernet satellite.
es64-10gb-sfpp+4-100gb-cfp4—
Specifies the 64x10GE + 4x100GE Ethernet satellite.
es64-10gb-sfpp+4-100gb-qsfp28—
Specifies the 64x10GE + 4xQSFP28 Ethernet satellite.
es24-sasmxp-1gb-sfp—
Specifies the 7210 SAS-Mxp as an ethernet satellite.
ts4-choc3-sfp—
Specifies the 4-port OC3 TDM satellite.
ts4-chstm1-sfp—
Specifies the 4-port STM1 TDM satellite.
ts1-choc12-sfp—
Specifies the 1-port OC12 TDM satellite.
ts1-chstm4-sfp—
Specifies the 1-port STM4 TDM satellite.
template-name—
Specifies the name for the associated port template.

shutdown

Syntax 
[no] shutdown
Context 
config>system>satellite>eth-sat
config>system>satellite>tdm-sat
Description 

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.

Default 

shutdown

software-repository

Syntax 
software-repository repository-name
no software-repository
Context 
config>system>satellite>eth-sat
config>system>satellite>tdm-sat
Description 

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.

Default 

no software-repository

Parameters 
repository-name—
Specifies a string of up to 32 characters that uniquely identifies the software repository.

sync-e

Syntax 
[no] sync-e
Context 
config>system>satellite>eth-sat
Description 

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.

software-repository

Syntax 
software-repository repository-name [create]
no software-repository repository-name
Context 
config>system
Description 

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.

Parameters 
repository-name—
Specifies a string of up to 32 characters that uniquely identifies the software repository.
create
Specifies the keyword required when the software-repository context is first created. Once the context is created, it can be accessed without the create keyword.

description

Syntax 
description description-string
no description
Context 
config>system>software-repository
Description 

This command defines a description string for the software repository.

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

Default 

no description

Parameters 
description-string
Specifies the software repository description string up to 80 characters.

primary-location

Syntax 
primary-location file-url
no primary-location
Context 
config>system>software-repository
Description 

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.

Parameters 
file-url—
Specifies the primary location to be used to access the files in the software repository.
Values—

file url

local-url | remote-url

local-url

[cflash-id/][file-path]

200 chars maximum, including cflash-id directory length 99 characters maximum each

remote-url

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

243 characters maximum

directory length 99 characters maximum each

remote-locn

[hostname | ipv4-address | [ipv6- address]]

ipv4-address

a.b.c.d

ipv6-address

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x - [0 to FFFF]H

d - [0 to 255]D

interface - 32 characters max, for link local addresses

cflash-id

cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

secondary-location

Syntax 
secondary-location file-url
no secondary-location
Context 
config>system>software-repository
Description 

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.

Parameters 
file-url—
Specifies the secondary location to be used to access the files in the software repository.
Values—

file url

local-url | remote-url

local-url

[cflash-id/][file-path]

200 chars maximum, including cflash-id directory length 99 characters maximum each

remote-url

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

243 characters maximum

directory length 99 characters maximum each

remote-locn

[hostname | ipv4-address | [ipv6- address]]

ipv4-address

a.b.c.d

ipv6-address

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x - [0 to FFFF]H

d - [0 to 255]D

interface - 32 characters max, for link local addresses

cflash-id

cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

tertiary-location

Syntax 
tertiary-location file-url
no tertiary-location
Context 
config>system>software-repository
Description 

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.

Parameters 
file-url—
Specifies the tertiary location to be used to access the files in the software repository.
Values—

file url

local-url | remote-url

local-url

[cflash-id/][file-path]

200 chars maximum, including cflash-id directory length 99 characters maximum each

remote-url

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

243 characters maximum

directory length 99 characters maximum each

remote-locn

[hostname | ipv4-address | [ipv6- address]]

ipv4-address

a.b.c.d

ipv6-address

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x - [0 to FFFF]H

d - [0 to 255]D

interface - 32 characters max, for link local addresses

cflash-id

cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

5.16.2.3. System Alarm Contact Input Commands

alarm-contact-in-power

Syntax 
alarm-contact-in-power {on | off}
Context 
config>system
Description 

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.

Default 

alarm-contact-in-power off

Parameters 
on—
Specifies to turn on power to the +24VDC output pin of the Alarm Interface Port of the CPM.
off—
Specifies to turn off power to the +24VDC output pin of the Alarm Interface Port of the CPM.

alarm-contact-input

Syntax 
alarm-contact-input input-pin-number
Context 
config>system
Description 

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

Parameters 
input-pin-number—
Identifies the alarm contact input pin.
Values—
1 to 4

 

clear-alarm-msg

Syntax 
clear-alarm-msg message-string
no clear-alarm-msg
Context 
config>system>alarm-contact-input
Description 

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.

Parameters 
message-string—
Specifies a printable character string, up to 160 characters in length.

description

Syntax 
description description-string
no description
Context 
config>system>alarm-contact-input
Description 

This command describes an alarm contact input pin. The description provides an indication of the usage or attribute of the pin. It is stored in the CLI configuration file and helps the user 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).

Parameters 
description-string—
Specifies a printable character string, up to 80 characters in length.

normal-state

Syntax 
normal-state {open | closed}
Context 
config>system>alarm-contact-input
Description 

This command configures the normal state to be associated with the alarm contact input. When the system detects a transition from the normal state, an alarm is generated. The alarm is cleared when the system detects a transition back to the normal state.

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

Default 

normal-state open

Parameters 
open—
Specifies that the normal state is identified as open. When the system detects a transition to the closed state, an alarm is generated. The alarm is cleared when the system detects a transition back to the open state.
closed—
Specifies that the normal state is identified as closed. When the system detects a transition to the open state, an alarm is generated. The alarm is cleared when the system detects a transition back to the closed state.

shutdown

Syntax 
[no] shutdown
Context 
config>system>alarm-contact-input
Description 

This command stops tracking the state changes associated with the alarm contact input. The system does not generate or clear the alarms for the alarm contact input, but if an alarm is generated, 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.

Default 

shutdown

trigger-alarm-msg

Syntax 
trigger-alarm-msg message-string
no trigger-alarm-msg
Context 
config>system>alarm-contact-input
Description 

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.

Parameters 
message-string—
Specifies a printable character string, up to 160 characters in length.

5.16.2.4. System Threshold Alarm Commands

thresholds

Syntax 
thresholds
Context 
config>system
Description 

This command enables the context to configure monitoring thresholds.

cflash-cap-alarm

Syntax 
cflash-cap-alarm cflash-id rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
no cflash-cap-alarm cflash-id
Context 
config>system>thresholds
Description 

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

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

Parameters 
cflash-id —
Specifies the name of the cflash device to be monitored.
Values—
cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

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

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

The threshold value represents units of 512 bytes.

Values—
-2147483648 to 2147483647

 

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

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

The threshold value represents units of 512 bytes.

Values—
-2147483648 to 2147483647

 

Default—
0
seconds
Specifies the polling period, in seconds, over which the data is sampled and compared with the rising and falling thresholds.
Values—
1 to 2147483647

 

rmon-event-type
Specifies the type of notification action to be taken when this event occurs.
Values—
log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show>system>thresholds CLI command.
trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations, which may be CONSOLE, telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.
both — Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.
none — No action is taken.

 

Default—
both
alarm-type
Specifies the alarm that may be sent when this alarm is first created

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

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

Values—
rising, falling, either

 

Default—
either
Configuration example
 
cflash-cap-alarm cf1-A: rising-threshold 50000000 falling-threshold 49999900 
interval 120 rmon-event-type both start-alarm rising

cflash-cap-alarm-pct

Syntax 
cflash-cap-alarm-pct cflash-id rising-threshold percentage [falling-threshold percentage] interval seconds [rmon-event-type event-type] [startup-alarm alarm-type]
no cflash-cap-alarm-pct cflash-id
Context 
config>system>thresholds
Description 

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.

Parameters 
cflash-id —
The cflash-id specifies the name of the cflash device to be monitored.
Values—
cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

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

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

The threshold value is the percentage of used space versus capacity for the specified compact flash.

Values—
0 to 100

 

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

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

The threshold value is the percentage of used space versus capacity for the specified compact flash.

Values—
0 to 100

 

Default—
0
seconds—
Specifies the polling period, in seconds, over which the data is sampled and compared with the rising and falling thresholds.
Values—
1 to 2147483647

 

event-type
Specifies the type of notification action to be taken when this event occurs.
Values—
log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show>system>thresholds CLI command.
trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations, which may be CONSOLE, telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.
both — Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.
none — No action is taken.

 

Default—
both
alarm-type
Specifies the alarm that may be sent when this alarm is first created.

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

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

Values—
rising, falling, either

 

Default—
either
Configuration example
cflash-cap-alarm-pct cf1-A: rising-threshold 70 falling-
threshold 60 interval 120 rmon-event-type both start-alarm rising

cflash-cap-warn

Syntax 
cflash-cap-warn cflash-id rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
no cflash-cap-warn cflash-id
Context 
config>system>thresholds
Description 

This command enables capacity monitoring of the compact flash specified in this command.

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

Parameters 
cflash-id —
Specifies that the cflash-id specifies the name of the cflash device to be monitored.
Values—
cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

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

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

The threshold value represents units of 512 bytes.

Values—
-2147483648 to 2147483647

 

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

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

The threshold value represents units of 512 bytes.

Values—
-2147483648 to 2147483647

 

Default—
0
seconds
Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds.
Values—
1 to 2147483647

 

rmon-event-type—
Specifies the type of notification action to be taken when this event occurs.
Values—
log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show>system>thresholds CLI command.
trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations, which may be CONSOLE, telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.
both — Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.
none — No action is taken.

 

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

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

Values—
rising, falling, either

 

Default—
either
Configuration example
cflash-cap-warn cf1-B: rising-threshold 2000000 falling-threshold 1999900 
interval 240 rmon-event-type trap start-alarm either

cflash-cap-warn-pct

Syntax 
cflash-cap-warn-pct cflash-id rising-threshold percentage [falling-threshold percentage] interval seconds [rmon-event-type event-type] [startup-alarm alarm-type]
no cflash-cap-warn-pct cflash-id
Context 
config>system>thresholds
Description 

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.

Parameters 
cflash-id—
Specifies that the cflash-id specifies the name of the cflash device to be monitored.
Values—
cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

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

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

The threshold value is the percentage of used space versus capacity for the specified compact flash.

Values—
0 to 100

 

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

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

The threshold value is the percentage of used space versus capacity for the specified compact flash.

Values—
0 to 100

 

Default—
0
seconds
Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds.
Values—
1 to 2147483647

 

event-type
Specifies the type of notification action to be taken when this event occurs.
Values—
log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show>system>thresholds CLI command.
trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations, which may be CONSOLE, telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.
both —Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.
none — No action is taken.

 

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

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

Values—
rising, falling, either

 

Default—
either
Configuration example
 
cflash-cap-warn-pct cf1-B: rising-threshold 70 falling-threshold 60 
interval 240 rmon-event-type trap start-alarm either

kb-memory-use-alarm

Syntax 
kb-memory-use-alarm rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
no kb-memory-use-warn
Context 
config>system>thresholds
Description 

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

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

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

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

The threshold value represents units of kilobytes.

Values—
-2147483648 to 2147483647

 

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

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

The threshold value represents units of kilobytes.

Values—
-2147483648 to 2147483647

 

Default—
0
seconds
Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds.
Values—
1 to 2147483647

 

rmon-event-type
Specifies the type of notification action to be taken when this event occurs.
Values—
log — In the case of log, an entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show>system>thresholds CLI command.
trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.
both — Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.
none — No action is taken.

 

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

 

Default—
either

kb-memory-use-warn

Syntax 
kb-memory-use-warn rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
no kb-memory-use-warn
Context 
config>system>thresholds
Description 

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

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

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

The threshold value represents units of kilobytes.

Values—
-2147483648 to 2147483647

 

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

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

The threshold value represents units of kilobytes.

Values—
-2147483648 to 2147483647

 

Default—
0
seconds
Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds.
Values—
1 to 2147483647

 

rmon-event-type
Specifies the type of notification action to be taken when this event occurs.
Values—
log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show>system>thresholds CLI command.
trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.
both — Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.
none — No action is taken.

 

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

 

Default—
either

memory-use-alarm

Syntax 
memory-use-alarm rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
no memory-use-alarm
Context 
config>system>thresholds
Description 

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

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

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

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

The threshold value represents units of bytes.

Values—
-2147483648 to 2147483647

 

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

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

The threshold value represents units of bytes.

Values—
-2147483648 to 2147483647

 

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

The threshold value represents units of bytes.

Values—
1 to 2147483647

 

rmon-event-type
Specifies the type of notification action to be taken when this event occurs.
Values—
log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create an OS logger entry. The RMON-MIB log table entries can be viewed using the CLI command.
trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.
both — Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.
none — No action is taken.

 

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

 

Default—
either
Configuration example
memory-use-alarm rising-threshold 50000000 falling-threshold 45999999 
interval 500 rmon-event-type both start-alarm either

memory-use-warn

Syntax 
memory-use-warn rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]
no memory-use-warn
Context 
config>system>thresholds
Description 

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

The absolute sample type method is used.

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

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

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

The threshold value represents units of bytes.

Values—
-2147483648 to 2147483647

 

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

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

The threshold value represents units of bytes.

Values—
-2147483648 to 2147483647

 

Default—
0
seconds
Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds.
Values—
1 to 2147483647

 

rmon-event-type
Specifies the type of notification action to be taken when this event occurs.
Values—
log — An entry is made in the RMON-MIB log table for each event occurrence.
This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show>system>thresholds CLI command.
trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.
both — Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.
none — No action is taken.

 

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

 

Configuration example
memory-use-warn rising-threshold 500000 falling-threshold 400000 interval 800 rmon-
event-type log start-alarm falling

rmon

Syntax 
rmon
Context 
config>system>thresholds
Description 

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.

alarm

Syntax 
alarm rmon-alarm-id variable-oid oid-string interval seconds [sample-type] [startup-alarm alarm-type] [rising-event rmon-event-id rising-threshold threshold] [falling-event rmon-event-id falling-threshold threshold] [owner owner-string]
no alarm rmon-alarm-id
Context 
config>system>thresholds>rmon
Description 

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.

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

 

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

The oid-string has a maximum length of 255 characters

Default—
none
seconds
Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds. When setting this interval value, care should be taken in the case of ’delta’ type sampling - the interval should be set short enough that the sampled variable is very unlikely to increase or decrease by more than 2147483647 - 1 during a single sampling interval. Care should also be taken not to set the interval value too low to avoid creating unnecessary processing overhead.
Values—
1 to 2147483647

 

Default—
none
sample-type
Specifies the method of sampling the selected variable and calculating the value to be compared against the thresholds.
Values—
absolute — Specifies that the value of the selected variable will be compared directly with the thresholds at the end of the sampling interval.
delta — Specifies that the value of the selected variable at the last sample will be subtracted from the current value, and the difference compared with the thresholds.

 

Default—
absolute
alarm-type
Specifies the alarm that may be sent when this alarm is first created.

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

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

Values—
rising, falling, either

 

Default—
either
rising-event rmon-event-id
Specifies the identifier of the rmon>event that specifies the action to be taken when a rising threshold crossing event occurs.

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

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

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

Values—
0 to 65535

 

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

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

Values—
-2147483648 to 2147483647

 

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

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

Values—
0 to 65535

 

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

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

Values—
-2147483648 to 2147483647

 

Default—
0
owner-string
Specifies the owner string; the owner identifies the creator of this alarm. It defaults to "TiMOS CLI". This parameter is defined primarily to allow entries that have been created in the RMON-MIB alarmTable by remote SNMP managers to be saved and reloaded in a CLI configuration file. The owner will not normally be configured by CLI users and can be a maximum of 80 characters long.
Default—
TiMOS CLI
Configuration example
 
alarm 3 variable-oid ifInOctets.184582144 interval 20 sample-type delta 
start-alarm either rising-event 5 rising-threshold 10000 falling-event 5 
falling-threshold 9000 owner "TiMOS CLI"

event

Syntax 
event rmon-event-id [event-type] [description description-string] [owner owner-string]
no event rmon-event-id
Context 
config>system>thresholds>rmon
Description 

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.

Parameters 
rmon-event-id
Specifies an identifier for this event.
Values—
1 to 65535

 

rmon-event-type
Specifies the type of notification action to be taken when this event occurs.
Values—
log — An entry is made in the RMON-MIB log table for each event occurrence.
This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show>system>thresholds CLI command.
trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.
both — Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.
none — No action is taken.

 

Default—
both
description-string
Specifies a user configurable string that can be used to identify the purpose of this event. This is an optional parameter and can be up to 80 characters long. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.
owner-string
Specifies the owner string; the owner identifies the creator of this alarm. It defaults to "TiMOS CLI". This parameter is defined primarily to allow entries that have been created in the RMON-MIB alarmTable by remote SNMP managers to be saved and reloaded in a CLI configuration file. The owner will not normally be configured by CLI users and can be up 80 characters long.
Default—
TiMOS CLI
Configuration example:
event 5 rmon-event-type both description "alarm testing" owner "TiMOS CLI"

5.16.2.5. System Bluetooth Commands

bluetooth

Syntax 
thresholds
Context 
config>system
Description 

This command enables the context for configuring Bluetooth console attributes.

advertising-timeout

Syntax 
advertising-timeout seconds
no advertising-timeout
Context 
config>system>bluetooth
Description 

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.

Default 

advertising-timeout 30

Parameters 
seconds —
Specifies the paring timeout interval.
Values—
330 to 3600

 

device

Syntax 
device ieee-address [create]
no device ieee-address
Context 
config>system>bluetooth
Description 

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.

Parameters 
ieee-address—
Specifies the MAC address of the external Bluetooth device.
Values—
6-byte unicast MAC address (xx:xx:xx:xx:xx:xx or xx-xx-xx-xx-xx-xx)

 

description

Syntax 
description description-string
no description
Context 
config>system>bluetooth>device
Description 

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.

Default 

no description

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

module

Syntax 
module cpm-slot
Context 
config>system>bluetooth
Description 

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

Parameters 
cpm-slot—
Specifies the CPM slot.
Values—
{A | B | C | D}

 

identifier

Syntax 
identifier identifier
no identifier
Context 
config>system>bluetooth>module
Description 

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.

Parameters 
identifier
Specifies string of up to 32 characters using the values in the range {0-9, a-z, A-Z}.

pairing-button

Syntax 
pairing-button admin-state
Context 
config>system>bluetooth
Description 

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.

Default 

pairing-button disable

Parameters 
admin-state
Specifies the administrative state.
Values—
enable — pairing button can trigger a pairing operation
disable — pairing button does not trigger a pairing operation

 

passkey

Syntax 
passkey passkey
Context 
config>system>bluetooth
Description 

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.

Default 

passkey 123456

Parameters 
passkey
Must be six digits.
Values—
000000 to 999999

 

power

Syntax 
power power-state
Context 
config>system>bluetooth
Description 

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.

Default 

power off

Parameters 
power-state
Specifies the power state.
Values—
off — bluetooth radio disabled
enabled-manual — bluetooth enabled (pairing requires the use of the pairing button)
enabled-automatic — bluetooth is enabled and continuously attempts to pair whenever it is not actively paired to a device

 

5.16.2.6. Mixed Mode Configuration Commands

capability

Syntax 
capability {sr | ess} [now]
Context 
config>card
Description 

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.

Default 

capability ess (on a 7450 ESS chassis)

Parameters 
now—
Forces the command to be executed immediately without further question. If this keyword is not present, then the user will be presented with a question to ensure they understand that as a result of this command, the associated slots will be reset immediately to enable mixed-mode.

mixed-mode

Syntax 
[no] mixed-mode
Context 
config>system
Description 

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

The no form of the command disables mixed mode support.

Default 

no mixed-mode

5.16.2.7. Persistence Commands

persistence

Syntax 
persistence
Context 
config>system
Description 

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.

Default 

persistence

ancp

Syntax 
ancp
Context 
config>system>persistence
Description 

This command configures ANCP persistence parameters.

application-assurance

Syntax 
application-assurance
Context 
config>system>persistence
Description 

This command configures application assurance persistence parameters.

dhcp-server

Syntax 
dhcp-server
Context 
config>system>persistence
Description 

This command configures DHCP server persistence parameters.

nat-port-forwarding

Syntax 
nat-port-forwarding
Context 
config>system>persistence
Description 

This command configures NAT port forwarding persistence parameters.

options

Syntax 
options
Context 
config>system>persistence
Description 

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

dhcp-leasetime-threshold

Syntax 
dhcp-leasetime-threshold [days days] [hrs hours] [min minutes] [sec seconds]
no dhcp-leasetime-threshold
Context 
config>system>persistence>options
Description 

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.

Default 

no dhcp-leasetime-threshold

Parameters 
days—
Specifies the threshold in days.
Values—
0 to 7305

 

hours—
Specifies the threshold in hours.
Values—
0 to 23

 

minutes—
Specifies the threshold in minutes.
Values—
0 to 59

 

seconds—
Specifies the threshold in seconds.
Values—
0 to 59

 

python-policy-cache

Syntax 
python-policy-cache
Context 
config>system>persistence
Description 

This command configures Python policy cache persistency parameters.

subscriber-mgmt

Syntax 
subscriber-mgmt
Context 
config>system>persistence
Description 

This command configures subscriber management persistence parameters.

location

Syntax 
location cflash-id
no location
Context 
config>system>persistence>ancp
config>system>persistence>app-assure
config>system>persistence>dhcp-server
config>system>persistence>nat-fwd
config>system>persistence>python
config>system>persistence>subscriber-mgmt
Description 

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.

Default 

no location

Parameters 
cflash-id—
Specifies the compact flash device name.
Values—
cf1:, cf2:, cf3:

 

5.16.2.8. PTP Commands

ptp

Syntax 
ptp
Context 
config>system
Description 

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.

anno-rx-timeout

Syntax 
anno-rx-timeout count
no anno-rx-timeout
Context 
config>system>ptp
Description 

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.

Default 

anno-rx-timeout 3

Parameters 
count—
Specifies the announce packet interval, in log form.
Values—
2 to 10

 

Default—
3

clock-type

Syntax 
clock-type boundary
clock-type ordinary {master | slave}
Context 
config>system>ptp
Description 

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.

Default 

clock-type ordinary slave

Parameters 
boundary—
Specifies that the system is a boundary clock, which may be anywhere in the master-slave clock hierarchy. It can obtain timing from a master clock, and provide timing to multiple slave clocks concurrently.
ordinary master—
Specifies that the system is a grandmaster clock in the master-slave hierarchy. The system provides timing to multiple slave clocks in the network.
ordinary slave—
Specifies that the system is always a slave clock in the master-slave hierarchy. The system derives its timing from one or more master clocks in the network.

domain

Syntax 
domain domain
no domain
Context 
config>system>ptp
Description 

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.

Default 

domain 0 — profile ieee1588-2008

domain 4 — profile g8265dot1-2010

domain 24 — profile g8275dot1-2014

Parameters 
domain—
Specifies the PTP domain.
Values—
0 to 255 for ieee1588-2008
0 to 255 for g8265dot1-2010
24 to 43 for g8275dot1-2014

 

local-priority

Syntax 
local-priority priority
Context 
config>system>ptp
config>system>ptp>peer
config>system>ptp>port
Description 

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.

Default 

local-priority 128

Parameters 
priority—
Specifies the value of the local priority.
Values—
1 to 255

 

log-anno-interval

Syntax 
log-anno-interval log-interval
no log-anno-interval
Context 
config>system>ptp
Description 

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.

Default 

log-anno-interval 1 (1 packet every 2 seconds) for ieee1588-2008

log-anno-interval 1 (1 packet every 2 seconds) for g8265dot1-2010

log-anno-interval -3 (8 packets per second) for g8275dot1-2014

Parameters 
log-interval—
Specifies the announce packet interval, in log form.
Values—
-3 to 4

 

network-type

Syntax 
network-type {sdh | sonet}
Context 
config>system>ptp
Description 

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

Default 

network-type sdh

Parameters 
sdh—
Specifies the values used on a G.781 Option 1 compliant network.
sonet —
Specifies the values used on a G.781 Option 2 compliant network.

peer

Syntax 
peer ip-address [create]
no peer ip-address
Context 
config>system>ptp
Description 

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.

Parameters 
ip-address—
The ip address of the remote peer. The no form must include the specific address being deleted.
create—
Creates the remote PTP peer.
Values—
ipv4 address: a.b.c.d.

 

log-sync-interval

Syntax 
log-sync-interval log-interval
no log-sync-interval
Context 
config>system>ptp>peer
Description 

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.

Default 

log-sync-interval -6 (64 packets per second) for 1588-2008

log-sync-interval -6 (64 packets per second) for g8265dot1-2010

log-sync-interval -4 (16 packets per second) for g8275dot1-2014

Parameters 
log-interval—
Specifies the sync message interval, in log form.
Values—
-6 to 0

 

shutdown

Syntax 
[no] shutdown
Context 
config>system>ptp>peer
Description 

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

Default 

no shutdown

peer-limit

Syntax 
peer-limit limit
no peer-limit
Context 
config>system>ptp
Description 

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.

Default 

no peer-limit

Parameters 
limit—
Specifies the maximum number of discovered peers allowed in the routing instance.
Values—
0 to 512

 

Default—
1 (The maximum number of discovered peers supported by the system.)

port

Syntax 
port port-id [create]
no port port-id
Context 
config>system>ptp
Description 

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.

Parameters 
port-id—
Specifies a specific physical port.
Values—
slot/mda/port

 

create—
Creates the PTP port. This keyword is required when first creating the PTP port, if the system is configured to require it (enabled in the environment create command). Once the PTP port is created, it is possible to navigate into the context without the create keyword.

address

Syntax 
address {01:1b:19:00:00:00|01:80:c2:00:00:0e}
Context 
config>system>ptp>port
Description 

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:

  1. 01-1B-19-00-00-00 — all except the peer delay mechanism messages
  2. 01-80-C2-00-00-0E — peer delay mechanism messages

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.

Default 

address 01-1B-19-00-00-00

log-delay-interval

Syntax 
log-delay-interval log-interval
no log-delay-interval
Context 
config>system>ptp>port
Description 

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.

Default 

log-delay-interval -6 for ieee1588-2008

log-delay-interval -6 for g8265dot1-2010

log-delay-interval -4 for g8275dot1-2014

Parameters 
log-interval—
Specifies the Delay_Req message interval, in log form.
Values—
-6 to 0

 

Default—
-6

log-sync-interval

Syntax 
log-sync-interval log-interval
no log-sync-interval
Context 
config>system>ptp>port
Description 

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.

Default 

log-sync-interval -6 (64 packets per second) for ieee1588-2008 or

log-sync-interval -6 (64 packets per second) for g8265dot1-2010 or

log-sync-interval -4 (16 packets per second) for g8275dot1-2014

Parameters 
log-interval —
Specifies the message interval, in log form.
Values—
-6 to 0 (This corresponds to a maximum rate of 64 packets per second, and a minimum rate of 1 packet per second.)

 

Default—
-6

master-only

Syntax 
master-only {true | false}
Context 
config>system>ptp>port
Description 

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.

Default 

master-only true

Parameters 
true—
Enables the master-only parameter of the PTP port.
false—
Disables the master-only parameter of the PTP port.

shutdown

Syntax 
[no] shutdown
Context 
config>system>ptp>port
Description 

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.

Default 

no shutdown

priority1

Syntax 
priority1 priority-value
no priority1
Context 
config>system>ptp
Description 

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.

Default 

priority1 128

Parameters 
priority-value—
Specifies the value of the priority1 field.
Values—
0 to 255

 

priority2

Syntax 
priority2 priority-value
no priority2
Context 
config>system>ptp
Description 

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.

Default 

priority2 128

Parameters 
priority-value—
Specifies the value of the priority2 field.
Values—
0 to 255

 

profile

Syntax 
profile {g8265dot1-2010 | ieee1588-2008 | g8275dot1-2014}
Context 
config>system>ptp
Description 

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:

  1. log-anno-interval set for the clock
  2. log-sync-interval set for a peer or a port
  3. log-delay-interval set for a port

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

Default 

profile g8265dot1-2010

Parameters 
g8265dot1-2010—
Conforms to the ITU-T G.8265.1 specification.
ieee1588-2008—
Conforms to the 2008 version of the IEEE1588 standard.
g8275dot1-2014—
Conforms to the ITU-T G.8275.1 specification.

shutdown

Syntax 
[no] shutdown
Context 
config>system>ptp
Description 

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.

Default 

shutdown

5.16.2.9. Date and Time Commands

set-time

Syntax 
set-time date time
Context 
admin
Description 

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.

Parameters 
date
Specifies the local date and time accurate to the minute in the YYYY/MM/DD format.
Values—
YYYY is the four-digit year MM is the two-digit month DD is the two-digit date

 

time
Specifies the time (accurate to the second) in the hh:mm[:ss] format. If no seconds value is entered, the seconds are reset to :00.
Values—
hh is the two-digit hour in 24 hour format (00=midnight, 12=noon) mm is the two-digit minute

 

Default—
0

time

Syntax 
time
Context 
config>system
Description 

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

5.16.2.10. Network Time Protocol Commands

ntp

Syntax 
[no] ntp
Context 
config>system>time
Description 

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.

Default 

ntp

prefer-local-time

Syntax 
[no] prefer-local-time
Context 
config>system>time
Description 

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.

Default 

no prefer-local-time

authentication-check

Syntax 
[no] authentication-check
Context 
config>system>time>ntp
Description 

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.

Default 

authentication-check

authentication-key

Syntax 
authentication-key key-id key key [hash | hash2] type {des | message-digest}
no authentication-key key-id
Context 
config>system>time>ntp
Description 

This command sets the authentication key-id, type and key used to authenticate NTP PDUs sent to or received by other network elements participating in the NTP protocol. For authentication to work, the authentication key-id, type and key value must match.

The no form of the command removes the authentication key.

Parameters 
key-id—
Configures the authentication key-id that will be used by the node when transmitting or receiving Network Time Protocol packets

Entering the authentication-key command with a key-id value that matches an existing configuration key will result in overriding the existing entry.

Recipients of the NTP packets must have the same authentication key-id, type, and key value in order to use the data transmitted by this node. This is an optional parameter.

Values—
1 to 255

 

Default—
None
key
Specifies the authentication key associated with the configured key-id, the value configured in this parameter is the actual value used by other network elements to authenticate the NTP packet.

The key can be any combination of ASCII characters up to 32 characters for message-digest (md5) or 8 characters for des (length limits are unencrypted lengths). If spaces are used in the string, enclose the entire string in quotation marks (“.”).

hash—
Specifies the key is entered in an encrypted form. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified
hash2—
Specifies the key is entered in a more complex encrypted form that involves more variables than the key value alone, meaning that the hash2 encrypted variable cannot be copied and pasted. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.
type —
Determines if DES or message-digest authentication is used.

This is a required parameter; either DES or message-digest must be configured.

des—
Specifies that DES authentication is used for this key. The des option is not permitted in FIPS-140-2 mode.
message-digest—
Specifies that MD5 authentication in accordance with RFC 2104 is used for this key.

broadcast

Syntax 
broadcast [router router-name] {interface ip-int-name} [key-id key-id] [version version] [ttl ttl]
no broadcast [router router-name] {interface ip-int-name}
Context 
config>system>time>ntp
Description 

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.

Parameters 
router-name—
Specifies the router name used to transmit NTP packets. Base is the default. Select management to use the management port (Ethernet port on the CPM). Note that broadcast server capability can also be enabled on an interface within a VPRN context. Refer to “NTP Within a VPRN Service” in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Layer 3 Services Guide: IES and VPRN for more information.
Values—
Base | Management

 

Default—
Base
ip-int-name—
Specifies the local interface on which to transmit NTP broadcast packets. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. The string may be a maximum of 32 characters.
key-id
Identifies the configured authentication key and authentication type used by this node to receive and transmit NTP packets to and from an NTP server and peers. If an NTP packet is received by this node both authentication key and authentication type must be valid otherwise the packet will be rejected and an event/trap generated.
Values—
1 to 255

 

Default—
none
version
Specifies the NTP version number that is generated by this node. This parameter does not need to be configured when in client mode in which case all versions will be accepted.
Values—
2 to 4

 

Default—
4
ttl
Specifies the IP Time To Live (TTL) value.
Values—
1 to 255

 

Default—
none

broadcastclient

Syntax 
broadcastclient [router router-instance | service-name service-name] {interface ip-int-name} [authenticate]
no broadcastclient [router router-instance | service-name service-name] {interface ip-int-name}
Context 
config>system>time>ntp
Description 

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.

Parameters 
router-instance—
Specifies the routing context that contains the interface in the form of router-name or service-id.
Values—
router-name — Base | Management
service-id — 1 to 2147483647

 

Default—
Base
service name—
Specifies the service name for the VPRN. The name can be up to 64 characters in length. Note that CPM routing instances are not supported.
ip-int-name—
Specifies the VPRN interface on which to receive NTP broadcast packets. If the string contains special characters (such as #, $, or spaces) the entire string must be enclosed within double quotes.
authenticate—
Specifies whether or not to require authentication of NTP PDUs. When enabled, NTP PDUs are authenticated upon receipt.

multicast

Syntax 
multicast [key-id key-id] [version version]
no multicast
Context 
config>system>time>ntp
Description 

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.

Parameters 
key-id
Specifies the configured authentication key and authentication type used by this version to transmit NTP packets. If this command is omitted from the configuration, packets are sent unencrypted.
Values—
1 to 255

 

Default—
None
version
Specifies the NTP version number that is generated by this node. This parameter does not need to be configured when in client mode in which case all three versions are accepted.
Values—
2 to 4

 

Default—
4

multicastclient

Syntax 
multicastclient [authenticate]
no multicastclient
Context 
config>system>time>ntp
Description 

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.

Parameters 
authenticate—
Specifies to make authentication a requirement (optional). If authentication is required, the authentication key-id received must have been configured in the authentication-key command, and that key-id type and key value must also match.

ntp-server

Syntax 
ntp-server [authenticate]
no ntp-server
Context 
config>system>time>ntp
Description 

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.

Default 

no ntp-server

Parameters 
authenticate
Specifies to make authentication a requirement (optional). If authentication is required, the authentication key-id received in a message must have been configured in the authentication-key command, and that key-id type and key value must also match.

The authentication key from the received messages will be used for the transmitted messages.

peer

Syntax 
peer [router router-instance | service-name service-name] {ip-address | ipv6-address} [key-id key-id] [version version] [prefer]
no peer [router router-instance | service-name service-name] {ip-address | ipv6-address}
Context 
config>system>time>ntp
Description 

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.

Parameters 
router-instance—
Specifies the routing context that contains the interface in the form of router-name or service-id.
Values—
router-name —Base | Management
service-id — 1 to 2147483647

 

Default—
Base
service name—
Specifies the service name for the VPRN. The name can be up to 64 characters. CPM routing instances are not supported.
ip-address—
Configures the IPv4 address of the peer that requires a peering relationship to be set up.
Values—
a.b.c.d

 

Default—
None
ipv6-address—
Configures the IPv6 address of the peer that requires a peering relationship to be set up.
Values—
  1. x:x:x:x:x:x:x:x (eight 16-bit pieces)
  2. x:x:x:x:x:x:d.d.d.d
  3. x: [0 to FFFF] H
  4. d: [0 to 255] D

 

Default—
None
key-id
Specifies the key ID. Successful authentication requires that both peers must have the same authentication key-id, type, and key value.

Specify the key-id that identifies the configured authentication key and authentication type used by this node to transmit NTP packets to an NTP peer. If an NTP packet is received by these nodes, the authentication key-id, type, and key value must be valid, otherwise the packet will be rejected and an event or trap will be generated.

Values—
1 to 255

 

Default—
None
version
Specifies the NTP version number that is generated by this node. This parameter does not need to be configured when in client mode, in which case all versions are accepted.
Values—
2 to 4

 

Default—
4
prefer—
When configuring more than one peer, one remote system can be configured as the preferred peer. When a second peer is configured as preferred, then the new entry overrides the old entry.

server

Syntax 
server [router router-instance | service-name service-name] {ip-address | ipv6-address | ptp} [key-id key-id] [version version] [prefer]
no server [router router-instance | service-name service-name] {ip address | ipv6-address | ptp}
Context 
config>system>time>ntp
Description 

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.

Parameters 
router-instance—
Specifies the routing context that contains the interface in the form of router-name or service-id.
Values—
router-name — Base | Management
service-id — 1 to 2147483647

 

Default—
Base
service name—
Specifies the service name for the VPRN. The name can be up to 64 characters. CPM routing instances are not supported.
ip-address—
Configures the IPv4 address of an external NTP server.
Values—
a.b.c.d

 

Default—
None
ipv6-address—
Configures the IPv6 address of an external NTP server.
Values—
  1. x:x:x:x:x:x:x:x (eight 16-bit pieces)
  2. x:x:x:x:x:x:d.d.d.d
  3. x: [0 to FFFF] H
  4. d: [0 to 255] D

 

Default—
None
key-id
Specifies the key ID that identifies the configured authentication key and authentication type used by this node to transmit NTP packets to an NTP server. If an NTP packet is received by this node, the authentication key-id, type, and key value must be valid, otherwise the packet will be rejected and an event/trap generated. This is an optional parameter.
Values—
1 to 255

 

version
Configures the NTP version number that is expected by this node. This is an optional parameter.
Values—
2 to 4

 

Default—
4
ptp—
Configures the internal PTP process as a time server into the NTP process. Theprefer parameter is mandatory with this server option.
prefer—
Specifies that, when configuring more than one peer, one remote system can be configured as the preferred peer. When a second peer is configured as preferred, then the new entry overrides the old entry.

5.16.2.10.1. SNTP Commands

sntp

Syntax 
[no] sntp
Context 
config>system>time
Description 

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

Default 

sntp

broadcast-client

Syntax 
[no] broadcast-client
Context 
config>system>time>sntp
Description 

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

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

The no form of the command disables broadcast client mode.

Default 

no broadcast-client

server-address

Syntax 
server-address ip-address [version version-number] [normal | preferred]
[interval seconds]
no server-address ip-address
Context 
config>system>time>sntp
Description 

This command creates an SNTP server for unicast client mode.

Parameters 
ip-address—
Specifies the IP address of the SNTP server.
Values—
a.b.c.d

 

version-number
Specifies the SNTP version supported by this server.
Values—
1 to 3

 

Default—
3
normal | preferred—
Specifies the preference value for this SNTP server. When more than one time-server is configured, one server can have preference over others. The value for that server should be set to preferred. Only one server in the table can be a preferred server.
Default—
normal
seconds
Specifies the frequency at which this server is queried.
Values—
64 to 1024

 

Default—
64

5.16.2.10.2. System Time Commands

dst-zone

Syntax 
[no] dst-zone {std-zone-name | non-std-zone-name}
Context 
config>system>time
Description 

This command configures the start and end dates and offset for summer time or daylight savings time to override system defaults or for user defined time zones.

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

If the time zone configured is listed in the Time Zones section, 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 the Time Zones section on or entered as optional parameters in this command.

Up to five summer time zones may be configured, for example, for five successive years or for five different time zones. Configuring a sixth entry 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.

Parameters 
std-zone-name—
Specifies the standard time zone name. The standard name must be a system-defined zone in the Time Zones section. For zone names in the table that have an implicit summer time setting, for example MDT for Mountain Daylight Saving Time, the remaining start-date, end-date and offset parameters need to be provided unless it is necessary to override the system defaults for the time zone.
Values—
ADT, NDT, AKDT, CDT, CEST, EDT, EEST, MDT, NZDT, PDT, WEST

 

non-std-zone-name—
Specifies the non-standard time zone name. Create a user-defined name created using the zone. The name can be a maximum of 5 characters in length.

end

Syntax 
end end-week end-day end-month hours-minutes
Context 
config>system>time>dst-zone
Description 

This command configures start of summer time settings.

Default 

end first sunday january 00:00

Parameters 
end-week—
Specifies the starting week of the month when the summer time ends.
Values—
first, second, third, fourth, last

 

Default—
first
end-day—
Specifies the starting day of the week when the summer time ends.
Values—
sunday, monday, tuesday, wednesday, thursday, friday, saturday

 

Default—
sunday
end-month—
Specifies the starting month of the year when the summer time takes effect.
Values—
january, february, march, april, may, june, july, august, september, october, november, december

 

Default—
january
hours-minutes—
Specifies the time at which the summer time ends, in hh:mm format.
Values—
hours: 00 to 23
minutes: 00 to 59

 

Default—
00:00

offset

Syntax 
offset offset
Context 
config>system>time>dst-zone
Description 

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.

Default 

offset 60

Parameters 
offset—
Specifies the number of minutes added to the time at the beginning of summer time and subtracted at the end of summer time, expressed as an integer.
Values—
0 to 60

 

Default—
60

start

Syntax 
start start-week start-day start-month hours-minutes
Context 
config>system>time>dst-zone
Description 

This command configures start of summer time settings.

Default 

start first sunday january 00:00

Parameters 
start-week—
Specifies the starting week of the month when the summer time takes effect.
Values—
first, second, third, fourth, last

 

Default—
first
start-day—
Specifies the starting day of the week when the summer time takes effect.
Values—
sunday, monday, tuesday, wednesday, thursday, friday, saturday

 

Default—
sunday
start-month—
Specifies the starting month of the year when the summer time takes effect.
Values—
january, february, march, april, may, june, july, august, september, october, november, december

 

Default—
january
hours-minutes—
Specifies the time at which the summer time takes effect, in hh:mm format.
Values—
hours: 00 to 23
minutes: 00 to 59

 

Default—
00:00

zone

Syntax 
zone {std-zone-name | non-std-zone-name} [hh [:mm]]
no zone
Context 
config>system>time
Description 

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

The SR-series router OS supports system-defined and user-defined time zones. The system-defined time zones are listed in the Time Zones section.

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.

Default 

zone UTC 00

Parameters 
std-zone-name—
Specifies the standard time zone name. The standard name must be a system-defined zone in the Time Zones section. For zone names in the table that have an implicit summer time setting, for example MDT for Mountain Daylight Saving Time, the remaining start-date, end-date and offset parameters need to be provided unless it is necessary to override the system defaults for the time zone.

For system-defined time zones, a different offset cannot be specified. If a new time zone is needed with a different offset, the user must create a new time zone. Note that some system-defined time zones have implicit summer time settings which causes the switchover to summer time to occur automatically; configuring the dst-zone parameter is not required.

A user-defined time zone name is case-sensitive and can be up to 5 characters in length.

Values—
A user-defined value can be up to 4 characters or one of the following values: GMT, WET, CET, EET, EEST, MSK, MSD, AST, NST, EST, CST, MST, PST, HST, AKST, AWST, ACST, AEST, NZST, UTC

 

non-std-zone-name—
Specifies the non-standard time zone name. The name can be up to 5 characters.
hh [:mm]—
Specifies the hours and minutes offset from UTC time, expressed as integers. Some time zones do not have an offset that is an integral number of hours. In these instances, the minutes-offset must be specified. For example, the time zone in Pirlanngimpi, Australia UTC + 9.5 hours.
Values—
hours: -11 to 12 minutes: 0 to 59

 

Default—
hours: 0 minutes: 0

5.16.2.11. Cron Commands

cron

Syntax 
cron
Context 
config
Description 

This command creates the context to create scripts, script parameters and schedules which support the Service Assurance Agent (SAA) functions.

CRON features are saved to the configuration file on both primary and backup control modules. If a control module switchover occurs, CRON events are restored when the new configuration is loaded. If a control module switchover occurs during the execution of a cron script, the failover behavior will be determined by the contents of the script.

schedule

Syntax 
[no] schedule schedule-name [owner schedule-owner]
Context 
config>system>cron
Description 

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

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

Parameters 
schedule-name—
Specifies the name of the schedule. The name can be up to 32 characters.
schedule-owner
Specifies the owner name of the schedule. The name can be up to 32 characters.
Default—
TiMOS CLI

count

Syntax 
count number
no count
Context 
config>system>cron>sched
Description 

This command configures the total number of times a CRON “interval” schedule is run. For example, if the interval is set to 600 and the count is set to 4, the schedule runs 4 times at 600 second intervals.

Default 

no count

Parameters 
number—
Specifies the number of times the schedule is run.
Values—
1 to 65535

 

Default—
65535

day-of-month

Syntax 
day-of-month {day-number [..day-number] all}
no day-of-month
Context 
config>system>cron>sched
Description 

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.

Default 

no day-of-month

Parameters 
day-number—
Specifies the positive integers specify the day of the month counting from the first of the month. The negative integers specify the day of the month counting from the last day of the month. For example, configuring day-of-month -5, 5 in a month that has 31 days will specify the schedule to occur on the 27th and 5th of that month.

Integer values must map to a valid day for the month in question. For example, February 30 is not a valid date.

Values—
1 to 31, -31 to -1 (maximum 62 day-numbers)

 

all—
Specifies all days of the month.

end-time

Syntax 
end-time [date | day-name] time
no end-time
Context 
config>system>cron>sched
Description 

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.

Default 

no end-time

Parameters 
date—
Specifies the date to schedule a command.
Values—
YYYY:MM:DD in year:month:day number format

 

day-name—
Specifies the day of the week to schedule a command.
Values—
sunday, monday, tuesday, wednesday, thursday, friday, saturday

 

time—
Specifies the time of day to schedule a command.
Values—
hh:mm

 

hour

Syntax 
hour hour-number [..hour-number] | all}
no hour
Context 
config>system>cron>sched
Description 

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.

Default 

no hour

Parameters 
hour-number—
Specifies the hour to schedule a command.
Values—
0 to 23 (maximum 24 hour-numbers)

 

all—
Specifies all hours.

interval

Syntax 
interval seconds
no interval
Context 
config>system>cron>sched
Description 

This command specifies the interval between runs of an event.

Default 

no interval

Parameters 
seconds—
Specifies the interval, in seconds, between runs of an event.
Values—
30 to 42949672

 

minute

Syntax 
minute {minute-number [..minute-number] | all}
no minute
Context 
config>system>cron>sched
Description 

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.

Default 

no minute

Parameters 
minute-number—
Specifies the minute to schedule a command.
Values—
0 to 59 (maximum 60 minute-numbers)

 

all —
Specifies all minutes.

month

Syntax 
month {month-number [..month-number] | month-name [..month-name] | all}
no month
Context 
config>system>cron>sched
Description 

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.

Default 

no month

Parameters 
month-number—
Specifies a month number.
Values—
1 to 12 (maximum 12 month-numbers)

 

month-name—
Specifies a month by name.
Values—
january, february, march, april, may, june, july, august, september, october, november, december (maximum 12 month names)

 

all —
Specifies all months.

script-policy

Syntax 
script-policy policy-name [owner policy-owner]
no script-policy
Context 
config>system>cron>schedule
Description 

This command is used to configure the CLI script policy.

Parameters 
policy-name—
Specifies the name of the policy. Can be up to 32 characters.
policy-owner
Specifies the name of the policy owner. Can be up to 32 characters.

The owner is an arbitrary name and not necessarily a user name. Commands in the scripts are not authorized against the owner. The configure system security cli-script authorization x cli-user command determines the user context against which commands in the scripts are authorized.

Default—
“TiMOS CLI”

type

Syntax 
type schedule-type
Context 
config>system>cron>sched
Description 

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

Default 

type periodic

Parameters 
schedule-type—
Specifies the type of schedule for the system to interpret the commands contained within the schedule node.
Values—
periodic — Specifies a schedule which runs at a given interval. interval must be specified for this feature to run successfully. calendar — Specifies a schedule which runs based on a calendar. The weekday, month, day-of-month, hour and minute parameters must be specified for this feature to run successfully. oneshot — Specifies a schedule which runs one time only. As soon as the first event specified in these parameters takes place and the associated event occurs, the schedule enters a shutdown state. The month, weekday, day-of-month, hour and minute parameters must be specified for this feature to run successfully.

 

Default—
periodic

weekday

Syntax 
weekday {weekday-number [..weekday-number] | day-name [..day-name] | all}
no weekday
Context 
config>system>cron>sched
Description 

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.

Default 

no weekday

Parameters 
weekday-number
Specifies a weekday number.
Values—
1 to 7 (maximum 7 weekday-numbers)

 

day-name
Specifies a day by name.
Values—
sunday, monday, tuesday, wednesday, thursday, friday, saturday (maximum 7 weekday names)

 

all—
Specifies all days of the week.

5.16.2.12. Script Control Commands

script-control

Syntax 
script-control
Context 
config>system
Description 

This command enables the context to configure command script parameters.

script-policy

Syntax 
[no] script-policy policy-name [owner policy-owner]
Context 
config>system>script-control
Description 

This command is used to configure the CLI script policy.

Parameters 
policy-name—
Specifies the name of the policy. Can be up to 32 characters.
policy-owner
Specifies the name of the policy owner. Can be up to 32 characters.

The owner is an arbitrary name and not necessarily a user name. Commands in the scripts are not authorized against the owner. The configure system security cli-script authorization x cli-user command determines the user context against which commands in the scripts are authorized.

Default—
“TiMOS CLI”

expire-time

Syntax 
expire-time {seconds | forever}
Context 
config>system>script-control>script-policy
Description 

This command is used to configure the maximum amount of time to keep the run history status entry from a script run.

Default 

expire-time 3600

Parameters 
seconds—
Specifies the time to keep the run history status entry, in seconds.
Values—
0 to 21474836

 

Default—
3600 (1 hour)
forever—
Specifies to keep the run history status entry indefinitely.

lifetime

Syntax 
lifetime {seconds | forever}
Context 
config>system>script-control>script-policy
Description 

This command is used to configure the maximum amount of time that a script may run.

Default 

lifetime 3600

Parameters 
seconds—
Specifies the maximum amount of time that a script may run, in seconds.
Values—
0 to 21474836

 

Default—
3600 (1 hour)
forever—
Specifies to allow a script to run indefinitely.

max-completed

Syntax 
max-completed unsigned
Context 
config>system>script-control>script-policy
Description 

This command is used to configure the maximum number of script run history status entries to keep.

Default 

max-completed 1

Parameters 
unsigned—
Specifies the maximum number of script run history status entries to keep.
Values—
1 to 1500

 

Default—
1

results

Syntax 
results file-url
no results
Context 
config>system>script-control>script-policy
Description 

This command is used to specify the location where the system writes the output of an event script’s execution.

The no form of the command removes the file location from the configuration. Scripts will not execute if there is no result location defined.

Default 

no results

Parameters 
file-url—
Specifies the location to send CLI output from script runs. The file-url is a location, directory, and filename prefix to which a data and timestamp suffix is added when the results files are created during a script run, as follows: file-url_YYYYMMDD-hhmmss.uuuuuu.out where: YYYYMMDD — date hhmmss — hours, minutes, and seconds uuuuuu — microseconds (padded to 6 characters with leading zeros)
Values—
local-url | remote-url
local-url — [cflash-id/] [file-path] 167 chars max, including cflash-id file-path 166 chars max
remote url — [{ftp:// | tftp://}login:password@remote-location/][file-path] 255 characters max directory length 99 characters max each
remote-location — [hostname | ipv4-address | ipv6-address]
ipv4-address — a.b.c.d
ipv6-address — x:x:x:x:x:x:x:x[-interface] x:x:x:x:x:x:d.d.d.d[-interface] x — [0 to FFFF]H d — [0 to 255]D interface — 32 characters max, for link local addresses
cflash-id — cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

script

Syntax 
script script-name [owner script-owner]
no script
Context 
config>system>script-control>script-policy
config>system>script-control
Description 

This command is used to configure a script to be run.

The no form of the command removes the script.

Default 

no script

Parameters 
script-name—
Specifies the name of the script. Can be up to 32 characters.
script-owner
Specifies the name of the script owner. Can be up to 32 characters.

The owner is an arbitrary name and not necessarily a user name. Commands in the scripts are not authorized against the owner. The configure system security cli-script authorization x cli-user command determines the user context against which commands in the scripts are authorized.

Default—
“TiMOS CLI”

location

Syntax 
location file-url
no location
Context 
config>system>script-control>script
Description 

This command is used to identify the location of a script to be scheduled.

The no form of the command removes the location.

Default 

no location

Parameters 
file-url—
Specifies the location to search for scripts.
Values—
local-url | remote-url
local-url — [cflash-id/] [file-path] 200 chars max, including cflash-id directory length 99 characters max each
remote url — [{ftp:// | tftp://}login:password@remote-location/][file-path] 255 characters max directory length 99 characters max each
remote-location — [hostname | ipv4-address | ipv6-address]
ipv4-address — a.b.c.d
ipv6-address — x:x:x:x:x:x:x:x[-interface] x:x:x:x:x:x:d.d.d.d[-interface] x — [0 to FFFF]H d — [0 to 255]D interface — 32 characters max, for link local addresses
cflash-id — cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

5.16.2.13. System Synchronization Configuration Commands

sync-if-timing

Syntax 
sync-if-timing
Context 
config>system
Description 

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

abort

Syntax 
abort
Context 
config>system>sync-if-timing
Description 

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

begin

Syntax 
begin
Context 
config>system>sync-if-timing
Description 

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

bits

Syntax 
bits
Context 
config>system>sync-if-timing
Description 

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

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

input

Syntax 
input
Context 
config>system>sync-if-timing>bits
Description 

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

interface-type

Syntax 
interface-type {ds1 [{esf | sf}] | e1 [{pcm30crc | pcm31crc}]}
no interface-type
Context 
config>system>sync-if-timing>bits
Description 

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

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

Default 

interface-type ds1 esf

Parameters 
ds1 esf —
Specifies Extended Super Frame (ESF). This is a framing type used on DS1 circuits that consists of 24 192-bit frames, The 193rd bit provides timing and other functions.
ds1 sf—
Specifies Super Frame (SF), also called D4 framing. This is a common framing type used on DS1 circuits. SF consists of 12 192-bit frames. The 193rd bit provides error checking and other functions. ESF supersedes SF.
e1 pcm30crc—
Specifies the pulse code modulation (PCM) type. PCM30CRC uses PCM to separate the signal into 30 user channels with CRC protection.
e1 pcm31crc—
Specifies the pulse code modulation (PCM) type. PCM31CRC uses PCM to separate the signal into 31 user channels with CRC protection.

output

Syntax 
output
Context 
config>system>sync-if-timing>bits
Description 

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

line-length

Syntax 
line-length {110 | 220 | 330 | 440 | 550 | 660}
Context 
config>system>sync-if-timing>bits>output
Description 

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

Default 

line-length 110

Parameters 
110—
Specifies that the distance is from 0 to 110 feet.
220—
Specifies that the distance is from 110 to 220 feet.
330—
Specifies that the distance is from 220 to 330 feet.
440—
Specifies that the distance is from 330 to 440 feet.
550—
Specifies that the distance is from 440 to 550 feet.
660—
Specifies that the distance is from 550 to 660 feet.

ql-minimum

Syntax 
ql-minimum {prs | stu | st2 | tnc | st3e | st3 | prc | ssua | ssub | sec | eec1 | eec2}
no ql-minimum
Context 
config>system>sync-if-timing>bits>output
Description 

This command configures the minimum acceptable QL value that a signal must have in order to be selected for the BITSout port. This ensures that the signal has traceability to a source with at least this quality level so that attached equipment can function properly.

The no form of this command disables this check.

Default 

no ql-minimum

Parameters 
prs —
Specifies the SONET Primary Reference Source.
stu —
Specifies the SONET Synchronous Traceability Unknown.
st2 —
Specifies the SONET Stratum 2.
tnc —
Specifies the SONET Transit Node Clock.
st3e —
Specifies the SONET Stratum 3E.
st3 —
Specifies the SONET Stratum 3.
prc —
Specifies the SDH Primary Reference Clock.
ssua —
Specifies the SDH Primary Level Synchronization Supply Unit.
ssub —
Specifies the SDH Second Level Synchronization Supply Unit.
sec —
Specifies the SDH Synchronous Equipment Clock.
eec1 —
Specifies the Ethernet Equipment Clock Option 1 (sdh).
eec2 —
Specifies the Ethernet Equipment Clock Option 2 (sonet).

ql-minimum

Syntax 
ql-minimum {prs | stu | st2 | tnc | st3e | st3 | prc | ssua | ssub | sec | eec1 | eec2}
no ql-minimum
Context 
config>system>sync-if-timing
Description 

This command configures the minimum acceptable QL value that a signal must have in order to be considered for selection by the system timing module.

The no form of this command disables this check.

Default 

no ql-minimum

Parameters 
prs —
Specifies the SONET Primary Reference Source.
stu —
Specifies the SONET Synchronous Traceability Unknown.
st2 —
Specifies the SONET Stratum 2.
tnc —
Specifies the SONET Transit Node Clock.
st3e —
Specifies the SONET Stratum 3E.
st3 —
Specifies the SONET Stratum 3.
prc —
Specifies the SDH Primary Reference Clock.
ssua —
Specifies the SDH Primary Level Synchronization Supply Unit.
ssub —
Specifies the SDH Second Level Synchronization Supply Unit.
sec —
Specifies the SDH Synchronous Equipment Clock.
eec1 —
Specifies the Ethernet Equipment Clock Option 1 (sdh).
eec2 —
Specifies the Ethernet Equipment Clock Option 2 (sonet).

source

Syntax 
source {line-ref | internal-clock}
Context 
config>system>sync-if-timing>bits>output
Description 

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

Default 

source line-ref

Parameters 
line-ref—
Specifies that the BITS output timing is selected from one of the input references, without any filtering.
internal-clock—
Specifies that the BITS output timing is driven from the system timing.

squelch

Syntax 
[no] squelch
Context 
configure>system>sync-if-timing>bits>output
Description 

This command configures the behavior of the BITSout port when there is no valid reference selected. When enabled with no valid reference, no signal is sent out the port. When disabled with no valid reference, an AIS signal is presented along with the QL-DNU/TL-DUS SSM code if the signal format supports SSM.

Default 

no squelch

ssm-bit

Syntax 
ssm-bit sa-bit
Context 
config>system>sync-if-timing>bits
config>system>sync-if-timing>ref1   (7750 SR-c12 only)
config>system>sync-if-timing>ref2   (7750 SR-c12 only)
Description 

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

Default 

ssm-bit 8

Parameters 
sa-bit—
Specifies the sa-bit value.
Values—
4 to 8

 

commit

Syntax 
commit
Context 
config>system>sync-if-timing
Description 

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

ref-order

Syntax 
ref-order first second [third [fourth]]
no ref-order
Context 
config>system>sync-if-timing
Description 

The synchronous equipment timing subsystem can lock to different timing reference inputs, those specified in the ref1, ref2, bits and ptp (ptp applies only to the 7450 ESS and 7750 SR) command configuration. This command organizes the priority order of the timing references.

If a reference source is disabled, then the clock from the next reference source as defined by ref-order is used. If all reference sources are disabled, then clocking is derived from a local oscillator.

If a sync-if-timing reference is linked to a source port that is operationally down, the port is no longer qualified as a valid reference.

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

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

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

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

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

Default 

bits ref1 ref2 ptp (7750 SR and 7450 ESS)

bits ref1 ref2 (7950 XRS)

Parameters 
first—
Specifies the first timing reference to use in the reference order sequence.
Values—
ref1, ref2, bits, ptp

 

second—
Specifies the second timing reference to use in the reference order sequence.
Values—
ref1, ref2, bits, ptp

 

third—
Specifies the third timing reference to use in the reference order sequence.
Values—
ref1, ref2, bits, ptp

 

ptp

Syntax 
ptp
Context 
config>system>sync-if-timing
Description 

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

ql-override

Syntax 
ql-override {prs | stu | st2 | tnc | st3e | st3 | prc | ssua | ssub | sec}
no ql-override
Context 
config>system>sync-if-timing>bits
config>system>sync-if-timing>ptp
Description 

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

Default 

no ql-override

Parameters 
prs —
Specifies the SONET Primary Reference Source Traceable.
stu —
Specifies the SONET Synchronous Traceability Unknown.
st2 —
Specifies the SONET Stratum 2 Traceable.
tnc —
Specifies the SONET Transit Node Clock Traceable.
st3e —
Specifies the SONET Stratum 3E Traceable.
st3 —
Specifies the SONET Stratum 3 Traceable.
prc —
Specifies the SDH Primary Reference Clock Traceable.
ssua —
Specifies the SDH Primary Level Synchronization Supply Unit Traceable.
ssub —
Specifies the SDH Second Level Synchronization Supply Unit Traceable.
sec —
Specifies the SDH Synchronous Equipment Clock Traceable.

ql-override

Syntax 
ql-override {prs | stu | st2 | tnc | st3e | st3 | prc | ssua | ssub | sec | eec1 | eec2}
no ql-override
Context 
config>system>sync-if-timing>ref1 (7750 SR-c12 only)
config>system>sync-if-timing>ref2 (7750 SR-c12 only)
Description 

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

Default 

no ql-override

Parameters 
prs —
Specifies the SONET Primary Reference Source Traceable.
stu —
Specifies the SONET Synchronous Traceability Unknown.
st2 —
Specifies the SONET Stratum 2 Traceable.
tnc —
Specifies the SONET Transit Node Clock Traceable.
st3e —
Specifies the SONET Stratum 3E Traceable.
st3 —
Specifies the SONET Stratum 3 Traceable.
prc —
Specifies the SDH Primary Reference Clock Traceable.
ssua —
Specifies the SDH Primary Level Synchronization Supply Unit Traceable.
ssub —
Specifies the SDH Second Level Synchronization Supply Unit Traceable.
sec —
Specifies the SDH Synchronous Equipment Clock Traceable.
eec1 —
Specifies the Ethernet Equipment Clock Option 1 Traceable (sdh).
eec2 —
Specifies the Ethernet Equipment Clock Option 2 Traceable (sonet).

ql-selection

Syntax 
[no] ql-selection
Context 
config>system>sync-if-timing
Description 

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

Default 

no ql-selection

ref1

Syntax 
ref1
Context 
config>system>sync-if-timing
Description 

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

The restrictions on the location for the source port or source bits for ref1 and ref2 are listed in Ref1 and Ref2 Timing References.

bits-interface-type

Syntax 
bits-interface-type {ds1 [{esf | sf}] | e1 [{pcm30crc | pcm31crc}
no bits-interface-type
Context 
config>system>sync-if-timing>ref1
config>system>sync-if-timing>ref2
Description 

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

The no form of the command reverts to the default configuration

Parameters 
ds1 esf —
Specifies Extended Super Frame (ESF). This is a framing type used on DS1 circuits that consists of 24 192-bit frames, The 193rd bit provides timing and other functions.
ds1 sf—
Specifies Super Frame (SF), also called D4 framing. This is a common framing type used on DS1 circuits. SF consists of 12 192-bit frames. The 193rd bit provides error checking and other functions. ESF supersedes SF.
e1 pcm30crc—
Specifies the pulse code modulation (PCM) type. PCM30CRC uses PCM to separate the signal into 30 user channels with CRC protection.
e1 pcm31crc—
Specifies the pulse code modulation (PCM) type. PCM31CRC uses PCM to separate the signal into 31 user channels with CRC protection.

source-bits

Syntax 
source-bits slot/mda
no source-bits
Context 
config>system>sync-if-timing>ref1
config>system>sync-if-timing>ref2
Description 

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

Parameters 
slot/mda—
Specifies the chassis slot and MDA containing the BITS port to be used as one of the two timing reference sources in the system timing subsystem.
Values—
slot: 1 mda: 1 to 12

 

source-port

Syntax 
source-port port-id
no source-port
Context 
config>system>sync-if-timing>ref1
config>system>sync-if-timing>ref2
Description 

This command configures the source port for timing reference ref1 or ref2. If the port is unavailable or the link is down, then the reference sources are re-evaluated according to the reference order configured in the ref-order command.

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

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

Default 

no source-port

Parameters 
port-id—
Identifies the physical port in the slot/mda/port, esat-id/slot/port, or pxc-id.sub-port format.
Values—
slot/mda/port [.channel]

 

ref2

Syntax 
ref2
Context 
config>system>sync-if-timing
Description 

This command enables the context to configure parameters for the second timing reference. There are restrictions on the source-port and source-bits locations for ref2 based on the platform. The restrictions on the location for the source-port or source-bits for ref1 and ref2 are listed in Revertive, non-Revertive Timing Reference Switching Operation.

revert

Syntax 
[no] revert
Context 
config>system>sync-if-timing
Description 

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

Default 

no revert

wait-to-restore

Syntax 
wait-to-restore minutes
no wait-to-restore
Context 
config>system>sync-if-timing
Description 

This command configures the time for the Wait to Restore timer. A previously failed input reference must be valid for the time specified before it is used for either the BITSout or the central clock input reference.

The no form of this command disables the timer.

Default 

no wait-to-restore

Parameters 
wtr-time—
Specifies a value representing the number of minutes for the wait to restore timeout.
Values—
1 to 12

 

5.16.2.14. System Administration Commands

admin

Syntax 
admin
Context 
<root>
Description 

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

application-assurance

Syntax 
application-assurance
Context 
admin
Description 

This command enables the context to perform application-assurance operations.

group

Syntax 
group aa-group-id
Context 
admin>application-assurance
Description 

This command enables the context to perform a group-specific upgrade.

Parameters 
aa-group-id—
Specifies an AA ISA group ID.
Values—
1 to 255

 

url-list

Syntax 
url-list url-list-name upgrade
Context 
admin>application-assurance>group
Description 

This command upgrades the URL list.

Parameters 
url-list-name—
Specifies the application assurance URL list, up to 32 characters.

upgrade

Syntax 
upgrade
Context 
admin>app-assure
Description 

This command loads a new protocol list from the isa-aa.tim file into the CPM.

This command requires an ISA-AA reboot.

debug-save

Syntax 
debug-save [file-url]
Context 
admin
Description 

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

Parameters 
file-url—
Specifies the file URL location to save the debug configuration. If no file-url is specified then the debug configuration is saved at the same location as the standard configuration file (bof>primary-config/bof>secondary-config/bof>tertiary-config) with the same file name as the standard configuration file but with a .dbg suffix.
Note:

IPv6-address applies only to 7750 SR and 7950 XRS.

Values—

file url

local-url | remote-url: 255 chars max

local-url

[cflash-id/][file-path] 200 chars max, including cflash-id file-path 199 chars max

remote-url

[{ftp:// | tftp://}login:pswd@remote-locn/][file-path]

255 chars max

directory length 99 chars max each

remote-locn

{hostname | ipv4-address | [ipv6-address]}

ipv4-address

a.b.c.d

ipv6-address

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x - [0 to FFFF]H

d - [0 to 255]D

interface - 32 chars max, for link local addresses 255

cflash-id

cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

disconnect

Syntax 
disconnect [address ip-address | session-id session-id | username user-name | {console | bluetooth | telnet | ftp | ssh | netconf | grpc}]
Context 
admin
Description 

This command disconnects a user from a session.

Issuing the disconnect command without any parameters will disconnect the session in which the command was executed.

If any of the session type options (for example, console, bluetooth, telnet, FTP, SSH) are specified, then only the respective sessions are affected.

If no session type 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.

Parameters 
ip-address
Specifies the IP address to disconnect, specified in dotted decimal notation.
Note:

IPv6 is supported on the 7750 SR and 7950 XRS.

Values—

ipv4-address

a.b.c.d

ipv6-address

x:x:x:x:x:x:x:x (eight 16-bit pieces)

x:x:x:x:x:x:d.d.d.d

x - [0 to FFFF]H

d - [0 to 255]D

 

session-id—
The model-driven session ID. Can be obtained using the show system management-interface datastore-locks [detail] command.
user-name
Specifies the name of the user. The name can be up to 32 characters.
console—
Disconnects the console session.
bluetooth—
Disconnects the bluetooth session.
telnet—
Disconnects the Telnet session.
ftp—
Disconnects the FTP session.
ssh—
Disconnects the SSH session.
netconf—
Disconnects the NETCONF session.
grpc—
Disconnects the GRPC session.

display-config

Syntax 
display-config [detail | index]
Context 
admin
Description 

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.

Parameters 
detail—
Displays default and non-default configuration parameters.
index—
Displays only persistent-indices.

enable-tech

Syntax 
[no] enable-tech
Context 
admin
Description 

This command enables the shell and kernel commands.

Note:

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

nat

Syntax 
nat
Context 
admin
Description 

This command performs NAT operations.

save-deterministic-script

Syntax 
save-deterministic-script
Context 
admin>nat
Description 

This command saves the script that calculates deterministic NAT map entries.

reboot

Syntax 
reboot [active | standby | upgrade] [hold] [now]
Context 
admin
Description 

This command reboots the router or one CPM and can also be used to force an upgrade of the system boot ROMs.

If no options are specified, the user is prompted to confirm the reboot operation. Answering yes (y) will result in both CPMs and all IOMs rebooting.

ALA-1>admin# reboot
Are you sure you want to reboot (y/n)?
Parameters 
active—
Reboots the active CPM.
Default—
active
standby—
Reboots the standby CPM.
Default—
active
upgrade—
Forces card firmware to be upgraded during chassis reboot. Normally, the SR-series router OS automatically performs firmware upgrades on CPMs and XCM/IOM cards without the need for the upgrade keyword. The automatic upgrade must be enabled in the SR OS7 Command Line Interface (CLI) when rebooting the system.

When the upgrade keyword is specified, a chassis flag is set for the BOOT Loader (boot.ldr) and on the subsequent boot of the OS on the chassis, firmware images on CPMs, XCMs, or IOMs will be upgraded automatically.

Any CPMs, XCMs, or IOMs that are installed in the chassis will be upgraded automatically. For example, if a card is inserted with down revision firmware as a result of a card hot swap with the latest OS version running, the firmware on the card will be automatically upgraded before the card is brought online.

If the card firmware is upgraded automatically, a chassis cardUpgraded (event 2032) log event is generated. The corresponding SNMP trap for this log event is tmnxEqCardFirmwareUpgraded.

During any firmware upgrade, automatic or manual, it is imperative that during the upgrade procedure:

  1. Power must not be switched off or interrupted.
  2. The system must not be reset.
  3. No cards are inserted or removed.

Any of the above conditions may render cards inoperable requiring a return of the card for resolution.

The time required to upgrade the firmware on the cards in the chassis depends on the number of cards to be upgraded. The progress of a firmware upgrade can be monitored at the console.

hold—
Administratively holds a rebooted standby SF/CPM from coming back online. Both the control processor (CPM) and the switch fabric (SFM) of the standby SF/CPM are held out of service. This may be useful for troubleshooting purposes (e.g. standby SF/CPM is suspected of causing some system problems). The SF/CPM should not be left offline as the system does not have control or switch fabric redundancy while one SF/CPM is offline. The SF/CPM must be rebooted again (without the hold keyword) to return it to service. This parameter applies only to the SF/CPM3 and SF/CPM4 on the 7450 ESS and 7750 SR platforms. Note that on platforms such as the 7750 SR-12e and 7950 XRS, and on the 7450/7750 SFM5/CPM5, the SFMs are modeled as separate entities and can be administratively disabled by using the configure sfm x shutdown command.
now—
Forces a reboot of the router immediately without an interactive confirmation.

reset-policy-exclusive

Syntax 
reset-policy-exclusive
Context 
admin
Description 

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

satellite

Syntax 
satellite [eth-sat sat-id] [reboot] [upgrade] [now]
satellite [eth-sat sat-id] [sync-boot-env]
satellite [eth-sat sat-id] [tech-support file-url]
Context 
admin
Description 

This command can be used to perform administrative functions on the specified Ethernet-satellite chassis.

If the reboot keyword is specified, the command initiates an administrative reboot of the specified Ethernet-satellite chassis.

If the sync-boot-env keyword is specified, the command forces the specified Ethernet-satellite chassis to synchronize the boot image.

If the tech-support keyword is specified, the command creates a system core dump. If the file-url parameter is omitted and a ts-location is defined, the SR OS automatically generates a file name for the tech-support file based on the system name, date and time. The file is saved to the directory indicated by the configured ts-location. See the command description of ts-location on page 494 for more information.

The format of the auto-generated filename is ts-XXXXX.YYYYMMDD.HHMMUTC.dat where:

  1. XXXXX: system name with special characters expanded to avoid problems with file systems (for example, a '.' is expanded to %2E.)
  2. YYYYMMDD: Date with leading zeros on year, month and day
  3. HHMM: Hours and Minutes in UTC time (24hr format, always 4 chars, with leading zeros on hours and minutes)
Note:

The satellite [eth-sat sat-id] [tech-support file-url] command should only be used with authorized direction from the Nokia Technical Assistance Center (TAC).

Parameters 
sat-id
Specifies the Ethernet-satellite chassis.
file-url—
Specifies the file URL location to save the configuration file.
Values—

local-url | remote-url

local-url

[cflash-id/][file-path] 200 chars max, including cflash-id

directory length 99 chars max each

remote-url

[ftp://login:pswd@remote-locn/][file-path]

247 chars max

directory length 99 chars max each

 

now—
Causes the satellite to reboot immediately without further prompts or interactive confirmation.
reboot—
Initiates a satellite reboot.
sync-boot-env—
Causes the specified Ethernet-satellite chassis to synchronize the boot image.
upgrade—
Causes the satellite to update its firmware image during chassis reboot.

save

Syntax 
save [file-url] [detail] [index]
Context 
admin
Description 

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

A:ALA-1>admin# save ftp://test:test@192.168.x.xx/./100.cfg
Saving configuration .........Completed.

An admin save operation initiated by a user is aborted if another user initiates another admin save from another session.

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

Parameters 
file-url—
Specifies the file URL location to save the configuration file.
Values—

local-url | remote-url

local-url

[cflash-id/][file-path] 200 chars max, including cflash-id

directory length 99 chars max each

remote-url

[{ftp:// | tftp://}login:pswd@remote-locn/][file-path]

243 chars max

directory length 99 chars max each

remote-locn

[hostname | ipv4-address | ipv6-address]

ipv4-address

a.b.c.d

ipv6-address

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x - [0 to FFFF]H

d - [0 to 255]D

interface - 32 chars max, for link local addresses

cflash-id

cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

Default—
the primary configuration file location
detail—
Saves both default and non-default configuration parameters.
index—
Forces a save of the persistent index file regardless of the persistent status in the BOF file. The index option can also be used to avoid an additional boot required while changing your system to use the persistence indices.

save

Syntax 
save [file-url] [detail] [index]
Context 
admin
Description 

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

A:ALA-1>admin# save ftp://test:test@192.168.x.xx/./100.cfg
Saving configuration .........Completed.

An admin save operation initiated by a user is aborted if another user initiates another admin save from another session.

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

Parameters 
file-url—
Specifies the file URL location to save the configuration file.
Values—

local-url | remote-url

local-url

[cflash-id/][file-path] 200 chars max, including cflash-id

directory length 99 chars max each

remote-url

[ftp://login:pswd@remote-locn/][file-path]

247 chars max

directory length 99 chars max each

remote-locn

[hostname | ipv4-address | "["ipv6-address"]"]

ipv4-address

a.b.c.d

ipv6-address

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x - [0 to FFFF]H

d - [0 to 255]D

interface - 32 chars max, for link local addresses

cflash-id

cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

Default—
the primary configuration file location
detail—
Saves both default and non-default configuration parameters.
index—
Forces a save of the persistent index file regardless of the persistent status in the BOF file. The index option can also be used to avoid an additional boot required while changing your system to use the persistence indices.

satellite

Syntax 
satellite [eth-sat sat-id] [reboot] [upgrade] [now]
satellite [eth-sat sat-id] [sync-boot-env]
satellite [eth-sat sat-id] [tech-support file-url]
Context 
admin
Description 

This command can be used to perform administrative functions on the specified Ethernet-satellite chassis.

If the reboot keyword is specified, the command initiates an administrative reboot of the specified Ethernet-satellite chassis.

If the sync-boot-env keyword is specified, the command forces the specified Ethernet-satellite chassis to synchronize the boot image.

If the tech-support keyword is specified, the command creates a system core dump. If the file-url parameter is omitted and a ts-location is defined, the SR OS automatically generates a file name for the tech-support file based on the system name, date and time. The file is saved to the directory indicated by the configured ts-location. See the command description of ts-location on page 494 for more information.

The format of the auto-generated filename is ts-XXXXX.YYYYMMDD.HHMMUTC.dat where:

  1. XXXXX: system name with special characters expanded to avoid problems with file systems (for example, a '.' is expanded to %2E.)
  2. YYYYMMDD: Date with leading zeros on year, month and day
  3. HHMM: Hours and Minutes in UTC time (24hr format, always 4 chars, with leading zeros on hours and minutes)
Note:

The satellite [eth-sat sat-id] [tech-support file-url] command should only be used with authorized direction from the Nokia Technical Assistance Center (TAC).

Parameters 
sat-id
Specifies the Ethernet-satellite chassis.
Values—
1 to 20

 

file-url—
Specifies the file URL location to save the configuration file.
Values—

local-url | remote-url

local-url

[cflash-id/][file-path] 200 chars max, including cflash-id

directory length 99 chars max each

remote-url

[ftp://login:pswd@remote-locn/][file-path]

247 chars max

directory length 99 chars max each

 

now—
Causes the satellite to reboot immediately without further prompts or interactive confirmation.
reboot—
Initiates a satellite reboot.
sync-boot-env—
Causes the specified Ethernet-satellite chassis to synchronize the boot image.
upgrade—
Causes the satellite to update its firmware image during chassis reboot.

tech-support

Syntax 
tech-support [file-url]
Context 
admin
Description 

This command creates a system core dump. If the file-url is omitted, and a ts-location is defined, then the tech support file will have an automatic SR OS generated file name based on the system name and the date and time and 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:

  1. XXXXX: system name with special characters expanded to avoid problems with file systems (for example, a '.' is expanded to %2E.)
  2. YYYYMMDD: Date with leading zeros on year, month and day
  3. HHMM: Hours and Minutes in UTC time (24hr format, always 4 chars, with leading zeros on hours and minutes)
Note:

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

Parameters 
file-url—
Specifies the file URL location to save the binary file.
Values—

local-url | remote-url

local-url

[cflash-id/][file-path] 200 chars max, including cflash-id

directory length 99 chars max each

remote-url

[{ftp:// | tftp://}login:pswd@remote-locn/][file-path]

199 chars max

remote-locn

[hostname | ipv4-address | ipv6-address]

ipv4-address

a.b.c.d

ipv6-address

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x - [0 to FFFF]H

d - [0 to 255]D

interface - 32 chars max, for link local addresses

cflash-id

cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

license

Syntax 
license
Context 
admin>system
Description 

Enters a context for administrative commands related to licensing.

activate

Syntax 
activate [file-url] [now]
Context 
admin>system>license
Description 

This command performs an activation on the license file pointed to by the command line argument. The file is first validated as described in the admin>system>license>validate command and upon success, replaces the existing license attributes in the system with the information in the new license file.

The license attributes that are active on a system can be viewed with the show>licensing>entitlements command.

Note:

If the CLM tool is being used for license management, it shall perform the validation and activation and there is no need to enter these commands manually.

Parameters 
file-url—
Specifies the file URL location to read the license file.
Values—
local-url, remote-url
Note:

IPv6 address apply only to 7750 SR and 7950 XRS.

 

now—
If the now keyword is not present, the operator is prompted to confirm the activation. With the now keyword the license file is activated without the additional prompt.

validate

Syntax 
validate [file-url]
Context 
admin>system>license
Description 

This command performs a validation on the license file pointed to by the command line argument. A validation ensures that the license is compatible with the current state of the target system but it does not change the existing license. Aspects that can cause a failure in the validation include:

  1. The license file was created for a different target system. The UUID encoded into the file must match that defined by the specific hardware platform.
  2. The license file does not include license information for the release of software currently running on the system.
  3. The current date/time reported to system is outside the validity period encoded in the license.
  4. The system is currently using a hardware upgrade license that is not included in the new file being validated.
Note:

If the CLM tool is being used for license management, it shall perform the validation and activation and there is no need to enter these commands manually.

Parameters 
file-url—
Specifies the file URL location to read the license file.
Values—
local-url, remote-url
Note:

IPv6 address apply only to 7750 SR and 7950 XRS.

 

ts-location

Syntax 
ts-location file-url
no ts-location
Context 
config>system>security>tech-support
Description 

The ts-location command is used (along with an automatic system generated file name) when no file-url parameter is provided for the admin tech-support command. If no ts-location is defined then the operator must provide a file-url with the admin tech-support command itself.

The directory specified for the ts-location is not auto-created by SR OS. The operator must ensure that it exists.

See the admin tech-support command for more details about the system generated file name.

Default 

no ts-location

Parameters 
file-url—
Specifies the destination directory for auto-named tech-support files (when no file-url is specified with the 'admin tech-support' command). The file-url for the ts-location must be a directory (no filename or extension). The root directory (for example, cf1:\) is blocked for local compact flash destinations. A sub-directory (for example, cf2:\tech-support) must be used if local cf is the location.
Values—

local-url | remote-url

local-url

[cflash-id/][file-path] 200 chars max, including cflash-id

directory length 99 chars max each

remote-url

[ftp://login:pswd@remote-locn/][file-path]

247 chars max

directory length 99 chars max each

remote-locn

[hostname | ipv4-address | "["ipv6-address"]" ]

ipv4-address

a.b.c.d

ipv6-address

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x - [0 to FFFF]H

d - [0 to 255]D

interface - 32 chars max, for link local addresses

cflash-id

cf1:, cf1-A:, cf1-B:, cf2:, cf2-A:, cf2-B:, cf3:, cf3-A:, cf3-B:

 

view

Syntax 
view {bootup-cfg | active-cfg | candidate-cfg | latest-rb| checkpoint-id | rescue}
Context 
<root>
Description 

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

Parameters 
bootup-cfg—
Specifies the bootup configuration.
active-cfg—
Specifies current running configuration.
candidate-cfg—
Specifies candidate configuration.
latest-rb—
Specifies the latest configuration.
checkpoint-id
Specifies a specific checkpoint file configuration.
Values—
1 to 9

 

rescue—
Specifies a rescue checkpoint configuration.

5.16.2.15. Redundancy Commands

redundancy

Syntax 
redundancy
Context 
admin
config
Description 

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

cert-sync

Syntax 
[no] cert-sync
Context 
admin>redundancy
configure>redundancy
Description 

This command automatically synchronizes the certificate/CRL/key when importing or generating (for the key). Also if a new CF card is inserted into slot3 into the backup CPM, the system will sync the whole system-pki directory from the active CPM.

Default 

enabled

force-switchover

Syntax 
force-switchover [now] [ignore-status]
Context 
admin>redundancy
Description 

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

Parameters 
now—
Forces the switchover to the redundant CPM card immediately.
ignore-status—
Forces a switchover despite any diagnostics or conditions on the standby. For the 7950 XRS, this is true even if the standby cannot reach the extension CPMs on the extension chassis of an XRS-40 via its local CPM interconnect ports).

rollback-sync

Syntax 
rollback-sync
Context 
admin>redundancy
Description 

This command copies the entire set of rollback checkpoint files from the active CPM CF to the standby CPM CF.

synchronize

Syntax 
synchronize cert
synchronize {boot-env | config}
Context 
admin>redundancy
Description 

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

In the admin>redundancy context, this command performs a manually triggered standby CPM synchronization. When the standby CPM takes over operation following a failure or reset of the active CPM, it is important to ensure that the active and standby CPM have identical operational parameters. This includes the saved configuration, CPM, XCM, and IOM images.

The active CPM ensures that the active configuration is maintained on the standby CPM. However, to ensure smooth operation under all circumstances, runtime images and system initialization configurations must also be automatically synchronized between the active and standby CPM. 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).

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

Default 

no synchronize

Parameters 
cert—
Synchronizes the imported certificate/key/CRL files to the standby CPM.
boot-env—
Synchronizes all files required for the boot process (loader, BOF, images, and config).
config—
Synchronizes only the primary, secondary, and tertiary configuration files.

mgmt-ethernet

Syntax 
mgmt-ethernet [revert seconds]
no mgmt-ethernet
Context 
config>redundancy
Description 

If the management Ethernet port on the active CPM goes down, this command allows the active CPM to be configured to use the management Ethernet port of the standby CPM.

The revert option allows the administrator to control when to revert back to the management Ethernet port of the primary CPM once it comes up again.

The no form of the command disables redundancy, so that connectivity to the active CPM is lost if its Ethernet port goes down.

This feature is not supported on the 7750 SR-a, 7750 SR-c, 7750-e, and the VSR platforms.

Default 

no mgmt-ethernet

Parameters 
seconds—
Specifies the duration to wait (in seconds) before reverting back to the primary CPM’s management Ethernet port.
Values—
1 to 300

 

multi-chassis

Syntax 
multi-chassis
Context 
config>redundancy
Description 

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

bgp-multi-homing

Syntax 
bgp-multi-homing
Context 
config>redundancy
Description 

This command configures BGP multi-homing parameters.

boot-timer

Syntax 
boot-timer seconds
no boot-timer
Context 
config>redundancy>bgp-multi-homing
Description 

This command configures the time the service manager waits after a node reboot before running the DF election algorithm. The boot-timer value should be configured to allow for the BGP sessions to come up and for the NLRI information to be refreshed/exchanged.

The no form of the command reverts the default.

Default 

no boot-timer

Parameters 
seconds—
Specifies the BGP multi-homing boot-timer in seconds.
Values—
0 to 600

 

site-activation-timer

Syntax 
site-activation-timer seconds
no site-activation-timer
Context 
config>redundancy>bgp-multi-homing
Description 

This command defines the amount of time the service manager will keep the local sites in standby status, waiting for BGP updates from remote PEs before running the DF election algorithm to decide whether the site should be unblocked. The timer is started when one of the following events occurs if the site is operationally up:

  1. Manual site activation using the no shutdown command at site-id level or at member object(s) level (SAP(s) or PW(s))
  2. Site activation after a failure
Default 

no site-activation-timer

Parameters 
seconds—
Specifies the standby status in seconds.
Values—
0 to 100

 

Default—
2

site-min-down-timer

Syntax 
site-min-down-timer seconds
no site-min-down-timer
Context 
config>redundancy>bgp-multi-homing
Description 

This command configures the BGP multi-homing site minimum down time. When set to a non-zero value, if the site goes operationally down it will remain operationally down for at least the length of time configured for the site-min-down-timer, regardless of whether other state changes would have caused it to go operationally up. This timer is restarted every time that the site transitions from up to down.

The above operation is optimized in the following circumstances:

  1. If the site goes down on the designated forwarder but there are no BGP multi-homing peers with the same site in an UP state, then the site-min-down-timer is not started and is not used.
  2. If the site goes down on the designated forwarder but there are no active BGP multi-homing peers, then the site-min-down-timer is not started and is not used.
  3. If the site-min-down-timer is active and a BGP multi-homing update is received from the designated forwarder indicating its site has gone down, the site-min-down-timer is immediately terminated and this PE becomes the designated forwarder if the BGP multi-homing algorithm determines it should be the designated forwarder.

The no form of the command reverts to default value.

Default 

no site-min-down-timer

Parameters 
seconds —
Specifies the time, in seconds, that a BGP multi-homing site remains operationally down after a transition from up to down.
Values—
1 to 100

 

Default—
0

bgp-evpn-multi-homing

Syntax 
bgp-evpn-multi-homing
Context 
config>redundancy
Description 

This command configures BGP EVPN multi-homing parameters.

boot-timer

Syntax 
boot-timer seconds
no boot-timer
Context 
config>redundancy>bgp-evpn-multi-homing
Description 

This command configures the time the service manager waits after a node reboot before running the DF election algorithm. The boot-timer value should be configured to allow for the BGP sessions to come up and for the NLRI information to be refreshed/exchanged.

The no form of the command reverts the default.

Default 

no boot-timer

Parameters 
seconds—
Specifies the BGP multi-homing boot-timer in seconds.
Values—
1 to 600

 

Default—
10

es-activation-timer

Syntax 
es-activation-timer seconds
Context 
config>redundancy>bgp-evpn-multi-homing
Description 

This command defines the amount of time the service manager will keep the local sites in standby status, waiting for BGP updates from remote PEs before running the DF election algorithm to decide whether the site should be unblocked. The timer is started when one of the following events occurs if the site is operationally up:

  1. Manual site activation using the no shutdown command at site-id level or at member object(s) level (SAP(s) or PW(s))
  2. Site activation after a failure
Parameters 
seconds—
Specifies the standby status in seconds.
Values—
0 to 100

 

Default—
3

rollback-sync

Syntax 
[no] rollback-sync
Context 
config>redundancy
Description 

The operator can enable automatic synchronization of rollback checkpoint files between the active CPM and standby CPM. When this automatic synchronization is enabled, a rollback save will cause the new checkpoint file to be saved on both the active and standby CPMs. The suffixes of the old checkpoint files on both active and standby CPMs are incremented. Note that automatic sync only causes the one new checkpoint file to be copied to both CFs (the other 9 checkpoints are not automatically copied from active to standby but that can be done manually with admin red rollback-sync).

Automatic synchronization of rollback checkpoint files across CPMs is only performed if the rollback-location is configured as a local file-url (for example, "cf3:/rollback-files/rollback). Synchronization is not done if the rollback-location is remote.

The config red sync {boot-env | config} and admin red sync {boot-env | config} do not apply to rollback checkpoint files. These commands do not manually or automatically sync rollback checkpoint files. The dedicated rollback-sync commands must be used to sync rollback checkpoint files.

Default 

no rollback-sync

synchronize

Syntax 
synchronize {boot-env | config}
Context 
config>redundancy
Description 

This command performs a synchronization of the standby CPMs images and/or config files to the active CPM. Either the boot-env or config parameter must be specified. In the config>redundancy context, this command performs an automatically triggered standby CPM synchronization. When the standby CPM takes over operation following a failure or reset of the active CPM, it is important to ensure that the active and standby CPMs have identical operational parameters. This includes the saved configuration, CPM, XCM, and IOM images.

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

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

Default 

no synchronize

Parameters 
boot-env—
Synchronizes all files required for the boot process (loader, BOF, images, and config).
config—
Synchronizes only the primary, secondary, and tertiary configuration files.
Default—
config

5.16.2.15.1. Peer Commands

peer

Syntax 
peer ip-address [create]
no peer ip-address
Context 
config>redundancy>multi-chassis
Description 

This command configures a multi-chassis redundancy peer.

Parameters 
ip-address—
Specifies a peer IP address. Multicast addresses are not allowed.
Values—
ipv4-address: a.b.c.d
ipv6-address:
  1. x:x:x:x:x:x:x:x (eight 16-bit pieces)
  2. x:x:x:x:x:x:d.d.d.d
  3. x: [0 to FFFF] H
  4. d: [0 to 255] D

 

authentication-key

Syntax 
authentication-key [authentication-key | hash-key] [hash | hash2]
no authentication-key
Context 
config>redundancy>multi-chassis>peer
Description 

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.

Default 

no authentication-key

Parameters 
authentication-key—
Specifies the authentication key. Allowed values are any string up to 20 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.
hash-key—
Specifies the hash key. The key can be any combination of ASCII characters up to 33 (hash1-key) or 55 (hash2-key) characters in length (encrypted). If spaces are used in the string, enclose the entire string in quotation marks (“ ”).
hash—
Specifies the key is entered in an encrypted form. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified
hash2—
Specifies the key is entered in a more complex encrypted form that involves more variables than the key value alone, meaning that the hash2 encrypted variable cannot be copied and pasted. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.

diameter-proxy

Syntax 
[no] diameter-proxy
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command synchronizes diameter proxy.

Default 

no diameter-proxy

igmp

Syntax 
[no] igmp
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command specifies whether IGMP protocol information should be synchronized with the multi-chassis peer.

Default 

no igmp

igmp-snooping

Syntax 
[no] igmp-snooping
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command specifies whether IGMP snooping information should be synchronized with the multi-chassis peer.

Default 

no igmp-snooping

ipsec

Syntax 
[no] ipsec
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command synchronizes IPsec information.

Default 

no ipsec

l2tp

Syntax 
[no] l2tp
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command synchronizes L2TP.

Default 

no l2tp

local-dhcp-server

Syntax 
[no] local-dhcp-server
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command synchronizes DHCP server information.

Default 

no local-dhcp-server

mc-ring

Syntax 
[no] mc-ring
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command synchronizes multi-chassis ring information.

Default 

no mc-ring

mld-snooping

Syntax 
[no] mld-snooping
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command is not supported. It is not blocked for backwards-compatibility reasons but has no effect on the system if configured.

Default 

no mld-snooping

peer-name

Syntax 
peer-name name
no peer-name
Context 
config>redundancy>multi-chassis>peer
Description 

This command specifies a peer name.

Default 

no peer-name

Parameters 
name—
Specifies the string may be up to 32 characters long. Any printable, seven-bit ASCII characters can be used within the string. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

pim-snooping

Syntax 
pim-snooping [saps] [spoke-sdps]
no pim-snooping
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command specifies whether PIM snooping for IPv4 information should be synchronized with the multi-chassis peer. Entering only pim-snooping (without any parameter) results in the synchronization being applicable only to SAPs.

Default 

no pim-snooping

Parameters 
saps—
Specifies that SAPs are to be synchronized with the multi-chassis peer relating to sync-tags configured on ports. This is the default when no parameters are included.
spoke-sdps—
Specifies that spoke SDPs are to be synchronized with the multi-chassispeer according to the synchronization tags configured on spoke SDPs.

port

Syntax 
port port-id [sync-tag sync-tag] [create]
no port port-id]
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command specifies the port to be synchronized with the multi-chassis peer and a synchronization tag to be used while synchronizing this port with the multi-chassis peer.

Parameters 
port-id—
Specifies the port to be synchronized with the multi-chassis peer.
Values—

port-id

slot/mda/port

lag-id

lag-id

lag

keyword

id

1 to 200

pw-id

pw-id

pw

keyword

id

1 to 10239

 

sync-tag
Specifies a synchronization tag, up to 32 characters in length, to be used while synchronizing this port with the multi-chassis peer.
create—
Creates an entry; mandatory while creating an entry.

range

Syntax 
range encap-range sync-tag sync-tag
no range encap-range
Context 
config>redundancy>multi-chassis>peer>sync>port
Description 

This command configures a range of encapsulation values.

Parameters 
encap-range—
Specifies a range of encapsulation values on a port to be synchronized with a multi-chassis peer.
Values—

Dot1Q

start-qtag-end-qtag

start-qtag

0 to 4094

end-qtag

0 to 4094

QinQ

qtag1.start-qtag2.end-qtag2-start-qtag1.*-end-qtag1.*

qtag1

1 to 4094

start-qtag1

1 to 4094

end-qtag1

1 to 4094

start-qtag2

0 to 4094

end-qtag2

0 to 4094

 

sync-tag
Specifies a synchronization tag up to 32 characters in length to be used while synchronizing this encapsulation value range with the multi-chassis peer.

python

Syntax 
python
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command enables syncing of python-policy cached entries to the peer.

Use the mcs-peer command in the python-policy to enable syncing for a specific python-policy.

Default 

no python

sdp

Syntax 
sdp sdp-id [sync-tag sync-tag] [create]
no sdp sdp-id
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command specifies the SDP to be synchronized with multi-chassis peer.

Parameters 
sdp-id—
Specifies the SDP of the spoke SDPs to be synchronized with the multi-chassispeer.
Values—
1 to 17407

 

sync-tag—
Specifies a synchronization tag, up to 32 characters in length, to be usedwhen synchronizing with the multi-chassis peer.
create—
Creates an entry; mandatory while creating an entry.

range

Syntax 
range vc-id-range sync-tag sync-tag
no range vc-id-range
Context 
config>redundancy>multi-chassis>peer>sync>sdp
Description 

This command configures a range of VC-ID values.

Parameters 
vc-id-range—
Specifies a range of VC-ID values on an to be synchronized with a multi-chassis peer.
Values—

vc-id-range

start-vc-id-end-vc-id

start-vc-id

1 to 4294967295

end-vc-id

1 to 4294967295

 

sync-tag
Specifies a synchronization tag up to 32 characters in length to be used while synchronizing this encapsulation value range with the multi-chassis peer.

source-address

Syntax 
source-address ip-address
no source-address
Context 
config>redundancy>multi-chassis>peer
Description 

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

Default 

no source-address

Parameters 
ip-address—
Specifies the source address used to communicate with the multi-chassis peer.
Values—
ipv4-address: a.b.c.d
ipv6-address:
  1. x:x:x:x:x:x:x:x (eight 16-bit pieces)
  2. x:x:x:x:x:x:d.d.d.d
  3. x - [0 to FFFF] H
  4. d - [0 to 255] D

 

sync

Syntax 
[no] sync
Context 
config>redundancy>multi-chassis>peer
Description 

This command enables the context to configure synchronization parameters.

srrp

Syntax 
[no] srrp
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command specifies whether subscriber routed redundancy protocol (SRRP) information should be synchronized with the multi-chassis peer.

Default 

no srrp

sub-mgmt

Syntax 
sub-mgmt [ipoe] [pppoe]
no sub-mgmt
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command specifies whether subscriber management information should be synchronized with the multi-chassis peer.

Default 

no sub-mgmt

Parameters 
ipoe—
Specifies to synchronize IPoE subscribers. The use of the keyword must match on both nodes, otherwise the subscriber synchronization fails.
pppoe—
Specifies to synchronize PPPoE subscribers. The use of the keyword must match on both nodes, otherwise the subscriber synchronization fails.

sub-host-trk

Syntax 
[no] sub-host-trk
Context 
config>redundancy>multi-chassis>peer>sync
Description 

This command specifies whether subscriber host tracking information should be synchronized with the multi-chassis peer.

Default 

no sub-host-trk

warm-standby

Syntax 
warm-standby
Context 
config>redundancy>multi-chassis>peer
Description 

This command enables Oversubscribed Multi-Chassis Redundancy (OMCR). Subscriber hosts are synchronized between two chassis only in the control plane and are kept there (as part of the Multi-Chassis Synchronization (MCS) state) until the switchover occurs. Link or nodal failure will trigger the switchover at which point the subscriber hosts are being fully instantiated in the control and the forwarding plane. This approach allows oversubscription of the resources in the central standby (or protecting) node that is backing-up a number of other active nodes. The total number of protected subscribers in the OMCR cluster exceeds the forwarding capacity of the protecting node. This is achievable by not fully occupying the resources for the subscriber hosts until the failure occurs.

The restoration times depend on the amount of the subscriber hosts that are affected by the switchover and it is related to the time needed for the full instantiation of the subscribers in the forwarding plane.

Although this command is configured on a peer level, the warm-standby property is a nodal characteristic. In other words, mixing of N:1 and 1:1 (hot standby) mode in the central standby node is not supported. Consequently all peers on the central standby node must be configured for warm-standby (N:1), or all peers must be configured for hot-standby (1:1) by omitting the warm-standby keyword from the configuration.

The peer of the central-backup node is not aware of the redundancy model supported. In in other words, the peer of the central-backup node does not know whether it peers with a warm-standby peer or host-standby-peer. All nodes participating in this protection model must run SR OS 12.0 or higher.

This command applies only to the 7450 ESS and 7750 SR.

Default 

no warm-standby

5.16.2.15.2. Multi-Chassis Endpoint Commands

mc-endpoint

Syntax 
[no] mc-endpoint
Context 
config>redundancy>multi-chassis>peer
Description 

This command specifies that the endpoint is multi-chassis. This value should be the same on both MC-EP peers for the pseudowires that must be part of the same group.

The no form of this command removes the endpoint from the MC-EP. Single chassis behavior applies.

Default 

no mc-endpoint

bfd-enable

Syntax 
[no] bfd-enable
Context 
config>redundancy>multi-chassis>peer>mc-ep
config>router>rsvp
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
config>redundancy>multi-chassis>peer>mc-ep
Description 

This command enables the use of bi-directional forwarding (BFD) to control the state of the associated protocol interface. By enabling BFD on a given protocol interface, the state of the protocol interface is tied to the state of the BFD session between the local node and the remote node. The parameters used for the BFD are set via the BFD command under the IP interface.

The no form of this command disables BFD.

Default 

no bfd-enable

boot-timer

Syntax 
boot-timer interval
no boot-timer
Context 
config>redundancy>multi-chassis>peer>mc-ep
Description 

This command configures the boot timer interval. This command applies only when the node reboots. It specifies the time the MC-EP protocol keeps trying to establish a connection before assuming a failure of the remote peer. This is different from the keep-alives mechanism which is used just after the peer-peer communication was established. After this time interval passed all the mc-endpoints configured under services will revert to single chassis behavior, activating the best local PW.

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

Default 

no boot-timer

Parameters 
interval—
Specifies the boot timer interval.
Values—
1 to 600

 

hold-on-neighbor-failure

Syntax 
hold-on-neighbor-failure multiplier
no hold-on-neighbor-failure
Context 
config>redundancy>multi-chassis>peer>mc-ep
Description 

This command specifies the number of keep-alive intervals that the local node will wait for packets from the MC-EP peer before assuming failure. After this time interval passed the all the mc-endpoints configured under services will revert to single chassis behavior, activating the best local pseudowire.

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

Default 

no hold-on-neighbor-failure

Parameters 
multiplier—
Specifies the hold time applied on neighbor failure.
Values—
2 to 25

 

keep-alive-interval

Syntax 
keep-alive-interval interval
no keep-alive-interval
Context 
config>redundancy>multi-chassis>peer>mc-ep
Description 

This command sets the interval at which keep-alive messages are exchanged between two systems participating in MC-EP when bfd is not enabled or is down. These fast keep-alive messages are used to determine remote-node failure and the interval is set in deci-seconds.

The no form of this command sets the interval to default value

Default 

no keep-alive-interval

Parameters 
interval—
Specifies the time interval expressed in deciseconds.
Values—
5 to 500 (tenths of a second)

 

passive-mode

Syntax 
[no] passive-mode
Context 
config>redundancy>multi-chassis>peer>mc-ep
Description 

This command configures the passive mode behavior for the MC-EP protocol. When in passive mode the MC-EP pair will be dormant until two of the pseudowires in a MC-EP will be signaled as active by the remote PEs, being assumed that the remote pair is configured with regular MC-EP. As soon as more than one pseudowire is active, dormant MC-EP pair will activate. It will use the regular exchange to select the best pseudowire between the active ones and it will block the Rx and Tx directions of the other pseudowires.

The no form of this command will disable the passive mode behavior.

Default 

no passive-mode

system-priority

Syntax 
system-priority value
no system-priority
Context 
config>redundancy>multi-chassis>peer>mc-ep
Description 

This command allows the operator to set the system priority. The peer configured with the lowest value is chosen to be the master. If system-priority are equal then the one with the highest system-id (chassis MAC address) is chosen as the master.

The no form of this command sets the system priority to default.

Default 

no system-priority

Parameters 
value—
Specifies the priority assigned to the local MC-EP peer.
Values—
1 to 255

 

5.16.2.15.3. MC-LAG Commands

mc-lag

Syntax 
[no] mc-lag
Context 
config>redundancy>multi-chassis>peer>mc-lag
Description 

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

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

Default 

no mc-lag

hold-on-neighbor-failure

Syntax 
hold-on-neighbor-failure multiplier
no hold-on-neighbor-failure
Context 
config>redundancy>multi-chassis>peer>mc-lag
Description 

This command specifies the interval that the standby node will wait for packets from the active node before assuming a redundant-neighbor node failure. This delay in switch-over operation is required to accommodate different factors influencing node failure detection rate, such as IGP convergence, or HA switch-over times and to prevent the standby node to take action prematurely.

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

Default 

hold-on-neighbor-failure 3

Parameters 
multiplier—
Specifies the time interval that the standby node will wait for packets from the active node before assuming a redundant-neighbor node failure.
Values—
2 to 25

 

keep-alive-interval

Syntax 
keep-alive-interval interval
no keep-alive-interval
Context 
config>redundancy>multi-chassis>peer>mc-lag
Description 

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

The no form of this command sets the interval to default value

Default 

keep-alive-interval 1s (10 hundreds of milliseconds means interval value of 10)

Parameters 
interval—
Specifies the time interval expressed in deciseconds.
Values—
5 to 500

 

lag

Syntax 
lag lag-id lacp-key admin-key system-id system-id [remote-lag remote-lag-id] system-priority system-priority source-bmac-lsb use-lacp-key
lag lag-id lacp-key admin-key system-id system-id [remote-lag remote-lag-id] system-priority system-priority source-bmac-lsb MAC-Lsb
lag lag-id lacp-key admin-key system-id system-id [remote-lag remote-lag-id] system-priority system-priority
lag lag-id [remote-lag remote-lag-id]
no lag lag-id
Context 
config>redundancy>multi-chassis>peer>mc-lag
Description 

This command defines a LAG which 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 1 peer. The same lacp-key, system-id, and system-priority must be configured on both nodes of the redundant pair in order to MC-LAG to become operational. In order MC-LAG to become operational, all parameters (lacp-key, system-id, system-priority) must be configured the same on both nodes of the same redundant pair.

The partner system (the system connected to all links forming MC-LAG) will consider all ports using the same lacp-key, system-id, system-priority as the part of the same LAG. In order to achieve this in MC operation, both redundant-pair nodes have to be configured with the same values. In case of the mismatch, MC-LAG is kept operationally down.

Parameters 
lag-id—
Specifies the LAG identifier, expressed as a decimal integer. Specifying the lag-id allows the mismatch between lag-id on redundant-pair. If no lag-id is specified it is assumed that neighbor system uses the same lag-id as a part of the given MC-LAG. If no matching MC-LAG group can be found between neighbor systems, the individual LAGs will operate as usual (no MC-LAG operation is established.).
Values—
1 to 800

 

admin-key
Specifies a 16 bit key that needs to be configured in the same manner on both sides of the MC-LAG in order for the MC-LAG to come up.
Values—
1 to 65535

 

system-id
Specifies a 6 byte value expressed in the same notation as MAC address.
Values—
xx:xx:xx:xx:xx:xx - xx [00 to FF]

 

remote-lag-id
Specifies the LAG ID on the remote system.
Values—
1 to 800

 

system-priority
Specifies the system priority to be used in the context of the MC-LAG. The partner system will consider all ports using the same lacp-key, system-id, and system-priority as part of the same LAG.
Values—
1 to 65535

 

MAC-Lsb—
Configures the last 16 bit of the MAC address to be used for all traffic ingressing the MC-LAG link(s) or if use-lacp-key option is used, it only copies the value of lacp-key (redundancy multi-chassis mc-lag lag lacp-key adminkey).

The command will fail if the value is the same with any of the following configured attributes:

  1. source-bmac-lsb assigned to other MC-LAG ports
  2. lsb 16 bits value for the source-bmac configured at chassis or BVPLS level
    The first 32 bits are copied from the source BMAC of the BVPLS associated with the IVPLS for a specific IVPLS SAP mapped to the MC-LAG. The BVPLS source BMAC can be provisioned for each BVPLS or can be inherited from the chassis PBB configuration.
Values—
1 to 65535 or xx-xx or xx:xx

 

5.16.2.16. LLDP System Commands

lldp

Syntax 
lldp
Context 
config>system
Description 

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

message-fast-tx

Syntax 
message-fast-tx time
no message-fast-tx
Context 
config>system>lldp
Description 

This command configures the duration of the fast transmission period.

Default 

no message-fast-tx

Parameters 
time—
Specifies the fast transmission period in seconds.
Values—
1 to 3600

 

Default—
1

message-fast-tx-init

Syntax 
message-fast-tx-init count
no message-fast-tx-init
Context 
config>system>lldp
Description 

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

Default 

no message-fast-tx-init

Parameters 
count—
Specifies the number of LLDPDUs to send during the fast transmission period.
Values—
1 to 8

 

Default—
4

notification-interval

Syntax 
notification-interval time
no notification-interval
Context 
config>system>lldp
Description 

This command configures the minimum time between change notifications.

Default 

no notification-interval

Parameters 
time—
Specifies the minimum time, in seconds, between change notifications.
Values—
5 to 3600

 

Default—
5

reinit-delay

Syntax 
reinit-delay time
no reinit-delay
Context 
config>system>lldp
Description 

This command configures the time before re-initializing LLDP on a port.

Default 

no reinit-delay

Parameters 
time—
Specifies the time, in seconds, before re-initializing LLDP on a port.
Values—
1 to 10

 

Default—
2

tx-credit-max

Syntax 
tx-credit-max count
no tx-credit-max
Context 
config>system>lldp
Description 

This command configures the maximum consecutive LLDPDUs transmitted.

Default 

no tx-credit-max

Parameters 
count—
Specifies the maximum consecutive LLDPDUs transmitted.
Values—
1 to 100

 

Default—
5

tx-hold-multiplier

Syntax 
tx-hold-multiplier multiplier
no tx-hold-multiplier
Context 
config>system>lldp
Description 

This command configures the multiplier of the tx-interval.

Default 

no tx-hold-multiplier

Parameters 
multiplier—
Specifies the multiplier of the tx-interval.
Values—
2 to 10

 

Default—
4

tx-interval

Syntax 
tx-interval interval
no tx-interval
Context 
config>system>lldp
Description 

This command configures the LLDP transmit interval time.

Default 

no tx-interval

Parameters 
interval—
Specifies the LLDP transmit interval time.
Values—
5 to 32768

 

Default—
30

5.16.2.17. LLDP Ethernet Port Commands

lldp

Syntax 
lldp
Context 
config>port>ethernet
Description 

This command enables the context to configure Link Layer Discovery Protocol (LLDP) parameters on the specified port.

dest-mac

Syntax 
dest-mac {nearest-bridge | nearest-non-tpmr | nearest-customer}
Context 
config>port>ethernet>lldp
Description 

This command configures destination MAC address parameters.

Default 

dest-mac nearest-bridge

Parameters 
nearest-bridge—
Specifies to use the nearest bridge.
nearest-non-tpmr—
Specifies to use the nearest non-Two-Port MAC Relay (TPMR).
nearest-customer—
Specifies to use the nearest customer.

admin-status

Syntax 
admin-status {rx | tx | tx-rx | disabled}
Context 
config>port>ethernet>lldp>dstmac
Description 

This command specifies the administratively desired status of the local LLDP agent.

Default 

admin-status disabled

Parameters 
rx —
Specifies the LLDP agent will receive, but will not transmit LLDP frames on this port.
tx —
Specifies that the LLDP agent will transmit LLDP frames on this port and will not store any information about the remote systems connected.
tx-rx—
Specifies that the LLDP agent will transmit and receive LLDP frames on this port.
disabled—
Specifies that the LLDP agent will not transmit or receive LLDP frames on this port. If there is remote systems information which is received on this port and stored in other tables, before the port's admin status becomes disabled, then the information will naturally age out.

notification

Syntax 
[no] notification
Context 
config>port>ethernet>lldp>dstmac
Description 

This command enables LLDP notifications.

The no form of the command disables LLDP notifications.

Default 

no notification

port-id-subtype

Syntax 
pot-id-subtype {tx-if-alias | tx-if-name | tx-local}
Context 
config>port>ethernet>lldp>dstmac
Description 

This command configures the encoding of the port identifier TLVs transmitted to the peer.

Default 

port-id-subtype tx-local

Parameters 
tx-if-alias—
(1) Transmits the ifAlias IF-MIB string.
tx-if-name—
(5) Transmits the ifName IF-MIB string.
tx-local—
(7) Transmits the interface ifIndex value.

tunnel-nearest-bridge

Syntax 
[no] tunnel-nearest-bridge
Context 
config>port>ethernet>lldp>dest-mac
Description 

The command allows LLDP packets received on the port with the destination address of the nearest bridge to be tunneled without being intercepted on the local port. The dest-mac nearest-bridge must be disable for tunneling to occur. This is applicable to NULL SAP Epipe and VPLS services only.

Default 

no tunnel-nearest-bridge

tx-mgmt-address

Syntax 
tx-mgmt-address [system] [system-ipv6]
no tx-mgmt-address
Context 
config>port>ethernet>lldp>dstmac
Description 

This command specifies which management address to transmit.

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

Default 

no tx-mgmt-address

Parameters 
system—
Specifies to use the system IP address. The system address will only be transmitted once it has been configured if this parameter is specified.
system-ipv6—
Specifies to use the system IPv6 address. The system address will only be transmitted once it has been configured if this parameter is specified.

tx-tlvs

Syntax 
tx-tlvs [port-desc] [sys-name] [sys-desc] [sys-cap]
no tx-tlvs
Context 
config>port>ethernet>lldp>dstmac
Description 

This command specifies which LLDP TLVs to transmit.

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

Default 

no tx-tlvs

Parameters 
port-desc—
Indicates that the LLDP agent should transmit port description TLVs.
sys-name —
Indicates that the LLDP agent should transmit system name TLVs.
sys-desc—
Indicates that the LLDP agent should transmit system description TLVs.
sys-cap—
Indicates that the LLDP agent should transmit system capabilities TLVs.

5.16.2.18. System Router Instance Commands

router

Syntax 
router [router-instance] [create]
no router [router-instance]
Context 
config
Description 

This command enables the context in which to configure router parameters including interfaces, route policies and protocols. This command is also used to create CPM router instances.

For CPM router instances, this command enters or creates a user-created CPM router instance. A CPM router instance is not a VPRN router instance. VPRN router instances are configured under configure service vprn. CPM router instances are the only type of non-VPRN router instances that can be created by a user, and have a user-defined name. CPM router instances only use CPM/CFM/CCM ethernet ports as interfaces.

Parameters 
router-instance—
Specifies the router name or CPM router instance.
Values—

router-instance: router name

router-name

Base | management | cpm-vr-name

cpm-vr-name

[32 characters maximum]

 

Default—
Base
create—
Keyword used to create the router instance.