Professional Documents
Culture Documents
3HH-04416-EDBA-TCZZA-01-R5 - 3 - 01 CLI Command Guide For FD 24Gbps NT
3HH-04416-EDBA-TCZZA-01-R5 - 3 - 01 CLI Command Guide For FD 24Gbps NT
3HH-04416-EDBA-TCZZA-01-R5 - 3 - 01 CLI Command Guide For FD 24Gbps NT
Alcatel-Lucent 7330
INTELLIGENT SERVICES ACCESS MANAGER FIBER TO THE NODE
Alcatel-Lucent 7356
INTELLIGENT SERVICES ACCESS MANAGER FIBER TO THE BUILDING
CLI COMMAND GUIDE FOR FD 24GBPS NT
R E LE ASE 5.3 .0 1
3 H H-0 4 4 16-EDBA-TCZZA Ed i t i on 0 1 Re l ease d
Alcatel-Lucent Proprietary
This document contains proprietary information of Alcatel-Lucent and is not to be disclosed
or used except in accordance with applicable agreements.
Copyright 2015 © Alcatel-Lucent. All rights reserved.
Status Released
Change Note
Short Title CD CLI CMD GUIDE
All rigths reserved. Passing on and copying of this
document, use and communication of its contents not
permitted without written authorization from
Alcatel-Lucent.
Released 3HH-04416-EDBA-TCZZA 01
Contents
Contents
1- ISAM CLI 1
1.1 History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.2 Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
1.3 CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
1.4 Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
1.5 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
1.6 Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
1.7 Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
1.8 Getting help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
1.9 The CLI Prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
1.10 Entering CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
1.11 CLI Backward Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
1.12 Phase Out Strategy Obsolete Commands and/or Parameters . . . . . . . . . . . . . . . . 63
1.13 Command Phase Out Annoucement Release . . . . . . . . . . . . . . . . . . . . . . . . . 64
3HH-04416-EDBA-TCZZA 01 Released i
Contents
ii Released 3HH-04416-EDBA-TCZZA 01
Contents
iv Released 3HH-04416-EDBA-TCZZA 01
Contents
3HH-04416-EDBA-TCZZA 01 Released v
Contents
vi Released 3HH-04416-EDBA-TCZZA 01
Contents
3HH-04416-EDBA-TCZZA 01 Released ix
Contents
x Released 3HH-04416-EDBA-TCZZA 01
Contents
3HH-04416-EDBA-TCZZA 01 Released xi
Contents
3HH-04416-EDBA-TCZZA 01 Released xv
Contents
66.5 xDSL Operational Data Near End Channel Status Command . . . . . . . . . . . . . . . .2019
66.6 xDSL Operational Data Far End Line Status Command . . . . . . . . . . . . . . . . . . .2021
66.7 xDSL Operational Data Far End Channel Status Command . . . . . . . . . . . . . . . . .2030
66.8 xDSL Operational Data Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2032
66.9 xDSL Carrier Data Near End Status Command . . . . . . . . . . . . . . . . . . . . . . . .2037
66.10 xDSL Carrier Data Far End Status Command . . . . . . . . . . . . . . . . . . . . . . . .2043
66.11 xDSL Failure Status Near End Status Command . . . . . . . . . . . . . . . . . . . . . .2046
66.12 xDSL Failure Status Far End Status Command . . . . . . . . . . . . . . . . . . . . . . .2049
66.13 xDSL Vectored Line Failure Status Command . . . . . . . . . . . . . . . . . . . . . . . .2052
66.14 xDSL Vectoring Board Failure Status Command . . . . . . . . . . . . . . . . . . . . . .2054
66.15 xDSL Counters Near End Line Current 15 Min . . . . . . . . . . . . . . . . . . . . . . .2056
66.16 xDSL Counters Near End Line Current Day . . . . . . . . . . . . . . . . . . . . . . . . .2059
66.17 xDSL Counters Near End Line Previous 15 Min . . . . . . . . . . . . . . . . . . . . . . .2062
66.18 xDSL Counters Near End Of Line Previous Day . . . . . . . . . . . . . . . . . . . . . . .2065
66.19 xDSL Counters Near End Channel Current 15 Min . . . . . . . . . . . . . . . . . . . . .2068
66.20 xDSL Counters Near End Channel Current Day . . . . . . . . . . . . . . . . . . . . . . .2070
66.21 xDSL Counters Near End Channel Previous 15 Min . . . . . . . . . . . . . . . . . . . .2072
66.22 xDSL Counters Near End Channel Previous Day . . . . . . . . . . . . . . . . . . . . . .2074
66.23 xDSL Counters Far End Line Current 15 Min . . . . . . . . . . . . . . . . . . . . . . . .2076
66.24 xDSL Counters Far End Line Current Day . . . . . . . . . . . . . . . . . . . . . . . . . .2078
66.25 xDSL Counters Far End Line Previous 15 Min . . . . . . . . . . . . . . . . . . . . . . . .2080
66.26 xDSL Counters Far End Line Previous Day . . . . . . . . . . . . . . . . . . . . . . . . .2083
66.27 xDSL Counters Far End Channel Current 15 Min . . . . . . . . . . . . . . . . . . . . . .2086
66.28 xDSL Counters Far End Channel Current Day . . . . . . . . . . . . . . . . . . . . . . . .2088
66.29 xDSL Counters Far End Channel Previous 15 Min . . . . . . . . . . . . . . . . . . . . .2090
66.30 xDSL Counters Far End Channel Previous Day . . . . . . . . . . . . . . . . . . . . . . .2092
66.31 xDSL XTU-R Inventory Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .2094
66.32 xDSL XTU-C Inventory Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .2096
66.33 xDSL Board Capability Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .2098
66.34 xDSL Low Rate Alarm Timestamp Command . . . . . . . . . . . . . . . . . . . . . . . .2104
66.35 xDSL Low Rate Alarm Line Bitmap Status Command . . . . . . . . . . . . . . . . . . . .2105
66.36 xDSL Low Rate Alarm Linkup Record Data Command . . . . . . . . . . . . . . . . . . .2106
66.37 xDSL INS Near End Operational Data Status Command . . . . . . . . . . . . . . . . . .2109
66.38 xDSL INS Near End Current 15Min Data Status Command . . . . . . . . . . . . . . . . .2111
66.39 xDSL INS Near End Current 15Min IAT Histogram . . . . . . . . . . . . . . . . . . . . .2112
66.40 xDSL INS Near End Current 15Min EINP Histogram . . . . . . . . . . . . . . . . . . . .2113
66.41 xDSL INS Near End Current Day Data Status Command . . . . . . . . . . . . . . . . . .2114
66.42 xDSL INS Near End Current Day IAT Histogram . . . . . . . . . . . . . . . . . . . . . .2115
66.43 xDSL INS Near End Current Day EINP Histogram . . . . . . . . . . . . . . . . . . . . .2116
66.44 xDSL INS Near End Previous 15Min Data Status Command . . . . . . . . . . . . . . . .2117
66.45 xDSL INS Near End Previous 15Min IAT Histogram . . . . . . . . . . . . . . . . . . . .2118
66.46 xDSL INS Near End Previous 15Min EINP Histogram . . . . . . . . . . . . . . . . . . .2119
66.47 xDSL INS Near End Previous Day Data Status Command . . . . . . . . . . . . . . . . .2120
66.48 xDSL INS Near End Previous Day IAT Histogram . . . . . . . . . . . . . . . . . . . . . .2121
66.49 xDSL INS Near End Previous Day EINP Histogram . . . . . . . . . . . . . . . . . . . . .2122
66.50 xDSL INS Far End Operational Data Status Command . . . . . . . . . . . . . . . . . . .2123
66.51 xDSL INS Far End Current 15Min Data Status Command . . . . . . . . . . . . . . . . .2125
66.52 xDSL INS Far End Current 15Min IAT Histogram . . . . . . . . . . . . . . . . . . . . . .2126
66.53 xDSL INS Far End Current 15Min EINP Histogram . . . . . . . . . . . . . . . . . . . . .2127
66.54 xDSL INS Far End Current Day Data Status Command . . . . . . . . . . . . . . . . . . .2128
66.55 xDSL INS Far End Current Day IAT Histogram . . . . . . . . . . . . . . . . . . . . . . .2129
66.56 xDSL INS Far End Current Day EINP Histogram . . . . . . . . . . . . . . . . . . . . . .2130
66.57 xDSL INS Far End Previous 15Min Data Status Command . . . . . . . . . . . . . . . . .2131
66.58 xDSL INS Far End Previous 15Min IAT Histogram . . . . . . . . . . . . . . . . . . . . .2132
66.59 xDSL INS Far End Previous 15Min EINP Histogram . . . . . . . . . . . . . . . . . . . .2133
66.60 xDSL INS Far End Previous Day Status Command . . . . . . . . . . . . . . . . . . . . .2134
66.61 xDSL INS Far End Previous Day IAT Histogram . . . . . . . . . . . . . . . . . . . . . .2135
66.62 xDSL INS Far End Previous Day EINP Histogram . . . . . . . . . . . . . . . . . . . . . .2136
66.63 xDSL Downstream Vectoring Disturberlist Status Command . . . . . . . . . . . . . . . .2137
66.64 xDSL Upstream Vectoring Disturberlist Status Command . . . . . . . . . . . . . . . . .2139
xx Released 3HH-04416-EDBA-TCZZA 01
Contents
94.11 IMA Link Far-End Previous Interval Performance Data Status Command . . . . . . . . .2661
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
130.2 Single Ended Synthetic Loss Measurement message Management Command . . . . . .3108
Index 3232
3HH-04416-EDBA-TCZZA 01 Released 1
1 ISAM CLI
1.1 History
This history section enumerates the CLI commands which are new, modified or removed between any two
subsequent releases. No details are provided within this section. The command description, syntax and parameters for
each new and modified command is in the Command Syntax section of the respective command in the CLI
Command Guide. To know the difference between e.g R4.6 and R4.5, review the delta's of the releases R4.5.01
versus R4.5 and R4.5.02 versus R4.5.01 and R4.6 versus R4.5.02.
New Commands
show alarm current nni-ether-sfp (ethernet link alarm refinement)
show alarm current uplink-ether-sfp (ethernet link alarm refinement)
show alarm log nni-ether-sfp (ethernet link alarm refinement)
show alarm log uplink-ether-sfp (ethernet link alarm refinement)
show alarm snap-shot nni-ether-sfp (ethernet link alarm refinement)
show alarm snap-shot uplink-ether-sfp (ethernet link alarm refinement)
2 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
3HH-04416-EDBA-TCZZA 01 Released 3
1 ISAM CLI
configure system security operator (request to verify Current Password before accepting the change
password for existing operators)
configure system security profile (restrict access rights for AI config commands)
configure system security radius acc-server (support text based dump and restore of Core 0)
configure system security radius auth-server (support text based dump and restore of Core 0)
configure system security radius dyn-auth-client (support text based dump and restore of Core 0)
configure system security ssh sftp-user (support text based dump and restore of Core 0)
configure system uplink (support Dying gasp on PTP uplink for 7363-MX and 7367 SX-16F)
configure trap definition (support Dying gasp on PTP uplink for 7363-MX and 7367 SX-16F)
configure trap manager (support Dying gasp on PTP uplink for 7363-MX and 7367 SX-16F)
configure trouble-shooting statistics interface (Business/Pre-Aggregation P2P LT variant (FELT-B) -
Application limited to VULA uplink)
configure vlan id (removed invalid values 4092 and 4096 from available range of vlanIds)
configure vlan unicast-mac (removed invalid values 4092 and 4096 from available range of vlanIds)
configure voice cluster equipment board planned-type (support nvps-c Voice Megaco Equipment Board)
configure voice cluster equipment termination (support enabling H.248 DSL voice service configuration
per line)
configure voice cluster ip (porting MDU DHCP for 7363 ISAM MX and 7367 ISAM SX)
configure voice cluster media-gateway (porting MDU DHCP for 7363 ISAM MX and 7367 ISAM SX)
configure voice cluster signal-gateway (ISAMV H.248 obsolete no option removed for Prim/sec/tert/quat
ASP IP)
configure voice sip register register-uri (extend the multiple VAG up to 16 VAG on 7363 MX-6/7302
ISAM-V)
configure voice sip transport provider-name udp admin-status (extend the multiple VAG up to 16 VAG
on 7363 MX-6/7302 ISAM-V)
configure voice sip user-agent (extend the multiple VAG up to 16 VAG on 7363 MX-6/7302 ISAM-V)
configure voice sip user-agent-ap (extend the multiple VAG up to 16 VAG on 7363 MX-6/7302
ISAM-V)
configure voice sip vsp admin-status (extend the multiple VAG up to 16 VAG on 7363 MX-6/7302
ISAM-V)
configure voice sip vsp domain-name (extend the multiple VAG up to 16 VAG on 7363 MX-6/7302
ISAM-V)
configure xdsl board vect-fallback (support SOS for VDSL2 on vectoring boards)
configure xdsl line (support SOS for VDSL2 on vectoring boards)
configure xdsl service-profile (support SOS for VDSL2 on vectoring boards)
shiw vlan dup-mac-alarm (removed invalid values 4092 and 4096 from available range of vlanIds)
shiw vlan fdb-board (removed invalid values 4092 and 4096 from available range of vlanIds)
show qos interface-bandwidth (Business/Pre-Aggregation P2P LT variant (FELT-B) - Application limited
to VULA uplink)
show qos statistics queue current-15min (Business/Pre-Aggregation P2P LT variant (FELT-B) -
Application limited to VULA uplink)
4 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
show qos statistics queue prev-15min (Business/Pre-Aggregation P2P LT variant (FELT-B) - Application
limited to VULA uplink)
show system license (add G.FAST and vdsl2-35b-mode licenses)
show xdsl counters far-end line current-interval/current-1day (support SOS for VDSL2 on vectoring
boards)
show xdsl counters far-end line previous-interval/previous-1day (support SOS for VDSL2 on vectoring
boards)
show xdsl counters near-end line current-interval/current-1day (support SOS for VDSL2 on vectoring
boards)
show xdsl counters near-end line previous-interval/previous-1day (support SOS for VDSL2 on vectoring
boards)
show xdsl operational-data far-end line (support SOS for VDSL2 on vectoring boards)
show xdsl operational-data near-end line (support SOS for VDSL2 on vectoring boards)
show xdsl profiles (support SOS for VDSL2 on vectoring boards)
traceroute vrf (support text based dump and restore of Core 0)
New Commands
configure qos profiles cos-threshold (Business/Pre-Aggregation P2P LT variant (FELT-B) - Application
limited to VULA uplink)
configure qos upstr-prot-dsl (enabling QoS handling of upstream protocol for DSL LTs)
configure xdsl sos-profile (support SOS for VDSL2 on vectoring boards)
show alarm current voice-plugin-unit (new alarm for H248 POTS Porting MDU DHCP for 7363 ISAM
MX and 7367 ISAM SX)
show alarm current xdsl-ext (add extended xdsl/transport related alarms)
show alarm log voice-plugin-unit (new alarm for H248 POTS Porting MDU DHCP for 7363 ISAM MX
and 7367 ISAM SX)
show alarm log xdsl-ext (add extended xdsl/transport related alarms)
show alarm log xdsl-ext far-end (add extended xdsl/transport related alarms)
show alarm log xdsl-ext near-end (add extended xdsl/transport related alarms)
show alarm snap-shot voice-plugin-unit (new alarm for H248 POTS Porting MDU DHCP for 7363 ISAM
MX and 7367 ISAM SX)
show alarm snap-shot xdsl-ext (add extended xdsl/transport related alarms)
show qos profile-usage cos-threshold (Business/Pre-Aggregation P2P LT variant (FELT-B) - Application
limited to VULA uplink)
Commands or commands with parameters for future use, not supported yet
configure cfm domain association mep (new parameter equipment not supported yet)
configure linetest cluster ltparm test-name (parameter value bat-imped-discard replaced by
force-ring-subscrib)
configure linetest single ltparm test-name (parameter value bat-imped-discard replaced by
force-ring-subscrib)
configure xdsl board (vplt-autodiscovery option enable-both-lnk1-lnk2 is not supported yet)
3HH-04416-EDBA-TCZZA 01 Released 5
1 ISAM CLI
6 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
configure system security ssh access (trace and debug using SSH disabled)
configure system security ssh user (range of ssh user key extended from 725 to 1200)
configure voice sip termination (enlarge accessontimeout maximum value to 900 sec. Change default
value to 900 sec.)
configure xdsl spectrum-profile vdsl pbo (updated behaviour of default parametervalues for param-a and
param-b, no option removed)
configure xdsl spectrum-profile vdsl2 pbo (updated behaviour of default parametervalues for param-a and
param-b, no option removed)
environment prompt (option %i added to the description of the prompt configuration to show the system
id in the session prompt)
show cfm ma-config-data domain association (ETH CFM Configurable LTM messages forwarding)
show cfm ma-config-data domain association (support dual tagged CFM messages when configured for
C-VLAN CC)
show interface availability (IF-MIB counters for POTS (SIP controlled) line interfaces)
show interface port (IF-MIB counters for POTS (SIP controlled) line interfaces)
show interface stack (IF-MIB counters for POTS (SIP controlled) line interfaces)
show interface test (IF-MIB counters for POTS (SIP controlled) line interfaces)
show linetest single lineid-ext-rept (add linetest to show whether termination ringer is detected)
New Commands
configure alias (DPoE command to create, modify, remove and retrieve alias CLI)
show voice sip port-state (SIP (CVP) : support call states in compliance with 163TR26)
Commands or commands with parameters for future use, not supported yet
configure ethernet line (parameter uplink not supported yet)
configure ethernet line mau (parameter value 10gbasesr not supported yet)
configure qos interface (parameter value ltuplink not supported yet)
configure qos profiles cos-threshold (parameter cos-threshold not supported yet)
configure qos profiles ingress-qos (parameters PolTCMask_0-7 not supported yet)
configure qos profiles policer (parameter cos-threshold, peak-info-rate peak-burst-size not supported yet)
configure qos profiles session (parameter ing-outer-marker outer-marking not supported yet)
configure qos tca queue (parameter value ltuplink not supported yet)
configure xdsl board (vplt-autodiscovery option enable-both-lnk1-lnk2 is not supported yet)
configure xdsl line (parameter g993-2-35b not supported yet)
configure xdsl spectrum-profile (parameter g993-2-35b not supported yet)
configure xdsl spectrum-profile vdsl (parameter values for VectNadnPlan : b998ade17ds30us35 |
b998e17ds30us35 | b998ade17ds35 | b998e17ds35 not supported yet)
configure xdsl vce-profile (parameter values for VectNadnPlan : b998ade17ds30us35 | b998e17ds30us35
| b998ade17ds35 | b998e17ds35 not supported yet)
configure xdsl vce-profile (parameter vce-max-vect-freq not supported yet)
show qos interface-bandwidth (parameter value ltuplink not supported yet)
3HH-04416-EDBA-TCZZA 01 Released 7
1 ISAM CLI
8 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
3HH-04416-EDBA-TCZZA 01 Released 9
1 ISAM CLI
New Commands
configure equipment diagnostics (RSSI support on NT ports in FD)
configure equipment diagnostics sfp (RSSI support on NT ports in FD)
configure equipment rssiprof (RSSI support on NT ports in FD)
show equipment diagnostics sfp-threshold (RSSI support on NT ports in FD)
show system cde-bitmap-extended (displays the activated CDE Capabilities (256 bits))
show trouble-shooting statistics vlanport bridgeport-id vlan-id (extended troubleshoting statistics)
show trouble-shooting statistics vlanport bridgeport-id vlan-id extensive (extended troubleshoting
statistics)
show trouble-shooting statistics vlanport bridgeport-id vlan-id summary (extended troubleshoting
statistics)
Removed Commands
configure l2cp (end of support for ANCP/L2CP)
configure l2cp session bras-ip-address (end of support for ANCP/L2CP)
configure l2cp user-port partition-id (end of support for ANCP/L2CP)
show l2cp (end of support for ANCP/L2CP)
show l2cp partition (end of support for ANCP/L2CP)
show l2cp session-peers (end of support for ANCP/L2CP)
show l2cp session-stats (end of support for ANCP/L2CP)
show l2cp session-status (end of support for ANCP/L2CP)
show mcast ont-active-groups (remove not supported command)
show mcast pon-active-groups (remove not supported command)
Commands or commands with parameters for future use, not supported yet
configure linetest cluster ltsession (H248 POTS: Porting MDU specific enhancements diagnosis-caller
diagnosis-callee)
configure linetest single ltparm test-name (increase line test parameters for NBLT ROH test zener-res
zener-volt)
configure linetest single ltsession (increase line test parameters for NBLT ROH test zener-res zener-volt)
configure vlan id (transparent behavior DHCP option 82 handling (replaced when already inserted by
CPE), Access Loop Encapsulation support for DHCPv6 not supported yet (parameters pppoe-l2-encaps,
dhcp-l2-encaps, dhcpv6-l2-encaps l2-encaps1 pppoer-vlanaware and dhcpr-vlanaware))
show linetest single lineid-ext-rept (increase line test parameters for NBLT ROH test)
10 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
3HH-04416-EDBA-TCZZA 01 Released 11
1 ISAM CLI
New Commands
show equipment planned-resource (showing the actual values of configured hardware resources on
boards)
configure qos pbit-scheduling (configuring the p-bit behavior of the S+C vlan forwarding model in both
upstream and downstream direction)
configure xdsl-bonding board (adding bonding vectoring fallback for future use)
configure xdsl-bonding board vect-fallback (adding bonding vectoring fallback for future use)
show mcast ont-active-groups (shows the list of active multicast streams per user interface on a particular
ONT)
show mcast pon-active-groups (shows the list of active multicast streams per user interface on a particular
PON)
12 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
show alarm delta-log indeterminate (updating alarm list with new alarms)
show alarm delta-log warning (updating alarm list with new alarms)
show alarm delta-log minor (updating alarm list with new alarms)
show alarm delta-log major (updating alarm list with new alarms)
show alarm delta-log critical (updating alarm list with new alarms)
configure ethernet line mau (addng supported mau types)
configure qos profiles policer (updating policer profile ranges for MEF certification and MEF Policer rate
calculation to include only L2 bytes)
configure vlan id (adding new parameter 'cvlan4095passthru' to forward c-vid 4095 transparently)
show qos statistics buffer-overflow current-1day (removal of obsolete parameter values for 'slotindex')
show vlan bridge-port-fdb (enabling retrieval of mac-adresses learned on uplink lt)
show vlan fdb-board (improved display of dup mac alarm)
show vlan dup-mac-alarm (improved display of dup mac alarm)
configure system security login-banner (expanding Logon banner to 2048 characters)
configure system loop-id-syntax (adding 'LzNVID' as keyword to construct the system loop ID)
show xdsl counters near-end line previous-interval (adding a timestamp to each PM interval, specifying
the date and time of the start of the PM interval)
show xdsl counters near-end line previous-day (adding a timestamp to each PM interval, specifying the
date and time of the start of the PM interval)
show xdsl counters near-end channel previous-interval (adding a timestamp to each PM interval,
specifying the date and time of the start of the PM interval)
show xdsl counters near-end channel previous-day (adding a timestamp to each PM interval, specifying
the date and time of the start of the PM interval)
show xdsl counters far-end line previous-interval (adding a timestamp to each PM interval, specifying the
date and time of the start of the PM interval)
show xdsl counters far-end line previous-day (adding a timestamp to each PM interval, specifying the
date and time of the start of the PM interval)
show xdsl counters far-end channel previous-interval (adding a timestamp to each PM interval, specifying
the date and time of the start of the PM interval)
show xdsl counters far-end channel previous-day (adding a timestamp to each PM interval, specifying the
date and time of the start of the PM interval)
show xdsl imp-noise-sensor near-end previous-interval (adding a timestamp to each PM interval,
specifying the date and time of the start of the PM interval)
show xdsl imp-noise-sensor far-end previous-interval (adding a timestamp to each PM interval, specifying
the date and time of the start of the PM interval)
show shdsl segment-counters previous-15min (adding a timestamp to each PM interval, specifying the
date and time of the start of the PM interval)
show shdsl segment-counters previous-1day (adding a timestamp to each PM interval, specifying the date
and time of the start of the PM interval)
show shdsl span-counters previous-15min (adding a timestamp to each PM interval, specifying the date
and time of the start of the PM interval)
show shdsl span-counters previous-1day (adding a timestamp to each PM interval, specifying the date and
time of the start of the PM interval)
3HH-04416-EDBA-TCZZA 01 Released 13
1 ISAM CLI
New Commands
configure cfm y1731pm (adding on-demand and proactive performance monitoring compliant with
Y.1731)
configure cfm y1731pm domain association (adding on-demand and proactive performance monitoring
compliant with Y.1731)
show cfm y1731pm (adding on-demand and proactive performance monitoring compliant with Y.1731)
show cfm y1731pm curr-15min-stats (adding on-demand and proactive performance monitoring
compliant with Y.1731)
show cfm y1731pm curr-15min-stats domain (adding on-demand and proactive performance monitoring
compliant with Y.1731)
show cfm y1731pm curr-day-stats (adding on-demand and proactive performance monitoring compliant
with Y.1731)
show cfm y1731pm curr-day-stats domain (adding on-demand and proactive performance monitoring
compliant with Y.1731)
show cfm y1731pm prev-15min-stats (adding on-demand and proactive performance monitoring
compliant with Y.1731)
show cfm y1731pm prev-15min-stats domain (adding on-demand and proactive performance monitoring
compliant with Y.1731)
show cfm y1731pm prev-day-stats (adding on-demand and proactive performance monitoring compliant
with Y.1731)
show cfm y1731pm prev-day-stats domain (adding on-demand and proactive performance monitoring
compliant with Y.1731)
14 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
New Commands
admin cfm single-ended-slm (support Y.1731 SLM Originator and LM responder on CATAN based
VDSL LT's)
admin cfm single-ended-slm domain association mep target-mac (support Y.1731 SLM Originator and
LM responder on CATAN based VDSL LT's)
configure alarm filter filterid (CLI coverage of TL1 Alarm Filter)
show alarm current spatial (add spatial filter alarm)
show alarm current temporal (add temporal filter alarm)
show alarm log spatial (add spatial filter alarm)
show alarm log temporal (add temporal filter alarm)
show alarm snap-shot spatial (add spatial filter alarm)
3HH-04416-EDBA-TCZZA 01 Released 15
1 ISAM CLI
16 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
New Commands
configure xdsl-bonding group-rtx-profile (2-pair VDSL2 PTM bonding in combination with G.inp)
show xdsl-bonding group-rtx-profiles (2-pair VDSL2 PTM bonding in combination with G.inp)
3HH-04416-EDBA-TCZZA 01 Released 17
1 ISAM CLI
New Commands
admin ethernet statistics (support RMON counters on NELT-B interfaces)
show ethernet etherstats (support RMON counters on NELT-B interfaces)
show cfm slm-responder-stats (SLM Responder on CATAN VDSL LT and NELT-B UNI)
show cfm slm-responder-stats domain (SLM Responder on CATAN VDSL LT and NELT-B UNI)
show vlan port-accumu-stats (support display of accumulate statistics on the bridge port)
show system sync-if-timing-ptp (Synchronisation Redundancy for BITS/SyncE/IEEE1588)
Commands with new parameters or parameter values that are NOT supported yet
(commands remain backward compatible with previous releases)
configure xdsl line (new parameter "auto-switch" to switch between ATMoADSL and PTMoVDSL)
configure xdsl-bonding group (2-pair VDSL2 PTM bonding in combination with G.inp)
show xdsl-bonding operational-data group (2-pair VDSL2 PTM bonding in combination with G.inp)
Commands with new parameters or parameter values with LIMITED support (commands
are NOT backward compatible with previous releases. Note : configure maximum only
one IEEE1588 clock source. In duplex NT mode, this clock source can be configured on
either NT-A or NT-B, independently of which one is the active one. The NT that has the
clock source configured will pass on the signal to its peer NT)
configure system sync-if-timing ref-order (Synchronisation Redundancy for BITS/SyncE/IEEE1588
parameter value "ieee1588" replaced by "ieee1588-a" or "ieee1588-b")
configure system sync-if-timing ssm-order (Synchronisation Redundancy for BITS/SyncE/IEEE1588
parameter value "ieee1588" replaced by "ieee1588-a" or "ieee1588-b")
18 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
configure cfm domain association [no] name (improvement : [no] command removed)
configure equipment sfpe1t1 framer (removal of obsolete loopback parameters)
configure mcast static [no] branch (GPON static Multicast per ONT, add AID for GPON vlan port)
configure qos profiles [no] bandwidth (support for MEF qualification MIB Impact)
configure qos profiles [no] l3-filter (support L3 ACLs in an IPv6 context)
configure system (PPPoE / DHCP customer-id configuration at system level)
configure system pon-ont (SN bundle with LOID or SLID)
configure system security snmp [no] community (DOCSIS Provisioning Framework)
configure system security snmp [no] group (DOCSIS Provisioning Framework)
configure system security snmp [no] manager (DOCSIS Provisioning Framework)
configure voice sip redundancy (Configurable DNS Selection Algorithm)
configure xdsl [no] service-profile (increase the number of service profiles to 1024)
configure xdsl line [no] service-profile (increase the number of service profiles to 1024)
configure xdsl board vect-fallback [no] service-profile (increase the number of service profiles to 1024)
show system license (MPLS ring with sub 50 ms switchover)
show cfm mep-configdata domain (Y.1731 SLM Responder on CATAN based VDSL LT's and NELT-B
UNI)
show cfm mep-info domain (improvement : displays each field of a CCM packet)
configure bridge port (Support for Multiple LLID on EPON ONU for DPoE)
configure system (Support for Multiple LLID on EPON ONU for DPoE)
configure qos (Support for Multiple LLID on EPON ONU for DPoE)
configure vlan (Support for Multiple LLID on EPON ONU for DPoE)
configure arp-relay (Support for Multiple LLID on EPON ONU for DPoE)
configure qos interface ellid (Support for Multiple LLID on EPON ONU for DPoE)
configure system management (replaces "configure transport ip default-ttl")
New Commands
configure cfm slm (Y.1731 SLM Responder on CATAN based VDSL LT's and NELT-B UNI)
show ethernet dot3stats (ether-like counters on NELT-B, replaces show transport ether-ifdot3lt)
show ethernet mau (replaces "show transport ether-ifmault" for NELT-B MAU operational data)
show ethernet sfp (replaces "show transport ether-ifsfplt" for NELT-B SFP inventory data)
3HH-04416-EDBA-TCZZA 01 Released 19
1 ISAM CLI
Commands with new parameters or parameter values that are NOT supported yet
(commands remain backward compatible with previous releases)
configure xdsl line (new parameter "auto-switch" to switch between ATMoADSL and PTMoVDSL)
configure xdsl-bonding group (2-pair VDSL2 PTM bonding in combination with G.inp)
20 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
show interface port (obsolete parameter value "ethernet" is not applicable in this context)
show interface stack (obsolete parameter value "ethernet" is not applicable in this context)
show interface test (obsolete parameter value "ethernet" is not applicable in this context)
New Commands
admin interface trouble-shooting ethernet statistics (troubleshooting counters on the FD-REM link)
show interface trouble-shooting ethernet statistics (troubleshooting counters on the FD-REM link)
configure cfm domain association remote-mep (CFM Enhancement to support CCM messages)
show alarm current cfm (CFM Enhancement to support CCM messages)
show alarm log cfm (CFM Enhancement to support CCM messages)
show alarm snap-shot cfm (CFM Enhancement to support CCM messages)
show cfm ccm-database (CFM Enhancement to support CCM messages)
show cfm ccm-database domain (CFM Enhancement to support CCM messages)
show cfm mep-info domain (CFM Enhancement to support CCM messages)
show alarm current efm-oam (DSL/ETH LT 802.3ah Critical Event Notification support)
show alarm log efm-oam (DSL/ETH LT 802.3ah Critical Event Notification support)
show alarm snap-shot efm-oam (DSL/ETH LT 802.3ah Critical Event Notification support)
configure pppox-relay cross-connect engine (troubleshooting improvement for PPP Relay with MAC
concentration)
show alarm current pppcc-engine-tca (troubleshooting improvement for PPP Relay with MAC
concentration)
show alarm log pppcc-engine-tca (troubleshooting improvement for PPP Relay with MAC concentration)
show alarm snap-shot pppcc-engine-tca (troubleshooting improvement for PPP Relay with MAC
concentration)
show pppox-relay cross-connect trouble-shooting-cntrs engine curr-15min-stats (troubleshooting
improvement for PPP Relay with MAC concentration)
show pppox-relay cross-connect trouble-shooting-cntrs engine curr-1day-stats (troubleshooting
improvement for PPP Relay with MAC concentration)
show pppox-relay cross-connect trouble-shooting-cntrs engine prev-15min-stats (troubleshooting
improvement for PPP Relay with MAC concentration)
show pppox-relay cross-connect trouble-shooting-cntrs engine prev-1day-stats (troubleshooting
improvement for PPP Relay with MAC concentration)
configure qos profiles [no] dscp-pbit (support for multiple DSCP to pbit mapping profiles)
configure qos profiles codepoint (support for multiple DSCP to pbit mapping profiles)
show qos profile-usage dscp-pbit (support for multiple DSCP to pbit mapping profiles)
show system license eth-oam-adv-mon (replaces "show system license cci-enabled-mep")
admin interface shub trouble-shooting statistics (troubleshooting counters on the FD-REM link)
show interface shub trouble-shooting statistics (troubleshooting counters on the FD-REM link)
Commands with new parameters or parameter values that are NOT supported yet
(commands remain backward compatible with previous releases)
3HH-04416-EDBA-TCZZA 01 Released 21
1 ISAM CLI
configure xdsl line (new parameter "auto-switch" to switch between ATMoADSL and PTMoVDSL)
Removed Commands
configure bcmp (command not applicable for FD 24 GBPS NT)
configure bcmp system (command not applicable for FD 24 GBPS NT)
show bcmp (command not applicable for FD 24 GBPS NT)
22 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
New Commands
configure qos nni-ctrl-pkt-policer (to configure OBC policer for NNI port)
configure qos profiles [no] rate-limit (IPv6 protocol policer per LLID on FX 10G/EPON)
configure system auto-laser-shutdown (Configurable ALS)
show alarm current efm-oam (new alarm)
show alarm log efm-oam (new alarm)
show alarm snap-shot efm-oam (new alarm)
show qos profile-usage rate-limit (show IPv6 protocol policer)
show vlan prio-regen-name (show regeneration profile selection by name)
show vlan prio-regen-next (show next regeneration profile selection)
show voice sip redundancy-node ext-redundancy-state (change for feature Autonomous fail-over
indication)
show xdsl vect-disturber-list upstream (nbr of vectored lines per vectoring processing board increased,
disturber-list parameter modified)
show xdsl vect-group (cross-dslam vectoring, vp-board in controller slot)
Commands with new parameters or parameter values that are NOT supported yet
(commands remain backward compatible with previous releases)
configure qos profiles marker [no] d1p-alignment
Removed Commands
3HH-04416-EDBA-TCZZA 01 Released 23
1 ISAM CLI
New Commands
admin alarm (new parameter names)
admin pppoe-client emulation client-id (to start or stop the PPPoE emulation of a specific interface on a
PPPoE client)
configure equipment sfpe1t1 (to configure the E1 service on E1/DS1 SFP)
configure interface shub mirror-voice-traffic (voice traffic mirroring at NANT-A/NRNT-A for voice
boards)
configure interface shub mirror-voice-traffic [no] egress-port (voice traffic mirroring at
NANT-A/NRNT-A for voice boards)
configure interface shub mirror-voice-traffic [no] ingress-port (voice traffic mirroring at
NANT-A/NRNT-A for voice boards)
configure pppoe-client (to configure the emulation interface on a PPPoE client port)
show alarm current sfpe1t1-clock (to show the alarm on E1/DS1 SFP)
show alarm current sfpe1t1-framer (to show the alarm on E1/DS1 SFP)
show alarm log sfpe1t1-clock (to show the alarm on E1/DS1 SFP)
show alarm log sfpe1t1-framer (to show the alarm on E1/DS1 SFP)
show linetest single busy-status (to show test parameters for MELT )
show linetest single chipsetdata-for-slot (to show test parameters for MELT )
show pppoe-client (to retrieve the emulation details of PPPoE client interface)
show xdsl vect-disturber-list downstream (this command will replace "show xdsl vect-disturbers" )
Commands with new parameters or parameter values that are NOT supported yet
(commands remain backward compatible with previous releases)
admin efm-oam interface (traffgen-action parameter added)
configure efm-oam interface (new parameters for ethernet traffgen added)
configure voice cluster equipment termination (parameter values for impedance added)
configure voice sip system session-timer (status enable-uas added)
configure voice sip vsp (subscribe parameters added, reneg-ct-mode value added)
configure xdsl board (vplt-autodiscover parameter added)
configure xdsl [no] vect-profile (introducing new parameters in the vect-profile to configure crosstalk
cancellation from legacy lines into G.vector lines in downstream)
show system license (adding a new license counter, vectoring-legacy, for the introduction of crosstalk
cancellation from legacy lines into G.vector lines in downstream)
show xdsl vect-carrier-data far-end (disturberline parameter type changed)
show xdsl vect-carrier-data near-end (disturberline parameter type changed)
24 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
New Commands
admin efm-oam (OAM remote Loopback support for NELT-B)
admin efm-oam interface interface loopback-action (OAM remote Loopback support for NELT-B)
show alarm current sfprssi (SFU or MDU Voice XML file downloading over OMCI)
Removed Commands
3HH-04416-EDBA-TCZZA 01 Released 25
1 ISAM CLI
Modified Commands
show interface port (OMCI for remote MDU management, ATM Pseudowire)
show interface stack (OMCI for remote MDU management)
26 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
show interface test (OMCI for remote MDU management, ATM Pseudowire)
show ipv6 users (OMCI for remote MDU management)
show mcast active-groups (OMCI for remote MDU management)
show mcast grp-membership (OMCI for remote MDU management)
show oper-data-port (OMCI for remote MDU management)
show pppox-relay cross-connect monitor-statistics client-port (OMCI for remote MDU management)
show pppox-relay cross-connect session client-port (OMCI for remote MDU management)
show pppox-relay cross-connect statistics client-port (OMCI for remote MDU management)
show qos interface-bandwidth (OMCI for remote MDU management)
show qos statistics queue current-15min (OMCI for remote MDU management)
show qos statistics queue prev-15min (OMCI for remote MDU management)
show security pae authenticator (OMCI for remote MDU management)
show security pae diagnostics (OMCI for remote MDU management)
show security pae eapol-stats (OMCI for remote MDU management)
show security pae port-details (OMCI for remote MDU management)
show security pae session-stats (OMCI for remote MDU management)
show vlan bridge-port-fdb (OMCI for remote MDU management)
show vlan cross-connect (OMCI for remote MDU management)
show vlan cross-connect vlan-id vlan-port (OMCI for remote MDU management)
show arp-relay-stats (OMCI for remote MDU management)
show cfm stack (OMCI for remote MDU management)
show config-data-port (OMCI for remote MDU management)
Modified Commands
show vlan dup-mac-alarm (OMCI for remote MDU management)
show vlan pbit-statistics port (OMCI for remote MDU management)
show vlan port-15min-stats (OMCI for remote MDU management)
show vlan port-curr-15min-stats (OMCI for remote MDU management)
show vlan port-curr-day-stats (OMCI for remote MDU management)
show vlan port-event (OMCI for remote MDU management)
show vlan port-prev-day-stats (OMCI for remote MDU management)
show vlan residential-bridge extensive (OMCI for remote MDU management)
show vlan residential-bridge summary (OMCI for remote MDU management)
show vlan vmac-bridge-port-fdb (OMCI for remote MDU management)
show xdsl config-data-port atm-pvc (OMCI for remote MDU management, ATM Pseudowire)
show xdsl oper-data-port igmp (OMCI for remote MDU management, ATM Pseudowire)
show trouble-shooting statistics interface (OMCI for remote MDU management, 2p VDSL2 bonding with
vectoring only in SLV)
3HH-04416-EDBA-TCZZA 01 Released 27
1 ISAM CLI
show trouble-shooting statistics uni-interface (OMCI for remote MDU management, 2p VDSL2 bonding
with vectoring only in SLV)
configure bridge (OMCI for remote MDU management, SC VLAN and CVLAN attachment on untagged
frames)
configure atm (ATM Pseudowire)
configure voice sip (ISAM-V SIP : Warmline)
configure voice sip vsp (ISAM-V SIP : Warmline)
configure alarm entry (2p VDSL2 bonding with vectoring only in SLV)
configure xdsl-bonding (2p VDSL2 bonding with vectoring only in SLV)
configure xdsl vect-profile (Vectoring feature extension)
configure qos interface upstream-queue (FX GPON:CVLAN translation)
show vlan current-15min-stats (EPON support extended, OMCI for remote MDU management)
show vlan current-day-stats (EPON support extended, OMCI for remote MDU management)
show vlan previous-15min-stats (EPON support extended, OMCI for remote MDU management)
Modified Commands
configure cfm (Minor Bug Fixing)
configure interface alarm (Minor Bug Fixing)
configure linetest cluster ltparm (Minor Bug Fixing)
configure system max-lt-link-speed (Minor Bug Fixing)
configure voice cluster equipment termination (Minor Bug Fixing)
configure linetest single ltparm (CI Drop)
configure linetest single ltparm test-name (CI Drop)
configure qos profiles (10G EPON)
configure trap (Minor Bug Fixing)
configure trap definition (Minor Bug Fixing)
show interface alarm (Minor Bug Fixing)
show dhcp-relay session (OMCI for remote MDU management)
show dhcp-relay v6-port-stats (OMCI for remote MDU management)
show igmp channel counter (OMCI for remote MDU management)
show igmp channel miscellaneous (OMCI for remote MDU management)
show igmp channel protocol (OMCI for remote MDU management)
show vlan vlan-day-stats (EPON support extended, OMCI for remote MDU management)
configure system security snmp community host-address (Minor Bug Fixing)
configure system security snmp group security-level (Minor Bug Fixing)
New Commands
admin cfm (CFM Application enhancements)
admin cfm ltm (CFM Application enhancements)
28 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
New Commands
configure bcmp (FX EOPN features MIB readiness)
configure bcmp system (FX EOPN features MIB readiness)
configure voice sip statistics (10G EPON)
configure voice sip statistics stats-config (10G EPON)
show alarm current sfprssi (CI Drop)
show alarm log ontsnmp (CI Drop)
show alarm log sfprssi (CI Drop)
show alarm snap-shot ontsnmp (CI Drop)
show alarm snap-shot sfprssi (CI Drop)
show bcmp (FX EOPN features MIB readiness)
show bcmp counters (FX EOPN features MIB readiness)
configure equipment rssiprof (RSSI CLI development)
Removed Commands
show alarm current psc (DR6 Feature)
show alarm log psc (DR6 Feature)
show alarm snap-shot psc (DR6 Feature)
3HH-04416-EDBA-TCZZA 01 Released 29
1 ISAM CLI
30 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
New Commands
show voice sip statistics board (SIP statistics)
show voice sip statistics board current-15min (SIP statistics)
show voice sip statistics board current-1day (SIP statistics)
show voice sip statistics board prev-15min (SIP statistics)
show voice sip statistics board prev-1day (SIP statistics)
show voice sip statistics board-perfinfo (SIP statistics)
show xdsl co-inventory (Parameter Alignment with G.997.1)
show alarm log vect-line (BL Vectoring SL Vectoring)
show alarm current vect-line (BL Vectoring SL Vectoring)
show alarm snap-shot vect-line (BL Vectoring SL Vectoring)
show alarm log vect-board (SL Vectoring)
show alarm current vect-board (SL Vectoring)
show alarm snap-shot vect-board (SL Vectoring)
configure xdsl vect-profile (BL Vectoring SL Vectoring)
configure xdsl vce-profile (BL Vectoring SL Vectoring)
configure xdsl vp-board vp-link (SL Vectoring)
show xdsl vp-board vp-link (SL Vectoring)
show xdsl vect-disturbers max-reported-dist (BL Vectoring SL Vectoring)
show xdsl vect-carrier-data near-end disturber (BL Vectoring SL Vectoring)
show xdsl vect-carrier-data far-end disturber (BL Vectoring SL Vectoring)
show xdsl failure-status vect-board (SL Vectoring)
show xdsl failure-status vect-line-near-end (BL Vectoring SL Vectoring)
Removed Commands
show qos pcc-rules fwd-port (Resource Admission Control Feature)
3HH-04416-EDBA-TCZZA 01 Released 31
1 ISAM CLI
configure mcast chn (GPON IOP for IGMP CAC and access-rights)
configure qos interface (GPON UNI scheduling/shaping based on queue parameters)
configure qos interface queue (GPON UNI scheduling/shaping based on queue parameters)
configure qos interface upstream-queue (upstream policing and queue config)
configure qos profiles ingress-qos (GPON LT color-aware trTCM)
configure qos profiles policer (GPON LT color-aware trTCM)
configure qos profiles scheduler-node (downstream UNI rate shaping to include multicast traffic)
configure qos profiles shaper (GPON UNI scheduling/shaping based on queue parameters)
configure system sync-if-timing (Full SSM on SyncE)
configure system sync-if-timing ssm (Full SSM on SyncE)
configure vlan id (Add DSL parameters in DHCPv4/v6 / PPPoE,ISAM acting as SNTP server towards
GPON ONTs)
configure voice cluster media-gateway (SIP Restoration)
configure voice cluster signal-gateway (SIP Restoration)
configure voice cluster equipment (SIP Restoration)
configure voice sip server (SIP Restoration)
configure voice sip termination (SIP Restoration)
configure voice sip user-agent (SIP Restoration)
configure voice sip system session-timer (SIP Restoration)
configure voice sip user-agent-ap (SIP Restoration)
configure voice sip vsp (SIP Restoration)
show equipment diagnostics sfp (Digital Diagnostics for SFP XFP modules)
New Commands
admin alarm clear-alarm filetransfer ip-address (manually clear filetransfer alarm)
admin system security pmfile upload (SIP: Collect statistics via FTP)
admin voice sip (Common Voice Software for ONT and ISAM-V)
configure igmp mc-vlan-xlate (GPON IOP for IGMP CAC and access-rights)
configure igmp mcast-svc-context (GPON IOP for IGMP CAC and access-rights)
configure qos ctrl-pkt-policer (Upstream policing per protocol)
configure qos profiles marker (GPON LT color-aware trTCM)
configure qos profiles marker dot1p-remark (GPON LT color-aware trTCM)
configure system security pmfile (SIP : Collect statistics via FTP)
configure system security pmfile upload (SIP : Collect statistics via FTP)
configure system sntp server-table (NTP and multiple xNTP servers support)
configure system sntp server-table ip-address (NTP and multiple xNTP servers support)
configure system sync-if-timing ssmout-ltport (Full SSM on SyncE)
configure system sync-if-timing ssmout-synce (Full SSM on SyncE)
32 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
Removed Commands
configure system security domain ip-pool (removal of DR6ed feature)
configure system security domain user (removal of DR6ed feature)
configure voice sip termination local-loop (removal of DR6ed feature)
configure xdsl line local-loop (removal of DR6ed feature)
show alarm current llu-relay (removal of DR6ed feature)
show alarm current sip-user-agent (SIP Restoration)
show alarm log llu-relay (removal of DR6ed feature)
show alarm log sip-user-agent (SIP Restoration)
show alarm snap-shot llu-relay (removal of DR6ed feature)
show alarm snap-shot sip-user-agent (SIP Restoration)
3HH-04416-EDBA-TCZZA 01 Released 33
1 ISAM CLI
New Commands
admin alarm shub clear-alarm (CLI clear command for Neighbour State Changed alarm on NANT-A)
admin xstp (FD 36p Ethernet LT (NELT-B))
admin xstp port (FD 36p Ethernet LT (NELT-B))
admin igmp mcast-chn (Multicast channel selection)
configure mcast (Multicast channel selection based on VlanID)
configure mcast chn (Multicast channel selection based on VlanID)
configure mcast monitor (Multicast channel selection based on VlanID)
show xdsl-bonding operational-data lin (Transport B-Fast)
34 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
Removed Commands
configure linetst (ISAM-V H248 CLI enhancement)
configure linetst cluster (ISAM-V H248 CLI enhancement)
configure linetst cluster ltline (ISAM-V H248 CLI enhancement)
configure linetst cluster ltparam (ISAM-V H248 CLI enhancement)
configure linetstcluster ltsession (ISAM-V H248 CLI enhancement)
configure linetst single (ISAM-V H248 CLI enhancement)
configure linetst single ltline (ISAM-V H248 CLI enhancement)
configure linetst single ltparam (ISAM-V H248 CLI enhancement)
configure linetst single ltsession (ISAM-V H248 CLI enhancement)
show linetst (ISAM-V H248 CLI enhancement)
show linetst cluster (ISAM-V H248 CLI enhancement)
show linetst cluster avail-sess (ISAM-V H248 CLI enhancement)
show linetst cluster lineid-ext-rept (ISAM-V H248 CLI enhancement)
show linetst cluster ltline (ISAM-V H248 CLI enhancement)
show linetst cluster ltsession (ISAM-V H248 CLI enhancement)
show linetst single (ISAM-V H248 CLI enhancement)
3HH-04416-EDBA-TCZZA 01 Released 35
1 ISAM CLI
36 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
3HH-04416-EDBA-TCZZA 01 Released 37
1 ISAM CLI
38 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
New Commands
admin dhcp-relay v6-port-stats (IPv6 Protocol Aware CC with DHCPv6 on FD)
admin alarm shub clear-alarm vrf interface (Problem Solving)
admin voice cluster equipment (ISAM-V)
admin voice cluster media-gateway (ISAM-V)
admin xstp port clear-protocols (FD 36p Ethernet LT (NELT-B))
configure dhcp-relay v6-port-stats (IPv6 Protocol Aware CC with DHCPv6 on FD)
configure ethernet line mau (FD 36p Ethernet LT (NELT-B))
configure linetest (ISAM-V H248 : CLI enhancements)
configure linetest cluster (ISAM-V H248 : CLI enhancements)
configure linetest cluster ltline (ISAM-V H248 : CLI enhancements)
configure linetest cluster ltparm (ISAM-V H248 : CLI enhancements)
configure linetest cluster ltsession (ISAM-V H248 : CLI enhancements)
configure linetest single (ISAM-V H248 : CLI enhancements)
configure linetest single ltline lineid (ISAM-V H248 : CLI enhancements)
configure linetest single ltparm tst-type (ISAM-V H248 : CLI enhancements)
configure linetest single ltsession session-cmd (ISAM-V H248 : CLI enhancements)
configure link-agg (FD 36p Ethernet LT (NELT-B))
configure link-agg general priority (FD 36p Ethernet LT (NELT-B))
configure link-agg group load-sharing-policy (FD 36p Ethernet LT (NELT-B))
configure link-agg group port (FD 36p Ethernet LT (NELT-B))
configure link-agg port passive-lacp (FD 36p Ethernet LT (NELT-B))
configure mcast static (FD 36p Ethernet LT (NELT-B))
configure mcast static branch (FD 36p Ethernet LT (NELT-B))
configure system max-lt-link-speed link-speed (NRNT-A CLI/TL1 Adaptation)
3HH-04416-EDBA-TCZZA 01 Released 39
1 ISAM CLI
40 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
show dhcp-relay v6-port-stats vlan v6extensive (IPv6 Protocol Aware CC with DHCPv6 on FD)
show dhcp-relay v6-port-stats vlan v6summary (IPv6 Protocol Aware CC with DHCPv6 on FD)
show ethernet statistics (FD 36p Ethernet LT (NELT-B))
show ethernet statistics line (FD 36p Ethernet LT (NELT-B))
show ipv6 (IPv6 Protocol Aware CC with DHCPv6 on FD)
show linetest (ISAM-V H248 : CLI enhancements)
show linetest cluster (ISAM-V H248 : CLI enhancements)
show linetest cluster avail-sess (ISAM-V H248 : CLI enhancements)
show linetest cluster lineid-ext-rept (ISAM-V H248 : CLI enhancements)
show linetest cluster ltline (ISAM-V H248 : CLI enhancements)
Removed Commands
configure mcast src (Fixed multicast VLAN per IGMP channel)
configure mcast src packagemember (Fixed multicast VLAN per IGMP channel)
show bridge port-to-atm-pvc (ISAM-V H248:CLI enhancements)
3HH-04416-EDBA-TCZZA 01 Released 41
1 ISAM CLI
42 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
configure qos profiles l2-filter (IPv6 Protocol Aware CC with DHCPv6 on FD)
configure qos profiles policer (FD 36p Ethernet LT (NELT-B))
configure qos profiles queue (GPON support)
configure qos profiles shaper (GPON support)
configure qos shdsl-port (GPON support)
configure qos shub policer (NRNT-A; mini-ISAM NT)
configure qos shub queue-config (NRNT-A; mini-ISAM NT)
configure qos tc-map-dot1p (FD 36p Ethernet LT (NELT-B))
configure qos tca queue (GPON support)
configure system loop-id-syntax (GPON support)
configure system security profile (Lawful Intercept)
configure system security default-profile (Lawful Intercept)
configure system security pae authenticator (GPON support)
configure system security pae ext-authenticator (GPON support)
configure system security pae port (GPON support)
configure system security radius (GPON support)
configure system security ssh access (GPON support)
configure system security snmp group security-level (Lawful Intercept)
configure system security snmp map-user-group (Lawful Intercept)
configure system shub filter ip-filter in-port port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter out-port port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter icmp in-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter icmp out-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter port-filter in-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter port-filter out-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter tcp in-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter tcp out-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter udp in-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter udp out-port (NRNT-A; mini-ISAM NT)
configure system syslog destination (GPON support)
configure system syslog route msg-type (GPON support)
configure transport shub mac-infilter port (NRNT-A; mini-ISAM NT)
configure transport shub rate-limit (NRNT-A; mini-ISAM NT)
configure trap manager (Reliable Trap management)
configure trouble-shooting statistics interface (GPON support)
configure trap definition (Reliable Trap management)
configure vlan id (IPv6 Protocol Aware CC with DHCPv6 on FD)
3HH-04416-EDBA-TCZZA 01 Released 43
1 ISAM CLI
configure vlan port-protocol protocol-group (IPv6 Protocol Aware CC with DHCPv6 on FD)
configure vlan unicast-mac vlan-id (GPON support)
configure vlan vlan-port unicast-mac (GPON support)
configure vlan pbit-statistics port (GPON support)
configure vlan shub unicast-mac (NRNT-A; mini-ISAM NT)
configure vlan shub id egress-port (NRNT-A; mini-ISAM NT)
configure vlan shub id untag-port (NRNT-A; mini-ISAM NT)
configure voice cluster media-gateway (ISAM-V)
configure voice cluster equipment board (ISAM-V)
configure voice cluster equipment termination (ISAM-V)
configure voice sip termination (ISAM-V)
configure voice sip lineid-syn-prof (ISAM-V)
configure voice sip vsp (ISAM-V)
configure xdsl overrule-data (standard ARQ for ADSL2 (+)and VDSL2)
configure xdsl service-profile (SRA for VDSL2)
configure xdsl line (standard ARQ for ADSL2 (+)and VDSL2)
configure xdsl line tca-line-threshold (standard ARQ for ADSL2 (+)and VDSL2)
configure xdsl-bonding group-profile (8p PTM VDSL2 bonding on FD)
show arp-relay-stats (GPON support)
show bridge network-port (NRNT-A; mini-ISAM NT)
show cluster connect (NRNT-A; mini-ISAM NT)
show cluster counter (NRNT-A; mini-ISAM NT)
show cluster neighbour (NRNT-A; mini-ISAM NT)
44 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
3HH-04416-EDBA-TCZZA 01 Released 45
1 ISAM CLI
New Commands
admin dhcp-relay v6-port-stats (IPv6 Protocol Aware CC with DHCPv6 on FD)
admin voice cluster equipment (ISAM-V)
admin voice cluster media-gateway (ISAM-V)
configure dhcp-relay v6-port-stats (IPv6 Protocol Aware CC with DHCPv6 on FD)
configure ethernet line mau (FD 36p Ethernet LT (NELT-B))
configure linetest (ISAM-V H248 : CLI enhancements)
configure linetest cluster (ISAM-V H248 : CLI enhancements)
configure linetest cluster ltline lineid (ISAM-V H248 : CLI enhancements)
configure linetest cluster ltparm tst-type (ISAM-V H248 : CLI enhancements)
configure linetest cluster ltsession (ISAM-V H248 : CLI enhancements)
configure linetest single (ISAM-V H248 : CLI enhancements)
configure linetest single ltline lineid (ISAM-V H248 : CLI enhancements)
configure linetest single ltparm tst-type (ISAM-V H248 : CLI enhancements)
configure linetest single ltsession (ISAM-V H248 : CLI enhancements)
configure link-agg (FD 36p Ethernet LT (NELT-B))
configure link-agg general priority (FD 36p Ethernet LT (NELT-B))
configure link-agg group load-sharing-policy (FD 36p Ethernet LT (NELT-B))
configure link-agg group port (FD 36p Ethernet LT (NELT-B))
configure link-agg port passive-lacp (FD 36p Ethernet LT (NELT-B))
configure mcast monitor (GPON support)
configure mcast monitor src (GPON support)
46 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
3HH-04416-EDBA-TCZZA 01 Released 47
1 ISAM CLI
48 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
Removed Commands
configure mcast src (Fixed multicast VLAN per IGMP channel)
configure mcast src packagemember (Fixed multicast VLAN per IGMP channel)
configure qos profiles scheduler (GPON support)
show qos profile-usage scheduler (GPON support)
show vlan fdb mac (GPON support)
show bridge port-to-atm-pvc (ISAM-V H248:CLI enhancements)
3HH-04416-EDBA-TCZZA 01 Released 49
1 ISAM CLI
1.2 Preface
Scope
This user guide describes the Command Line Interface (CLI) commands supported by the Alcatel-Lucent 7302
ISAM, 7330 ISAM FTTN and 7360 ISAM. These commands are used for installation, configuration, management
and troubleshooting.
User Profile
The guide is intended for operating personnel (sometimes called craft persons).
50 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
Command Types
The commands of the CLI language can be divided into two groups: global and environmental commands.
Global commands (such as the logout command) can be entered in any context and have the same effect in each
context.
Environmental commands (such as the info command) can only be entered in some contexts (for example, the info
command cannot be used in the show node) and have a different effect in each context. The purpose of the
command (for example, showing the configuration) is the same but the implementation or the generated output is
different.
Some commands are also implicit. For example, when you enter only the node name configure system security
snmp community fden, you run an implicit command that changes your context to the specified node and that
creates this node if it did not previously exist.
The available commands are discussed in a separate chapter.
Access Rights
Not every operator can execute every command.
Access to commands is granted via the operator profile.
It is possible that an operator can execute a given command in one context and not in another.
3HH-04416-EDBA-TCZZA 01 Released 51
1 ISAM CLI
1.4 Nodes
Node Definition
A command definition tree, further abbreviated to "command tree" is a structure of nested command nodes from
which CLI commands can be derived. A command node consists of a node name and zero or more resource
identifiers. The resource identifiers behave like parameters, but identify a particular resource. For example, public
in configure system security snmp community public is an unnamed resource identifier of the node community.
One such command node identifies a context. A CLI command can be derived from a command tree starting from
the root node, but a command with the same meaning and impact can also be derived from a lower level node or
subnode. The following are examples of equivalent commands:
• info configure system security snmp community public in any node.
• info system security snmp community public in node configure
• info security snmp community public in node configure system
• info snmp community public in node configure system security
• info community public in node configure system security snmp
• info in node configure system security snmp community public
The root node is the highest level. Directly below the root node are important command nodes such as configure
and show.
Node Creation
A dynamic node is a sub-node of the configure node that corresponds to a configurable resource that an operator
can create.
An operator can create a dynamic node by navigating to it. The system will automatically create the node. The
operator can configure its prompt in such a way that it shows if the operator navigated to an existing or a new node.
The ability to create nodes is limited by the access rights of the user.
It is also possible that the system creates additional subnodes in other nodes, for example, in the show node due to
the creation of a new dynamic node in the configure node.
Node Deletion
A dynamic node can be deleted by placing no in front of the node name. For example, configure system security
snmp no community public deletes the specified node and all its subnodes. The ability to delete nodes is limited
by the access rights of the operator.
Resource Attributes
The value of resource attributes can be changed by entering the name of the resource attribute followed by the new
value. For example, password plain:secret sets the value of the resource attribute named password to the plain
text string secret.
Resource attributes can be set to their default value by entering no followed by the name of the resource attribute.
For example, no password sets the value of the resource attribute named password to the default value (no
password required).
52 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
1.5 Parameters
Parameter Types
Parameter values belong to a parameter type. Parameter types limit the parameter values to strings that the system
can understand.
Parameter types consists of 1 to N fields with separators in between. Each field belongs to a basic type. The
separator is in most cases a colon : or a slash /.
The name of parameter types always starts with an uppercase character and can contain an optional domain name.
The domain name is separated from the parameter name by ::.
The sequence in which the fields appear can differ in case one of the fields belongs to an enumeration type. For
example, if provided some possible values for the parameter type ExtendedFileName (the first field is an
enumeration field with possible values file and ftp, host-name, user-name, password and local-file are also fields):
• file: local-file
• ftp: host-name @ user-name : password / local-file
Basic Types
Basic types can be divided in two groups: fixed length basic types and variable length basic types.
Examples of variable length basic types are:
• integers
• printable strings (representing operator chosen names or descriptions)
• SNMP object identifiers
• binary strings
The length of a variable length basic type is in most cases limited. The definition of logical length depends on the
basic type: number of characters for printable strings, number of bytes for binary strings, and number of numbers in
the object identfier for SNMP object identifiers.
Examples of fixed length basic types are:
• ip-address
• fixed-length printable strings
• enumeration types (limited list of allowed strings)
3HH-04416-EDBA-TCZZA 01 Released 53
1 ISAM CLI
Binary strings must be entered as: hex-byte : hex-byte :...: hex-byte. hex-byte is a number between 0 and 255 in
hexadecimal format (all lowercase).For example, 3f:23:ff:b2 is a valid binary string.
Object identifiers and ipv4-addresses must be entered as: decimal-number . decimal-number .....
decimal-number.For example, 128.17.32.45 is a valid object identifier.
The values of all fields may be placed within double quotes. A field separator can never be placed within double
quotes. For example, "1"/"1" is a valid shelf identifier, but "1/1" is not a valid shelf identifier.
A field value can contain multiple double quotes. For example, "hallo world" is equivalent to hallo" "world or to
"hallo"" ""world".
Printable strings must be placed within double quotes if they contain special characters: double quote ", a backslash
\, a question mark ?, a cross #, a space, a tab, a carriage return, or a new line.
The backslash \ is the escape character. The double quote " and backslash \ characters must be preceded by the
escape character. The \ char is equivalent to char with the following exceptions:
• \r : carriage-return
• \t : tab
• \n : new-line
In some cases it is possible that a command is ambiguous. For example, info operator detail can be interpreted in
two ways: list the configuration of the operator with the name detail or list the configuration of all operators in
detail.
The ambiguity is solved by the parser in the following way: if the string contains quotes, it is interpreted as a
printable string, otherwise it is interpreted as a keyword. For example, info operator "detail" lists the
configuration of the operator with the name detail and info operator detail lists the configuration of all operators
in detail.
Syntax Check
The system verifies if each typed character is syntactically correct.
In case the system detects a syntax error, it will position the cursor at the offending character and beep.
This can give strange effects if you are entering characters in the 'insert mode': the invalid characters will shift to
the right and any newly entered character will be inserted in front of the faulty characters.
To avoid this strange effect, it is recommended to work in the (default) overwrite mode.
Command Repetition
Values of parameters may contain decimal, hexadecimal or character ranges. These ranges indicate that the
concerned command must be repeated a number of times with the different values as specified in the range.
Decimal ranges are entered as [ d: start...end ] in which start and end are integers. Example of a decimal range:
lt:1/1/[4...16]
Hexadecimal ranges are entered as [ h: start...end ] in which start and end are hexadecimal numbers. start and end
values may not contain uppercase characters and the number of characters of the first start value determines the
number of characters to be entered for the following values in the range. Example of a hexadecimal range:
54 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
03:06:ff:[h:aa...bd]
Character ranges are entered as [ c: start...end ] in which start and end are characters. start and end value must
belong to the same character class: digit, lowercase or uppercase. Special characters are not allowed. Example of a
character range : operator[c:a...f]
Ranging is not supported for float values
Ranges have following restrictions:
• One command may only contain 1 range.
• The default range type is decimal. It will be used if the type is not explicitely mentioned with 'd:' , 'h:' or 'c:'.
• Subranges can be separated with a comma. For example: [d:17...19,32,60...62] will be replaced consecutively
with the values 17, 18, 19, 32, 60, 61 and 62.
• Ranges between quotes are not expanded.
• Command completion may refuse to work once a range is entered.
• Execution of command repetition will stop once an iteration in the range fails.
The system sometimes restricts which range type may be used: the system only allows a decimal range where a
decimal number can be entered or a hexadecimal range where a hexadecimal number can be entered. It even
imposes that the range replaces completely the number. Example: 1[2...3] is invalid, [12...13] must be entered
instead. Also the start and end of the range must fall in the allowed range for the number. Only text strings may
contain all types of ranges.
The way the system handles a range depends on the command.
• Some commands can handle ranges directly. Repeating the command will be done internally. The command
will then behave for the operator as a normal command..
• For the other commands, the system will execute the command end - start + 1 times in which the specified
range is each time replaced by a number out of the range. Each expanded command is shown to the operator.
Commands that normally change the context, don't do this in this case. The command repetition can be stopped
via an interrupt.
• Range commands in combination with help "?" character always show the complete list of available parameters
and subnodes and do not suppress subnodes in case of the existing nodes.
3HH-04416-EDBA-TCZZA 01 Released 55
1 ISAM CLI
1.6 Filters
The language provides filters to manipulate the output of commands.
For list of available filters, please refer to command description of section "CLI Filters".
Filters can be specified in case the command generates output. They are separated from the basic command with a
pipe character |.
The user can specify a sequence of filters as in following example: info | match exact:1/1 | count lines.
56 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
1.7 Printers
The language provides printers to allow the user to decide how the output must be printed on his terminal.
The available printers are discussed in detail in a separate chapter.
Printers can be specified in case the command generates output. They are separated from the basic command with a
pipe character |.
The user can specify maximum one printer as in following example: info | match exact:1/1 | more
The default printer can be specified for the CLI session or the operator.
3HH-04416-EDBA-TCZZA 01 Released 57
1 ISAM CLI
58 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
3HH-04416-EDBA-TCZZA 01 Released 59
1 ISAM CLI
60 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
Strategy
ISAM has provided a Command Line Interface since the beginning. With each new Software Release, new features
are added and as a consequence also the CLI commands need to evolve.
New features often result in new commands or extension of existing commands.
3HH-04416-EDBA-TCZZA 01 Released 61
1 ISAM CLI
62 Released 3HH-04416-EDBA-TCZZA 01
1 ISAM CLI
Announcement Release
The announcement release is the release in which we announce to the customer that a defined set of "impacted" cli
commands will phase-out in the phase-out release. The announcement release is independent from the release in
which the commands and/or parameters became 'obsolete'. The "impacted" cli commands are the commands which
are obsolete or the commands which contain obsolete parameters.
See chapter 'Command Phase Out Annoucement Release' for the list of "impacted" CLI commands.
Customer Impact
• List of impacted commands (See chapter 'Command Phase Out Annoucement Release') should carefully be
checked in the CLI Command Guide chapter Announcement Release. The obsolete commands and/or obsolete
parameters are indicated in the command tree by the prefix X.
• The customer should determine the phase-out release.
• Any OSS systems and/or scripts using CLI commands should be checked and updated if required.
• Once the command is phased-out, the normal error reporting will be applicable.
3HH-04416-EDBA-TCZZA 01 Released 63
1 ISAM CLI
64 Released 3HH-04416-EDBA-TCZZA 01
2- Environment Configuration Commands
3HH-04416-EDBA-TCZZA 01 Released 65
2 Environment Configuration Commands
Description
This chapter gives an overview of nodes that are handled by "Environment Configuration Commands".
Command Tree
----environment
- [no] prompt
- [no] terminal-timeout
- [no] print
- [no] inhibit-alarms
- [no] mode
66 Released 3HH-04416-EDBA-TCZZA 01
2 Environment Configuration Commands
Command Description
This command allows the operator to manage the session-specific parameters. These parameters are only valid for
a specific session and are lost when the user logs out.
The default values for prompt and print can be found in configure system security operator operator-name.
The default value for terminal-timeout can be found in configure system security profile profile-name.
terminal-timeout: A value of 0 equals an infinite timeout value (i.e. the terminal will never time out).
The prompt can be composed with following components :
• %n : the name of the current operator.
• %s : the current numbering scheme (typ|leg|pos).
• %i : the current system id.
• %! : the current history number.
• % num d : the current context.
- num is the maximum number of components (starting from the last) that are shown (default is all).
- each component will be separated from the next one with a >.
- a > is also added in front of the first component.
• %% : a %
• %c : # if the current node was an existing node or $ if it is newly created.
• %h : the current system id.
• any other character is just added to the prompt as is.
User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 2.2-2 "Environment Configuration Command" Command Parameters
Parameter Type Description
[no] prompt Parameter type: <Sec::Prompt> optional parameter with default
Format: value: ""
- a specification of the prompt the specification of the prompt
- length: x<=28
[no] terminal-timeout Parameter type: <Sec::EnvInactivityTimeout> optional parameter with default
Format: value: "timeout : 30"
( default specify the inactivity timeout of
3HH-04416-EDBA-TCZZA 01 Released 67
2 Environment Configuration Commands
68 Released 3HH-04416-EDBA-TCZZA 01
3- Alarm Configuration Commands
3HH-04416-EDBA-TCZZA 01 Released 69
3 Alarm Configuration Commands
Description
This chapter gives an overview of nodes that are handled by "Alarm Configuration Commands".
Command Tree
----configure
----alarm
- log-sev-level
- log-full-action
- non-itf-rep-sev-level
----entry
- (index)
- [no] severity
- [no] service-affecting
- [no] reporting
- [no] logging
----delta-log
- indet-log-full-action
- warn-log-full-action
- minor-log-full-action
- major-log-full-action
- crit-log-full-act
----shub
----entry
- (index)
- severity
- [no] service-affecting
- [no] reporting
----[no] custom-profile
- (name)
- [no] mnemonic1
- [no] description1
- [no] visible1
- [no] audible1
- [no] polarity1
- [no] severity1
- [no] mnemonic2
- [no] description2
- [no] visible2
- [no] audible2
- [no] polarity2
- [no] severity2
- [no] mnemonic3
- [no] description3
- [no] visible3
- [no] audible3
- [no] polarity3
- [no] severity3
- [no] mnemonic4
- [no] description4
70 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
- [no] visible4
- [no] audible4
- [no] polarity4
- [no] severity4
- [no] mnemonic5
- [no] description5
- [no] visible5
- [no] audible5
- [no] polarity5
- [no] severity5
----filter
- (fltr-type)
- filterid
- alarmid
- [no] status
- [no] threshold
- [no] window
3HH-04416-EDBA-TCZZA 01 Released 71
3 Alarm Configuration Commands
Command Description
This command allows the operator to maintain a log that contains all alarm state changes by enabling the logging
mode and setting the severity level equal to or higher than the severity level that the operator is interested in.
User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 3.2-2 "Alarm Log Configuration Command" Command Parameters
Parameter Type Description
log-sev-level Parameter type: <Alarm::alarmSeverityReport> optional parameter
Format: set the lowest severity level to log
( indeterminate alarms
| warning
| minor
| major
| critical )
Possible values:
- indeterminate : not a definite known severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
log-full-action Parameter type: <Alarm::alarmLogFullAction> optional parameter
Format: set the action if log buffer is full
( wrap
| halt )
Possible values:
- wrap : older log records are overwritten by recent ones
- halt : logging is stopped until the log buffer is reset
non-itf-rep-sev-level Parameter type: <Alarm::alarmSeverityReport> optional parameter
Format: set minimum severity level to
( indeterminate report non itf alarms
| warning
| minor
| major
72 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
3HH-04416-EDBA-TCZZA 01 Released 73
3 Alarm Configuration Commands
Command Description
This command allows the operator to manage local alarm entries.
User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 3.3-1 "Alarm Entry Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
( xtca-ne-es
| xtca-ne-ses
| xtca-ne-uas
| xtca-ne-day-es
| xtca-ne-day-ses
| xtca-ne-day-uas
| xtca-fe-es
| xtca-fe-ses
| xtca-fe-uas
| xtca-fe-day-es
| xtca-fe-day-ses
| xtca-fe-day-uas
| xtca-leftrs
| xtca-day-leftrs
| xtca-fe-leftrs
| xtca-fe-day-leftrs
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom
| xdsl-ne-ese
| xdsl-act-cfg-error
| xdsl-act-not-feas
| xdsl-up-br-reach
| xdsl-ne-ncd
| xdsl-ne-lcd
| xdsl-ne-lor
74 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
3HH-04416-EDBA-TCZZA 01 Released 75
3 Alarm Configuration Commands
76 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
3HH-04416-EDBA-TCZZA 01 Released 77
3 Alarm Configuration Commands
78 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
3HH-04416-EDBA-TCZZA 01 Released 79
3 Alarm Configuration Commands
80 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
3HH-04416-EDBA-TCZZA 01 Released 81
3 Alarm Configuration Commands
82 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
3HH-04416-EDBA-TCZZA 01 Released 83
3 Alarm Configuration Commands
84 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
3HH-04416-EDBA-TCZZA 01 Released 85
3 Alarm Configuration Commands
86 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
3HH-04416-EDBA-TCZZA 01 Released 87
3 Alarm Configuration Commands
88 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
3HH-04416-EDBA-TCZZA 01 Released 89
3 Alarm Configuration Commands
90 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
3HH-04416-EDBA-TCZZA 01 Released 91
3 Alarm Configuration Commands
Command Output
Table 3.3-3 "Alarm Entry Configuration Command" Display parameters
Specific Information
name Type Description
category Parameter type: <Alarm::category> category of an alarm
( communications This element is always shown.
| qos
| processing-error
| equipment
| environmental )
Possible values:
- communications : communications related alarms
- qos : QoS related alarms
- processing-error : processing failure related alarms
- equipment : equipment related alarms
- environmental : environmental related alarms
92 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
Command Description
This command allows the operator to configure the action of the system when the alarm log buffer is full.
If the action is set to wrap, older log records are overwritten by recent records. If the action is set to halt, logging
is stopped until the log buffer is reset.
User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 3.4-2 "Alarm Delta Log Configuration Command" Command Parameters
Parameter Type Description
indet-log-full-action Parameter type: <Alarm::alarmDeltaLogFullAction> optional parameter
Format: set the action when indeterminate
( wrap log buffer is full
| halt )
Possible values:
- wrap : wrap around when log is full
- halt : halt logging when log is full
warn-log-full-action Parameter type: <Alarm::alarmDeltaLogFullAction> optional parameter
Format: set the action when warn delta
( wrap log buffer is full
| halt )
Possible values:
- wrap : wrap around when log is full
- halt : halt logging when log is full
minor-log-full-action Parameter type: <Alarm::alarmDeltaLogFullAction> optional parameter
Format: set the action when minor delta
( wrap log buffer is full
| halt )
Possible values:
- wrap : wrap around when log is full
- halt : halt logging when log is full
major-log-full-action Parameter type: <Alarm::alarmDeltaLogFullAction> optional parameter
Format: set action when major delta log
( wrap buffer is full
3HH-04416-EDBA-TCZZA 01 Released 93
3 Alarm Configuration Commands
94 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
Command Description
This command allows the operator to configure the SHub alarm parameters.
User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 3.5-1 "SHub Alarm Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
( db-restore
| reboot
| sntp-comm
| eth-link-down
| mac-conflict
| oper-speed-mismatch
| ospf-itf-err
| ospf-auth-err
| ospf-rx-bad-err
| ospf-lsdb-oflow
| ospf-nhbr-statchg
| ospf-itf-statchg
| ospf-ext-lsa-threshold
| ospf-instance-down
| rip-config-err
| rip-auth-fail
| rip-rcv-bad-pkt
| rip-table-treshold
| rip-instance-down
| arp-table-full
| route-tbl-overflow
| uplink-down
| pccp-down
| global-ospf-route
| global-ospf-lsa-tbl
| global-ospf-retrms-tbl
3HH-04416-EDBA-TCZZA 01 Released 95
3 Alarm Configuration Commands
96 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
Command Output
Table 3.5-3 "SHub Alarm Configuration Command" Display parameters
Specific Information
name Type Description
category Parameter type: <Alarm::category> defines the category of an alarm.
( communications This element is always shown.
| qos
| processing-error
| equipment
| environmental )
Possible values:
- communications : communications related alarms
- qos : QoS related alarms
- processing-error : processing failure related alarms
- equipment : equipment related alarms
- environmental : environmental related alarms
3HH-04416-EDBA-TCZZA 01 Released 97
3 Alarm Configuration Commands
Command Description
This command allows the operator to configure the external alarm profile. The profile is made to be assigned to a
remote LT board. The profile reflects a configuration of external alarms parameters that corresponds to a certain
environment where the remote board is located (in an outdoor cabinet, basement cabinet, ...). The use of a profile
avoids the need to specify the parameters for each remote board separately. The alarm profile groups all five
external alarms parameters. The profile contains a description/meaning of each alarm, as well as an indication
that tells us whether or not any alarm outputs are to be triggered if the corresponding external input alarm is
raised. On top of these parameters, a mnemonic (short for the description), the polarity and the severity are
configurable. Note: The Severity parameters of custom alarm profile i.e
(severity1,severity2,severity3,severity4,severity5) are supported for only FD-REM not other shelfs.
User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 3.6-1 "Customizable Alarm Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: custom profile name
- a profile name
98 Released 3HH-04416-EDBA-TCZZA 01
3 Alarm Configuration Commands
3HH-04416-EDBA-TCZZA 01 Released 99
3 Alarm Configuration Commands
Command Description
This command allows the operator to configure Alarm filter parameters.
User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.
Command Syntax
The command has the following syntax:
> configure alarm filter (fltr-type) filterid <Alarm::fltrId> [ alarmid <Alarm::alarmIndex> ] [ no status | status
<Alarm::fltrStatus> ] [ no threshold | threshold <Alarm::fltrThreshold> ] [ no window | window
<Alarm::fltrWindow> ]
Command Parameters
Table 3.7-1 "Alarm Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(fltr-type) Format: the type of the considered alarm
( temporal filter
| spatial )
Possible values:
- temporal : the temporal alarm filter
- spatial : the spatial alarm filter
filterid Parameter type: <Alarm::fltrId> unique filter number
Format:
- unique filter number
- range: [1...31]
Table 3.7-2 "Alarm Filter Configuration Command" Command Parameters
Parameter Type Description
alarmid Parameter type: <Alarm::alarmIndex> optional parameter
Format: alarmType
( xtca-ne-es
| xtca-ne-ses
| xtca-ne-uas
| xtca-ne-day-es
| xtca-ne-day-ses
| xtca-ne-day-uas
| xtca-fe-es
| xtca-fe-ses
| xtca-fe-uas
| xtca-fe-day-es
| xtca-fe-day-ses
Description
This chapter gives an overview of nodes that are handled by "Trap Configuration Commands".
Command Tree
----configure
----trap
----definition
- (name)
- priority
----[no] manager
- (address)
- [no] priority
- [no] cold-start-trap
- [no] link-down-trap
- [no] link-up-trap
- [no] auth-fail-trap
- [no] change-trap
- [no] line-test-trap
- [no] init-started-trap
- [no] lic-key-chg-occr
- [no] topology-chg
- [no] selt-state-chg
- [no] dhcp-sess-pre
- [no] alarm-chg-trap
- [no] phys-line-trap
- [no] eqpt-change-trap
- [no] success-set-trap
- [no] other-alarm-trap
- [no] warning-trap
- [no] minor-trap
- [no] major-trap
- [no] critical-trap
- [no] redundancy-trap
- [no] eqpt-prot-trap
- [no] craft-login-trap
- [no] restart-trap
- [no] ntr-trap
- [no] rad-srvr-fail
- [no] login-occr-trap
- [no] logout-occr-trap
- [no] trapmngr-chg-trap
- [no] mst-genral
- [no] mst-error
- [no] mst-protocol-mig
- [no] mst-inv-bpdu-rx
- [no] mst-reg-conf-chg
- [no] dying-gasp
- [no] max-per-window
- [no] window-size
- [no] max-queue-size
- [no] min-interval
- [no] min-severity
Command Description
This command allows the operator to define the priority of a given trap.
User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 4.2-1 "Trap Definition Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: the name of the trap
( cold-start
| link-down
| link-up
| auth-failure
| change-occured
| line-test-report
| init-started
| lic-key-chg-occr
| topology-chg
| selt-state-chg
| dhcp-sess-pre
| radius-server-failure
| login-occured
| logout-occured
| trapmngr-chg-occr
| mst-genral
| mst-error
| mst-protocol-mig
| mst-inv-bpdu-rx
| mst-reg-conf-chg
| dying-gasp )
Possible values:
- cold-start : the node is reinitializing
- link-down : one of the communication links of the node
has failed
- link-up : one of the communication links of the node
became operational
Command Description
This command allows the operator to configure an SNMP manager, which will receive traps when an event occurs
in the system.
The SNMP manager can easily be flooded by events if something happens to the system. This command allows the
operator to specify which traps the manager is interested in (trap filtering) and how the traps must be distributed in
time (trap shaping).
Traps that cannot be delivered will be dropped.
The Following traps will be sent as a part of changeOccuredTrap alarm-chg-trap, phys-line-trap,
eqpt-change-trap, success-set-trap, other-alarm-trap, warning-trap, minor-trap, major-trap, critical-trap,
redundancy-trap, eqpt-prot-trap, craft-login-trap, restart-trap, ntr-trap.
User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.
Command Syntax
The command has the following syntax:
> configure trap ( no manager (address) ) | ( manager (address) [ no priority | priority <Trap::Priority> ] [ [ no ]
cold-start-trap ] [ [ no ] link-down-trap ] [ [ no ] link-up-trap ] [ [ no ] auth-fail-trap ] [ [ no ] change-trap ] [ [ no ]
line-test-trap ] [ [ no ] init-started-trap ] [ [ no ] lic-key-chg-occr ] [ [ no ] topology-chg ] [ [ no ] selt-state-chg ] [ [
no ] dhcp-sess-pre ] [ [ no ] alarm-chg-trap ] [ [ no ] phys-line-trap ] [ [ no ] eqpt-change-trap ] [ [ no ]
success-set-trap ] [ [ no ] other-alarm-trap ] [ [ no ] warning-trap ] [ [ no ] minor-trap ] [ [ no ] major-trap ] [ [ no ]
critical-trap ] [ [ no ] redundancy-trap ] [ [ no ] eqpt-prot-trap ] [ [ no ] craft-login-trap ] [ [ no ] restart-trap ] [ [ no ]
ntr-trap ] [ [ no ] rad-srvr-fail ] [ [ no ] login-occr-trap ] [ [ no ] logout-occr-trap ] [ [ no ] trapmngr-chg-trap ] [ [ no
] mst-genral ] [ [ no ] mst-error ] [ [ no ] mst-protocol-mig ] [ [ no ] mst-inv-bpdu-rx ] [ [ no ] mst-reg-conf-chg ] [ [
no ] dying-gasp ] [ no max-per-window | max-per-window <Trap::WindowCount> ] [ no window-size |
window-size <Trap::WindowSize> ] [ no max-queue-size | max-queue-size <Trap::QueueSize> ] [ no min-interval |
min-interval <Trap::Interval> ] [ no min-severity | min-severity <Alarm::alarmSeverityReport> ] )
Command Parameters
Table 4.3-1 "Trap Manager Configuration Command" Resource Parameters
Resource Identifier Type Description
(address) Format: the address of the manager
<Ip::V4Address> : <Trap::Port>
Field type <Ip::V4Address>
- IPv4-address
Field type <Trap::Port>
- trap port number
- range: [1...65535]
Table 4.3-2 "Trap Manager Configuration Command" Command Parameters
Description
This chapter gives an overview of nodes that are handled by "Equipment Configuration Commands".
Command Tree
----configure
----equipment
----rack
- (index)
- [no] description
----shelf
- (index)
- [no] class
- [no] planned-type
- [no] lock
X [no] extended-lt-slots
- [no] mode
- [no] description
----slot
- (index)
- [no] planned-type
- [no] power-down
- [no] unlock
- [no] alarm-profile
- [no] capab-profile
- [no] dual-host-ip
- [no] dual-host-loc
----applique
- (index)
- [no] planned-type
- [no] applique-profile
----protection-group
- (prot-group-id)
- [no] admin-status
- [no] eps-quenchfactor
----protection-element
- (index)
- [no] redcy-ctrl-status
----external-link-host
- (faceplate-number)
- [no] direction
----external-link-assign
- (faceplate-number)
- [no] remote
----diagnostics
----sfp
- (position)
- [no] rssi-prof-id
- [no] rssi-state
----[no] rssiprof
- (index)
- name
- [no] temp-alm-low
- [no] temp-alm-high
- [no] temp-warn-low
- [no] temp-warn-high
- [no] voltage-alm-low
- [no] voltage-alm-high
- [no] voltage-warn-low
- [no] voltage-warn-high
- [no] bias-alm-low
- [no] bias-alm-high
- [no] bias-warn-low
- [no] bias-warn-high
- [no] tx-pwr-alm-low
- [no] tx-pwr-alm-high
- [no] tx-pwr-warn-low
- [no] tx-pwr-warn-high
- [no] rx-pwr-alm-low
- [no] rx-pwr-alm-high
- [no] rx-pwr-warn-low
- [no] rx-pwr-warn-high
- [no] ebias-alm-low
- [no] ebias-alm-high
- [no] ebias-warn-low
- [no] ebias-warn-high
- [no] etx-alm-low
- [no] etx-alm-high
- [no] etx-warn-low
- [no] etx-warn-high
- [no] erx-alm-low
- [no] erx-alm-high
- [no] erx-warn-low
- [no] erx-warn-high
- [no] profile-type
----sfpe1t1
----[no] clock
- (position)
- [no] clocksource
----tdmintf
- (position)
- [no] window-number
- [no] window-length
----[no] pwtdm
- (position)
- channel
- packet-length
- jitter-buff-size
- vlanid
- priority
- conseq-number
- ecid-rx
- ecid-tx
- source-mac
- dest-mac
----framer
- (position)
- [no] frame-mode
- [no] iwf-on-liu
- [no] liu-on-liu
- [no] pm-to-iwf
- [no] ais-to-iwf
- [no] rai-to-iwf
- [no] rei-to-iwf
- [no] pm-to-liu
- [no] ais-to-liu
- [no] rai-to-liu
- [no] rei-to-liu
----liu
- (position)
- [no] distance
- [no] cable-impedance
----isam
- [no] description
----envbox
- [no] enable-supervise
----fan-tray
- fanmode
Command Description
This command allows the operator to configure the rack. The operator can configure the following parameter:
• description: text that describes the location of the rack.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 5.2-1 "Rack Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the physcial position of the rack
<Eqpt::RackId>
Field type <Eqpt::RackId>
- the rack number
Table 5.2-2 "Rack Configuration Command" Command Parameters
Parameter Type Description
[no] description Parameter type: <Description-127> optional parameter with default
Format: value: ""
- description to help the operator to identify the object any description to be used by the
- length: x<=127 operator
Command Description
This command allows the operator to configure the shelf. The operator can configure the following parameters:
• class: the classification of the shelf. The following shelf classes are supported:
- main-ethernet: supports Ethernet-based traffic. Shelves in this class can contain NT and LT units. There
must be at least one shelf of this class in the system.
- ext-ethernet: supports Ethernet-based traffic. Shelves in this class can only contain LT units.
• planned-type: the type planned for this shelf. The not-planned parameter indicates that a shelf will not be
inserted at this position.
• lock: locks or unlocks the shelf.
• shelf-mode: the shelf mode,applicable to NEP only, and when the shelf mode was changed successfully,the NE
will reboot automatically.
• description: text that describes the location of the shelf.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
> configure equipment shelf (index) [ no class | class <Equipm::ShelfClass> ] [ no planned-type | planned-type
<Equipm::ShelfType> ] [ [ no ] lock ] [ [ no ] extended-lt-slots ] [ no mode | mode <Equipm::HolderMode> ] [ no
description | description <Description-127> ]
Command Parameters
Table 5.3-1 "Shelf Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the physical identification of the
<Eqpt::RackId> / <Eqpt::ShelfId> shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Table 5.3-2 "Shelf Configuration Command" Command Parameters
Parameter Type Description
[no] class Parameter type: <Equipm::ShelfClass> optional parameter with default
Format: value: "main-ethernet"
( main-ethernet the class to which the shelf
| ext-ethernet ) belongs
Possible values:
- main-ethernet : main shelf - supports ethernet-based traffic
Command Description
This command allows the operator to configure a slot.
The slot is identified by the physical slot number. The left-most slot in the shelf is number 1. The following
parameters can be configured for the slot:
• planned-type: the unit type that will be inserted into the slot. The not-planned parameter indicates that a unit
will not be inserted into that slot.
• power-down: the operator can power-up or power-down slots. This is only applicable to LSM.
• unlock: the operator can lock or unlock a unit. A unit in the locked state cannot be used. This attribute is only
supported for the NT (the system will refuse to lock the NT of a simplex system), EXT, and a managed LSM.
This attribute is not applicable to sealed remote products (7367 SX).
• alarm-profile: the operator can assign a customizable alarm profile to a remote LT board. This is only
applicable for REM and SEM boards
• capab-profile:This parameter only applies to LSMs,NTIOs and mini-NT NRNT-A.For BCM based LSM boards
default capab-profile is "default" for Intel based LSM boards it is "8vc_default".
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 5.4-1 "Slot Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the physical number of the slot
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
Command Description
This command allows the operator to configure an applique.
The applique is identified by the physical slot number. The left-most slot in the shelf is number 1. The following
parameter can be configured for the slot:
• planned-type: the applique type to be inserted into the slot. The not-planned parameter indicates that an
applique will not be inserted into that slot.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 5.5-1 "Applique Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the physical number of the
( iont : <Eqpt::RackId> / <Eqpt::ShelfId> applique
| <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::AppliqueSlotId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
- iont : an nt applique slot
- lp : an lt applique slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::AppliqueSlotId>
- the applique slot number
Field type <Eqpt::LtAppliqueSlotId>
- the LT Applique slot number
Command Description
This command allows the operator to configure a protection group.
The protection group is identified by the eqptProtGroupId attribute (index). The value 1 is reserved for extension
chain protection group which is always present and cannot be deleted.
The protection group(s) are created implicitly by the system as part of the default configuration. Use "show
equipment protection-group" to display the valid protection group identifier(s). Note that the default admin-status
for protection-group 1 at system level is locked where it is always unlocked at cli level.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 5.6-1 "Protection Group Configuration Command" Resource Parameters
Resource Identifier Type Description
(prot-group-id) Format: Index in eqpt Prot Group Table
- index of protection group
- range: [1...109]
Table 5.6-2 "Protection Group Configuration Command" Command Parameters
Parameter Type Description
[no] admin-status Parameter type: <Equipm::PortGroupAdminStatus> optional parameter with default
Format: value: "unlock"
( unlock changes the administrative-status
| lock ) to lock or unlock
Possible values:
- unlock : unlock
- lock : lock
[no] eps-quenchfactor Parameter type: <Equipm::TimeTicks> optional parameter with default
Format: value: "1440000"
- timer value for quench mechanish timervalue of quenching
- unit: 1/100 sec mechanism(unit: 1/100sec), 0 is
valid value
Command Description
This command allows the operator to configure a protection element.
The protection group is identified by the eqptProtGroupId attribute. The value 1 to 9 are reserved for the extension
chain protection group which are always present and cannot be deleted. Group 1 corresponding with NT 1+1
group, and Group 2-9 corresponding with possible 8 LT 1+1 groups.
The redcy-ctrl-status parameter is used to force a switchover between elements of a protection group or to keep one
of the elements active. The forced-active parameter indicates that the NTA or NTB slot or LT slot is configured as
active.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 5.7-1 "Protection Element Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: Index in eqpt Prot Element Table
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Table 5.7-2 "Protection Element Configuration Command" Command Parameters
Command Description
This command allows the operator to configure the traffic direction of the configurable external-links on the host
expansion card. The configurable parameters are:
• direction: The traffic direction. Two directions are supported:
- network (default): the direction is configured to allow the trafic from the network
- remote-lt : the direction is configured to allow the trafic to the remote line termination card
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 5.8-1 "External-link-host Configuration Commands" Resource Parameters
Resource Identifier Type Description
(faceplate-number) Format: the faceplate number of the
( <Eqpt::ExtLinkConfigurableDeviceIndex> configurable external-link
| nt : sfp : <Eqpt::ExtLinkHostPortIndex>
| ntio-1 : sfp : <Eqpt::ExtLinkHostPortIndex>
| ntio-2 : sfp : <Eqpt::ExtLinkHostPortIndex> )
Possible values:
- nt : nt-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Possible values:
- sfp : SFP port
- xfp : XFP port
Field type <Eqpt::ExtLinkHostPortIndex>
- host port number
Field type <Eqpt::ExtLinkConfigurableDeviceIndex>
- the faceplate number of the configurable external link
Table 5.8-2 "External-link-host Configuration Commands" Command Parameters
Parameter Type Description
[no] direction Parameter type: <Equipm::ExternalLinkConfigType> optional parameter with default
Format: value: "network"
( network the external-link traffic direction
Command Description
This command allows the operator to configure the association between a host shelf SFP/XFP and a remote LT.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 5.9-1 "Host Shelf SFP Configuration Commands" Resource Parameters
Resource Identifier Type Description
(faceplate-number) Format: host shelf SFP/XFP number on
( <Eqpt::SfpFaceplateNumber> the faceplate
| nt : sfp : <Eqpt::ExtLinkHostToRemotePortIndex>
| ntio-1 : sfp : <Eqpt::ExtLinkHostToRemotePortIndex>
| ntio-2 : sfp : <Eqpt::ExtLinkHostToRemotePortIndex> )
Possible values:
- nt : nt-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Possible values:
- sfp : SFP port
Field type <Eqpt::ExtLinkHostToRemotePortIndex>
- a host port connected to remote LT
Field type <Eqpt::SfpFaceplateNumber>
- host SFP faceplate number
Table 5.9-2 "Host Shelf SFP Configuration Commands" Command Parameters
Parameter Type Description
[no] remote Parameter type: <Equipm::ExpansionSlotIndex> optional parameter with default
Format: value: "0/0/0"
<Eqpt::ExpRack> / <Eqpt::ExpShelf> / <Eqpt::ExpSlot> the expansion shelf LSM
Field type <Eqpt::ExpRack>
- the physical number of the expansion rack, 0 stands for no
remote
Field type <Eqpt::ExpShelf>
- physical nbr of expansion shelf within expansion rack, 0
stands for no remote
Command Description
This command allows the operator to configure RSSI profile on SFP/XFP:
• The slot index of the sfp
• The number of the sfp cage
• The index of rssi profile which would be configured on SFP/XFP.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 5.10-1 "SFP/XFP Diagnostics configuration Command" Resource Parameters
Resource Identifier Type Description
(position) Format: the physical sfp cage position
( acu : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SfpCageNumber>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> : sfp :
<Eqpt::SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> : xfp :
<Eqpt::SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> : qsfp :
<Eqpt::SfpCageNumber>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> /
<Eqpt::SfpCageNumber>
| nt : sfp : <Eqpt::SfpCageNumber>
| nt : xfp : <Eqpt::SfpCageNumber>
| nt : qsfp : <Eqpt::SfpCageNumber>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> : sfp
: <Eqpt::SfpCageNumber>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> :
xfp : <Eqpt::SfpCageNumber>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> :
qsfp : <Eqpt::SfpCageNumber>
| ntio-1 : sfp : <Eqpt::SfpCageNumber>
| ntio-1 : xfp : <Eqpt::SfpCageNumber>
Command Description
This command allows the operator to create and configure the RSSI parameters on SFPs.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
> configure equipment ( no rssiprof (index) ) | ( rssiprof (index) name <Eqpt::DisplayString> [ no temp-alm-low |
temp-alm-low <Eqpt::TcaTemp> ] [ no temp-alm-high | temp-alm-high <Eqpt::TcaTemp> ] [ no temp-warn-low |
temp-warn-low <Eqpt::TcaTemp> ] [ no temp-warn-high | temp-warn-high <Eqpt::TcaTemp> ] [ no
voltage-alm-low | voltage-alm-low <Eqpt::TcaVoltage> ] [ no voltage-alm-high | voltage-alm-high
<Eqpt::TcaVoltage> ] [ no voltage-warn-low | voltage-warn-low <Eqpt::TcaVoltage> ] [ no voltage-warn-high |
voltage-warn-high <Eqpt::TcaVoltage> ] [ no bias-alm-low | bias-alm-low <Eqpt::TcaBias> ] [ no bias-alm-high |
bias-alm-high <Eqpt::TcaBias> ] [ no bias-warn-low | bias-warn-low <Eqpt::TcaBias> ] [ no bias-warn-high |
bias-warn-high <Eqpt::TcaBias> ] [ no tx-pwr-alm-low | tx-pwr-alm-low <Eqpt::TcaTxPwr> ] [ no
tx-pwr-alm-high | tx-pwr-alm-high <Eqpt::TcaTxPwr> ] [ no tx-pwr-warn-low | tx-pwr-warn-low
<Eqpt::TcaTxPwr> ] [ no tx-pwr-warn-high | tx-pwr-warn-high <Eqpt::TcaTxPwr> ] [ no rx-pwr-alm-low |
rx-pwr-alm-low <Eqpt::TcaRxPwr> ] [ no rx-pwr-alm-high | rx-pwr-alm-high <Eqpt::TcaRxPwr> ] [ no
rx-pwr-warn-low | rx-pwr-warn-low <Eqpt::TcaRxPwr> ] [ no rx-pwr-warn-high | rx-pwr-warn-high
<Eqpt::TcaRxPwr> ] [ no ebias-alm-low | ebias-alm-low <Eqpt::TcaBias> ] [ no ebias-alm-high | ebias-alm-high
<Eqpt::TcaBias> ] [ no ebias-warn-low | ebias-warn-low <Eqpt::TcaBias> ] [ no ebias-warn-high | ebias-warn-high
<Eqpt::TcaBias> ] [ no etx-alm-low | etx-alm-low <Eqpt::TcaTxPwr> ] [ no etx-alm-high | etx-alm-high
<Eqpt::TcaTxPwr> ] [ no etx-warn-low | etx-warn-low <Eqpt::TcaTxPwr> ] [ no etx-warn-high | etx-warn-high
<Eqpt::TcaTxPwr> ] [ no erx-alm-low | erx-alm-low <Eqpt::TcaRxPwr> ] [ no erx-alm-high | erx-alm-high
<Eqpt::TcaRxPwr> ] [ no erx-warn-low | erx-warn-low <Eqpt::TcaRxPwr> ] [ no erx-warn-high | erx-warn-high
<Eqpt::TcaRxPwr> ] [ no profile-type | profile-type <Eqpt::RssiProfileType> ] )
Command Parameters
Table 5.11-1 "Sfp RSSI Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: an unique index of the rssi
- an unique index value for the rssi profile(1-200) profile(1-200)
- range: [1...200]
Table 5.11-2 "Sfp RSSI Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <Eqpt::DisplayString> mandatory parameter
Format: A unique profile name
- string to identify the rssi profile
- length: 1<=x<=16
Command Description
This command allows the operator to configure clock source on the 2xE1/DS1 sfp:
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
> configure equipment sfpe1t1 ( no clock (position) ) | ( clock (position) [ no clocksource | clocksource
<Eqpt::ClockSource> ] )
Command Parameters
Table 5.12-1 "2xE1/DS1 CLOCK configuration Command" Resource Parameters
Resource Identifier Type Description
(position) Format: the physical sfp cage position
( acu : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::E1dsx1SfpCageNumber>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::E1dsx1SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> :
<Eqpt::E1dsx1SfpCageNumber>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> /
<Eqpt::E1dsx1SfpCageNumber>
| nt : sfp : <Eqpt::E1dsx1SfpCageNumber>
| nt : xfp : <Eqpt::E1dsx1SfpCageNumber>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::E1dsx1SfpCageNumber>
| ntio-1 : sfp : <Eqpt::E1dsx1SfpCageNumber>
| ntio-1 : xfp : <Eqpt::E1dsx1SfpCageNumber>
| ntio-2 : sfp : <Eqpt::E1dsx1SfpCageNumber>
| ntio-2 : xfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-a : sfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-a : xfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-b : sfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-b : xfp : <Eqpt::E1dsx1SfpCageNumber> )
Possible values:
- acu : acu slot
- iont : an nt applique slot
- remote-sfp : remote sfp
- nt : active nt slot
- lt : lt-slot
Command Description
This command allows the operator to configure PWTDM interface parameters on the 2xE1/DS1 sfp:
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 5.13-1 "2xE1/DS1 Pseudo Wire TDM Interface configuration Command" Resource
Parameters
Resource Identifier Type Description
(position) Format: the physical sfp cage position
( acu : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::E1dsx1SfpCageNumber>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::E1dsx1SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> :
<Eqpt::E1dsx1SfpCageNumber>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> /
<Eqpt::E1dsx1SfpCageNumber>
| nt : sfp : <Eqpt::E1dsx1SfpCageNumber>
| nt : xfp : <Eqpt::E1dsx1SfpCageNumber>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::E1dsx1SfpCageNumber>
| ntio-1 : sfp : <Eqpt::E1dsx1SfpCageNumber>
| ntio-1 : xfp : <Eqpt::E1dsx1SfpCageNumber>
| ntio-2 : sfp : <Eqpt::E1dsx1SfpCageNumber>
| ntio-2 : xfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-a : sfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-a : xfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-b : sfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-b : xfp : <Eqpt::E1dsx1SfpCageNumber> )
Possible values:
- acu : acu slot
Command Description
This command allows the operator to configure pseudowire TDM parameters on the 2xE1/DS1 sfp:
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
> configure equipment sfpe1t1 ( no pwtdm (position) ) | ( pwtdm (position) channel <Eqpt::Channel> packet-length
<Eqpt::Packetlength> jitter-buff-size <Eqpt::JitBufSize> vlanid <Eqpt::VlanId> priority <Eqpt::Priority>
conseq-number <Eqpt::ConseqNo> ecid-rx <Eqpt::ECID> ecid-tx <Eqpt::ECID> source-mac
<Eqpt::PhysicalAddress> dest-mac <Eqpt::PhysicalAddress> )
Command Parameters
Table 5.14-1 "2xE1/DS1 Pseudo Wire TDM SFP configuration Command" Resource Parameters
Resource Identifier Type Description
(position) Format: the physical sfp cage position
( acu : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> :
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> /
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| nt : sfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| nt : xfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| ntio-1 : sfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| ntio-1 : xfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| ntio-2 : sfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| ntio-2 : xfp : <Eqpt::E1dsx1SfpCageNumber> :
Command Description
This command allows the operator to configure Framer parameters on the 2xE1/DS1 sfp:
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 5.15-1 "2xE1/DS1 Framer configuration Command" Resource Parameters
Resource Identifier Type Description
(position) Format: the physical sfp cage position
( acu : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> :
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> /
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| nt : sfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| nt : xfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| ntio-1 : sfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| ntio-1 : xfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| ntio-2 : sfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| ntio-2 : xfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
Command Description
This command allows the operator to configure distance and cable impedance on the 2xE1/DS1 sfp:
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
> configure equipment sfpe1t1 liu (position) [ no distance | distance <Eqpt::distance> ] [ no cable-impedance |
cable-impedance <Eqpt::CableImpedance> ]
Command Parameters
Table 5.16-1 "2xE1/DS1 Line Interface Unit SFP configuration Command" Resource Parameters
Resource Identifier Type Description
(position) Format: the physical sfp cage position
( acu : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> :
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> /
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| nt : sfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| nt : xfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| ntio-1 : sfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| ntio-1 : xfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| ntio-2 : sfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| ntio-2 : xfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| nt-a : sfp : <Eqpt::E1dsx1SfpCageNumber> :
Command Description
This command allows the operator to configure the NE. The operator can configure the following parameter:
• description: text that describes the location of the ISAM.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 5.17-2 "NE Configuration Command" Command Parameters
Parameter Type Description
[no] description Parameter type: <Description-127> optional parameter with default
Format: value: ""
- description to help the operator to identify the object any description to be used by the
- length: x<=127 operator
Command Description
This command allows the operator to configure environment monitoring status to enable/disable the data relay
from an external monitor box connected on the NTIO board of ISAM to the monitor server. The operator can
configure the following parameters:
• enable-supervise: enable relay of environment monitoring from an external monitor box.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 5.18-2 "Environment Monitoring Configuration Command" Command Parameters
Parameter Type Description
[no] enable-supervise Parameter type: boolean optional parameter
enable environment monitoring
relay
Command Description
This command allows the operator to configure the fan tray parameter fanmode.
The fanmode determines the applied speed of the fan trays. This is effective only if intelligent fan packs are
installed. Traditional fan packs (A-fans) do not support speed change, the 'classic' mode applies.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 5.19-2 "Configure Fan Tray parameters" Command Parameters
Parameter Type Description
fanmode Parameter type: <Eqpt::FanMode> optional parameter
Format: Fan Tray mode
( auto
| eco
| protect
| classic )
Possible values:
- auto : runs in average mode; fan speeds determined by
predefined thermal margins
- eco : runs in 'green' mode; minimal thermal margins
- protect : runs in protected mode; wider thermal settings wrt
auto
- classic : fixed fan speed; no SW control
Description
This chapter gives an overview of nodes that are handled by "Port Protection Configuration Commands".
Command Tree
----configure
----[no] port-protection
- (port)
- paired-port
Command Description
This command allows the operator to configure a protection group on two ports which will then operate in
redundancy. The system will decide which port of the two becomes active. In case of failure of one port the other
port will take over. A forced switchover can also be triggered manually by the operator.
The port protection group is identified by the first port in the group that is intended to be protected. The following
parameters can be configured for the protection group :
• paired-port: the paired port that will ensure the protection of the first one.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 6.2-1 "Port Protection Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: the port identifier of the first port
pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / in the protection group
<Eqpt::PonId>
Possible values:
- pon : pon-aid
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier
Table 6.2-2 "Port Protection Configuration Command" Command Parameters
Parameter Type Description
paired-port Parameter type: <RedPort::PairedPortIndex> mandatory parameter
Format: the port identifier of the paired
pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / port in the protection group
<Eqpt::PonId>
Possible values:
- pon : pon-aid
Description
This chapter gives an overview of nodes that are handled by "xDSL Configuration Commands".
Command Tree
----configure
----xdsl
----[no] service-profile
- (index)
- name
X (scope)
- version
- [no] ra-mode-down
- [no] ra-mode-up
- [no] min-bitrate-down
- [no] min-bitrate-up
- [no] sos-minbitrate-dn
- [no] sos-minbitrate-up
- [no] plan-bitrate-down
- [no] plan-bitrate-up
- [no] max-bitrate-down
- [no] max-bitrate-up
- [no] max-delay-down
- [no] max-delay-up
- [no] max-delay-var-dn
- [no] max-delay-var-up
- [no] memory-down
- [no] imp-noise-prot-dn
- [no] imp-noise-prot-up
- [no] inp-wo-erasure-dn
- [no] inp-wo-erasure-up
- [no] min-l2-br-down
- [no] active
----[no] spectrum-profile
- (index)
- name
X (scope)
- version
- [no] dis-ansi-t1413
- [no] dis-etsi-dts
- [no] dis-g992-1-a
- [no] dis-g992-1-b
- [no] dis-g992-2-a
- [no] dis-g992-3-a
- [no] dis-g992-3-b
- [no] g992-3-aj
- [no] g992-3-l1
- [no] g992-3-l2
- [no] g992-3-am
- [no] g992-5-a
- [no] g992-5-b
- [no] ansi-t1.424
- [no] dis-etsi-ts
- [no] itu-g993-1
- [no] ieee-802.3ah
- [no] g992-5-aj
- [no] g992-5-am
- [no] g993-2-8a
- [no] g993-2-8b
- [no] g993-2-8c
- [no] g993-2-8d
- [no] g993-2-12a
- [no] g993-2-12b
- [no] g993-2-17a
- [no] g993-2-30a
- [no] g993-2-35b
- [no] min-noise-down
- [no] min-noise-up
- [no] trgt-noise-down
- [no] trgt-noise-up
- [no] max-noise-down
- [no] max-noise-up
- [no] carrier-mask-down
- [no] carrier-mask-up
- [no] rf-band-list
- [no] power_mgnt_mode
- [no] l0-time
- [no] l2-time
- [no] l2-agpow-red-tx
- [no] modification
- [no] active
- [no] rau-noise-down
- [no] rau-noise-up
- [no] rau-time-down
- [no] rau-time-up
- [no] rad-noise-down
- [no] rad-noise-up
- [no] rad-time-down
- [no] rad-time-up
- [no] l2-agpw-to-red-tx
----artificial-noise-down
- (psd-point)
- [no] frequency
- [no] psd
----adsl-adsl2
X [no] proprietary-feat
- [no] propr-feat-value
- [no] max-agpowlev-down
- [no] max-agpowlev-up
- [no] max-psd-down
- [no] max-psd-up
- [no] pbo-mode-up
- [no] max-recv-power-up
- [no] psd-mask-up
----re-adsl
X [no] proprietary-feat
- [no] propr-feat-value
- [no] max-agpowlev-down
- [no] max-agpowlev-up
- [no] max-psd-down
- [no] max-psd-up
- [no] pbo-mode-up
- [no] max-recv-power-up
----adsl2-plus
X [no] proprietary-feat
- [no] propr-feat-value
- [no] max-agpowlev-down
- [no] max-agpowlev-up
- [no] max-psd-down
- [no] max-psd-up
- [no] psd-shape-down
- [no] pbo-mode-up
- [no] max-recv-power-up
- [no] psd-mask-up
----cust-psd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----vdsl
X [no] proprietary-feat
- [no] propr-feat-value
- [no] vdsl-band-plan
- [no] optional-band
- [no] optional-endfreq
- [no] adsl-band
- [no] max-agpowlev-down
- [no] max-agpowlev-up
- [no] psd-shape-down
- [no] psd-shape-up
X [no] pbo-mode-down
- [no] pbo-mode
- [no] rx-psd-shape-up
- [no] ghstones-pwr-mode
- [no] max-band
- [no] max-freq
- [no] m-psd-level-down
- [no] m-psd-level-up
- [no] psd-pbo-par-a-up
- [no] psd-pbo-par-b-up
- [no] cust-psd-sc-down
- [no] cust-psd-ty-down
- [no] cust-rx-psd-sc-up
- [no] cust-rx-psd-ty-up
- [no] opt-startfreq
----ghstone-set-pwr-ctrl
- [no] a43
- [no] b43
- [no] a43c
- [no] v43
----cust-psd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----cust-rx-psd-pt-up
- (psd-point)
- [no] frequency
- [no] psd
----pbo
- (band)
- param-a
- param-b
----vdsl2
X [no] proprietary-feat
- [no] propr-feat-value
- [no] max-agpowlev-down
- [no] max-agpowlev-up
- [no] psd-shape-down
- [no] cs-psd-shape-dn
- [no] cs-psd-shape-up
- [no] psd-shape-up
- [no] rx-psd-shape-up
- [no] psd-pbo-e-len-up
- [no] m-psd-level-down
- [no] m-psd-level-up
- [no] psd-pbo-par-a-up
- [no] psd-pbo-par-b-up
- [no] v-noise-snr-down
- [no] v-noise-snr-up
- [no] v-noise-psd-down
- [no] v-noise-psd-up
- [no] cust-psd-sc-down
- [no] cust-psd-ty-down
- [no] cust-psd-sc-up
- [no] cust-psd-ty-up
- [no] cust-rx-psd-sc-up
- [no] cust-rx-psd-ty-up
- [no] upbo-aele-mode
- [no] upboaele-min-thrs
----cust-psd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----cust-psd-pt-up
- (psd-point)
- [no] frequency
- [no] psd
----cust-rx-psd-pt-up
- (psd-point)
- [no] frequency
- [no] psd
----v-noise-psd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----v-noise-psd-pt-up
- (psd-point)
- [no] frequency
- [no] psd
----pbo
- (band)
- [no] equal-fext
- param-a
- param-b
----[no] dpbo-profile
- (index)
- name
- [no] es-elect-length
- [no] es-cable-model-a
- [no] es-cable-model-b
- [no] es-cable-model-c
- [no] min-usable-signal
- [no] min-frequency
- [no] max-frequency
- [no] rs-elect-length
- [no] muf-control
- [no] offset
- [no] active
- [no] modification
----micpsd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----epsd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----[no] rtx-profile
- (index)
- name
- version
- [no] rtx-mode-dn
- [no] rtx-mode-up
- [no] min-exp-thrpt-dn
- [no] min-exp-thrpt-up
- [no] plan-exp-thrpt-dn
- [no] plan-exp-thrpt-up
- [no] max-exp-thrpt-dn
- [no] max-exp-thrpt-up
- [no] max-net-rate-dn
- [no] max-net-rate-up
- [no] min-delay-dn
- [no] min-delay-up
- [no] max-delay-dn
- [no] max-delay-up
- [no] min-inp-shine-dn
- [no] min-inp-shine-up
- [no] min-inp-rein-dn
- [no] min-inp-rein-up
- [no] int-arr-time-dn
- [no] int-arr-time-up
- [no] shine-ratio-dn
- [no] shine-ratio-up
- [no] leftr-thresh-dn
- [no] leftr-thresh-up
- [no] active
- [no] modification
----[no] vect-profile
- (index)
- name
- version
- [no] fext-cancel-up
- [no] fext-cancel-dn
- [no] leg-can-dn-m1
- [no] leg-can-dn-m2
- [no] dis-gvect-cpe
- [no] gvecfriend-cpe
- [no] gvecfriend-dn-cpe
- [no] legacy-cpe
- [no] band-control-up
- [no] band-control-dn
- [no] vect-leav-thresh
- [no] vect-feat-bitmap
- [no] active
- [no] modification
----[no] sos-profile
- (index)
- name
- version
- [no] sos-time-down
- [no] sos-time-up
- [no] sos-ntones-down
- [no] sos-ntones-up
- [no] sos-crc-down
- [no] sos-crc-up
- [no] max-sos-down
- [no] max-sos-up
- [no] snrmoffset-roc-dn
- [no] snrmoffset-roc-up
- [no] min-inp-roc-down
- [no] min-inp-roc-up
- [no] roc-mode-down
- [no] roc-mode-up
- [no] active
- [no] modification
----[no] vce-profile
- (index)
- name
- version
- [no] vce-gain-mode
- [no] vce-join-timeout
- [no] vce-min-par-join
- [no] vce-hist-pcoder
- [no] vce-band-plan
- [no] vce-max-vect-freq
- [no] active
- [no] modification
----board
- (board-index)
- [no] dpbo-profile
- [no] vce-profile
- [no] vplt-autodiscover
- [no] vce-capacity-mode
----vect-fallback
- [no] fb-vplt-com-fail
- [no] fb-cpe-cap-mism
- [no] fb-conf-not-feas
- [no] spectrum-profile
- [no] service-profile
- [no] dpbo-profile
- [no] rtx-profile
- [no] sos-profile
----vp-board
- (board-index)
- vp-link
- [no] lt-expect
----line
- (if-index)
- [no] service-profile
- [no] spectrum-profile
- [no] dpbo-profile
- [no] rtx-profile
- [no] vect-profile
- [no] sos-profile
- [no] ansi-t1413
- [no] etsi-dts
- [no] g992-1-a
- [no] g992-1-b
- [no] g992-2-a
- [no] g992-3-a
- [no] g992-3-b
- [no] g992-3-aj
- [no] g992-3-l1
- [no] g992-3-l2
- [no] g992-3-am
- [no] g992-5-a
- [no] g992-5-b
- [no] ansi-t1.424
- [no] etsi-ts
- [no] itu-g993-1
- [no] ieee-802.3ah
- [no] g992-5-aj
- [no] g992-5-am
- [no] g993-2-8a
- [no] g993-2-8b
- [no] g993-2-8c
- [no] g993-2-8d
- [no] g993-2-12a
- [no] g993-2-12b
- [no] g993-2-17a
- [no] g993-2-30a
- [no] g993-2-35b
- [no] carrier-data-mode
- [no] admin-up
X bonding-mode
- [no] transfer-mode
- [no] imp-noise-sensor
- [no] vect-qln-mode
- [no] auto-switch
----tca-line-threshold
- [no] enable
- [no] es-nearend
- [no] ses-nearend
- [no] uas-nearend
- [no] leftr-nearend
- [no] leftr-day-nearend
- [no] es-day-nearend
- [no] ses-day-nearend
- [no] uas-day-nearend
- [no] es-farend
- [no] ses-farend
- [no] uas-farend
- [no] es-day-farend
- [no] ses-day-farend
- [no] uas-day-farend
- [no] leftr-farend
- [no] leftr-day-farend
----[no] overrule-data
- (if-index)
- [no] max-bitrate-down
- [no] max-bitrate-up
- [no] max-delay-down
- [no] max-delay-up
- [no] imp-noise-prot-dn
- [no] imp-noise-prot-up
- [no] trgt-noise-down
- [no] trgt-noise-up
- [no] max-psd-down
- [no] max-psd-up
- [no] carrier-mask-down
- [no] carrier-mask-up
- [no] noise-psd-mode-dn
- [no] noise-psd-mode-up
- [no] rtx-mode-dn
- [no] rtx-mode-up
- [no] max-net-rate-dn
- [no] max-net-rate-up
- [no] max-exp-thrpt-dn
- [no] max-exp-thrpt-up
- [no] min-inp-shine-dn
- [no] min-inp-shine-up
- [no] min-inp-rein-dn
- [no] min-inp-rein-up
- [no] min-delay-dn
- [no] min-delay-up
- [no] rtx-max-delay-dn
- [no] rtx-max-delay-up
- [no] shine-ratio-dn
- [no] shine-ratio-up
- [no] leftr-thresh-dn
- [no] leftr-thresh-up
- [no] memory-down
- [no] modification
- [no] active
----noise-psd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----noise-psd-pt-up
- (psd-point)
- [no] frequency
- [no] psd
----imp-noise-sensor
----near-end
- (if-index)
- [no] inm-mode
- [no] inm-eq-inp-mode
- [no] ins-sensitivity
- [no] inm-cluster-cont
- [no] inm-iat-offset
- [no] inm-iat-step
----far-end
- (if-index)
- [no] inm-mode
- [no] inm-eq-inp-mode
- [no] ins-sensitivity
- [no] inm-cluster-cont
- [no] inm-iat-offset
- [no] inm-iat-step
Command Description
This command allows the operator to manage the DSL service profile. The service profile groups all parameters on
DSL service level (data rates, Rate Adaption mode, delay, ...). The service parameters are common for all DSL
flavors.
DESCRIPTION FOR THE COMMAND PARAMETER-SCOPE:The combination scope+profile must be
unique.Typically local-profile must be used especially when configuring via CLI.Use of network-profile is
depreciated.The network-profile was foreseen to allow management agents to define network-wide unique
profiles,independent of what local profiles may have been created.
DESCRIPTION FOR THE COMMAND PARAMETER max-delay-down and max-delay-up:The delay is expressed
in milliseconds.Range: 1 to 63 ms in steps of 1 ms with 1 as special value.The value 1 is used to specify that fast or
pseudo fast latency (i.e. no interleaving).
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl ( no service-profile (index) ) | ( service-profile (index) name <AsamProfileName> [ (scope) ] [
version <SignedInteger> ] [ no ra-mode-down | ra-mode-down <Xdsl::RAModeDownType> ] [ no ra-mode-up |
ra-mode-up <Xdsl::RAModeUpType> ] [ no min-bitrate-down | min-bitrate-down <Xdsl::BitRate> ] [ no
min-bitrate-up | min-bitrate-up <Xdsl::BitRate> ] [ no sos-minbitrate-dn | sos-minbitrate-dn <Xdsl::BitRate> ] [ no
sos-minbitrate-up | sos-minbitrate-up <Xdsl::BitRate> ] [ no plan-bitrate-down | plan-bitrate-down <Xdsl::BitRate>
] [ no plan-bitrate-up | plan-bitrate-up <Xdsl::BitRate> ] [ no max-bitrate-down | max-bitrate-down
<Xdsl::BitRate> ] [ no max-bitrate-up | max-bitrate-up <Xdsl::BitRate> ] [ no max-delay-down | max-delay-down
<Xdsl::InterleavingDelay> ] [ no max-delay-up | max-delay-up <Xdsl::InterleavingDelay> ] [ no max-delay-var-dn
| max-delay-var-dn <Xdsl::VariationDelay> ] [ no max-delay-var-up | max-delay-var-up <Xdsl::VariationDelay> ]
[ no memory-down | memory-down <Xdsl::DownstreamMemory> ] [ no imp-noise-prot-dn | imp-noise-prot-dn
<Xdsl::ImpNoiseProtection> ] [ no imp-noise-prot-up | imp-noise-prot-up <Xdsl::ImpNoiseProtection> ] [ [ no ]
inp-wo-erasure-dn ] [ [ no ] inp-wo-erasure-up ] [ no min-l2-br-down | min-l2-br-down <Xdsl::BitRate> ] [ [ no ]
active ] )
Command Parameters
Table 7.2-1 "xDSL Common Service Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile
- a profile index value
- range: [1...1024]
Table 7.2-2 "xDSL Common Service Profile Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <AsamProfileName> mandatory parameter
Format: profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
(scope) Format: obsolete parameter that will be
local-profile ignored
Possible values: scope of the profile
- local-profile : the local profile
version Parameter type: <SignedInteger> optional parameter
Format: version maintained by manager,
- a signed integer usually 1 for new profile
[no] ra-mode-down Parameter type: <Xdsl::RAModeDownType> optional parameter with default
Format: value: "automatic"
( operator-ctrld rate adaptation mode for down
| automatic stream
| dynamic
| sos-dynamic )
Possible values:
- operator-ctrld : operator controlled rate adaptive mode in
downstream
- automatic : automatic rate adaptive mode at startup in
downstream
- dynamic : dynamic rate adaptive mode at startup and at
showtime in downstream
- sos-dynamic : dynamic rate adaptive mode with SOS in
downstream
[no] ra-mode-up Parameter type: <Xdsl::RAModeUpType> optional parameter with default
Format: value: "automatic"
( operator-ctrld rate adaptation mode for up
| automatic stream
| dynamic
| sos-dynamic )
Possible values:
- operator-ctrld : operator controlled rate adaptive mode in
upstream
- automatic : automatic rate adaptive mode at startup in
upstream
- dynamic : dynamic rate adaptive mode at startup and at
showtime in upstream
- sos-dynamic : dynamic rate adaptive mode with SOS in
upstream
[no] min-bitrate-down Parameter type: <Xdsl::BitRate> optional parameter with default
Format: value: 1024
- a bit rate value minimum downstream bit rate to
- unit: kbps be maintained
- range: [0...2147483647]
[no] min-bitrate-up Parameter type: <Xdsl::BitRate> optional parameter with default
Format: value: 64
- a bit rate value minimum upstream bit rate to be
- unit: kbps maintained
- range: [0...2147483647]
[no] sos-minbitrate-dn Parameter type: <Xdsl::BitRate> optional parameter with default
Format: value: 64
- a bit rate value minimum net data rate required
Command Description
This command allows the operator to manage the DSL spectrum profile. The spectrum profiles groups all
parameters on DSL on physical level. These parameters are mainly related to the environmental conditions of the
line (spectrum management).
The Spectrum Configuration profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL,VDSL2).
The specific values depending on the DSL flavor can be configured via:
• configure xdsl spectrum-profile adsl-adsl2
• configure xdsl spectrum-profile re-adsl
• configure xdsl spectrum-profile adsl2-plus
• configure xdsl spectrum-profile vdsl
• configure xdsl spectrum-profile vdsl2
The actual selected operating mode determines which set of DSL specific parameters is used. In case a common
parameter is not supported for a specific DSL flavor, this parameter will be ignored for that flavor.
When all the DSL specific flavors are configured the complete profile has to be activated.
DESCRIPTION FOR THE COMMAND PARAMETER-SCOPE:The combination scope+profilemust be
unique.Typically local-profile must be used especially when configuring via CLI.Use of network-profile is
depreciated.The network-profile was foreseen to allow management agents to define network-wide unique
profiles,independent of what local profiles may have been created.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl ( no spectrum-profile (index) ) | ( spectrum-profile (index) name <AsamProfileName> [ (scope) ] [
version <SignedInteger> ] [ [ no ] dis-ansi-t1413 ] [ [ no ] dis-etsi-dts ] [ [ no ] dis-g992-1-a ] [ [ no ] dis-g992-1-b ]
[ [ no ] dis-g992-2-a ] [ [ no ] dis-g992-3-a ] [ [ no ] dis-g992-3-b ] [ [ no ] g992-3-aj ] [ [ no ] g992-3-l1 ] [ [ no ]
g992-3-l2 ] [ [ no ] g992-3-am ] [ [ no ] g992-5-a ] [ [ no ] g992-5-b ] [ [ no ] ansi-t1.424 ] [ [ no ] dis-etsi-ts ] [ [ no
] itu-g993-1 ] [ [ no ] ieee-802.3ah ] [ [ no ] g992-5-aj ] [ [ no ] g992-5-am ] [ [ no ] g993-2-8a ] [ [ no ] g993-2-8b ]
[ [ no ] g993-2-8c ] [ [ no ] g993-2-8d ] [ [ no ] g993-2-12a ] [ [ no ] g993-2-12b ] [ [ no ] g993-2-17a ] [ [ no ]
g993-2-30a ] [ [ no ] g993-2-35b ] [ no min-noise-down | min-noise-down <Xdsl::NoiseMargin> ] [ no
min-noise-up | min-noise-up <Xdsl::NoiseMargin> ] [ no trgt-noise-down | trgt-noise-down <Xdsl::NoiseMargin> ]
[ no trgt-noise-up | trgt-noise-up <Xdsl::NoiseMargin> ] [ no max-noise-down | max-noise-down
<Xdsl::NoiseMarginPlus> ] [ no max-noise-up | max-noise-up <Xdsl::NoiseMarginPlus> ] [ no carrier-mask-down
| carrier-mask-down <Xdsl::CarrierMaskDown> ] [ no carrier-mask-up | carrier-mask-up <Xdsl::CarrierMaskUp> ]
[ no rf-band-list | rf-band-list <Xdsl::RFBandOrNotUsed> ] [ no power_mgnt_mode | power_mgnt_mode
<Xdsl::LinePowerMgtMode> ] [ no l0-time | l0-time <Xdsl::LineL0Time> ] [ no l2-time | l2-time
Command Parameters
Table 7.3-1 "xDSL Common Spectrum Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
Table 7.3-2 "xDSL Common Spectrum Profile Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <AsamProfileName> mandatory parameter
Format: profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
(scope) Format: obsolete parameter that will be
local-profile ignored
Possible values: scope of the profile
- local-profile : the local profile
version Parameter type: <SignedInteger> optional parameter
Format: version maintained by manager,
- a signed integer usually 1 for new profile
[no] dis-ansi-t1413 Parameter type: boolean optional parameter
disable ANSI T1.413-1998
[no] dis-etsi-dts Parameter type: boolean optional parameter
disable ETSI DTS/TM06006
[no] dis-g992-1-a Parameter type: boolean optional parameter
disable G.992.1 POTS
non-overlapped spectrum
[no] dis-g992-1-b Parameter type: boolean optional parameter
disable G.992.1 ISDN
non-overlapped spectrum
[no] dis-g992-2-a Parameter type: boolean optional parameter
disable G.992.2 POTS
non-overlapped spectrum
[no] dis-g992-3-a Parameter type: boolean optional parameter
disable G.992.3 POTS
non-overlapped spectrum
[no] dis-g992-3-b Parameter type: boolean optional parameter
disable G.992.3 ISDN
non-overlapped spectrum
[no] g992-3-aj Parameter type: boolean optional parameter
G.992.3 all digital mode
non-overlapped spectrum
[no] g992-3-l1 Parameter type: boolean optional parameter
G.992.3 POTS non-overlapped
spectrum US mask 1
[no] g992-3-l2 Parameter type: boolean optional parameter
Command Description
This command allows the operator to configure artificial noise in Downstream
This command allows to specify the transmitter-referred artificial noise level to be used as additional noise source
at the downstream transmitter.
Artificial Noise PSD points are defined in the range -140dBm/Hz..-40 dBm/Hz. These values must be manually
converted to the range 0..200 using the formula -2*(40 + PSD level).
A special value (-167,5 dBm/Hz) (entered value: 255) states no artificial noise has to be applied.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. When any other breakpoint is set to default values, all
points following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.4-1 "xDSL Artificial Noise Downstream Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd-point
- psd point
- range: [1...32]
Table 7.4-2 "xDSL Artificial Noise Downstream Configuration Command" Command Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
Command Description
This command allows the operator to manage the ADSL and ADSL2 specific part of the DSL spectrum profile. The
spectrum profiles groups all parameters on DSL on physical level. These parameters are mainly related to the
environmental conditions of the line (spectrum management).
The Spectrum Configuration Profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL).
This chapter contains the ADSL-ADSL2 flavor specific parameters.
Note: the activation of the profile has to be done via configure xdsl spectrum-profile.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.5-1 "xDSL Spectrum Profile for ADSL/ADSL2 Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
Table 7.5-2 "xDSL Spectrum Profile for ADSL/ADSL2 Configuration Command" Command
Parameters
Parameter Type Description
[no] proprietary-feat Parameter type: boolean obsolete parameter that will be
ignored
enable proprietary features of the
modem
Command Description
This command allows the operator to manage the Reach Extented ADSL2 specific part of the DSL spectrum profile.
The spectrum profiles groups all parameters on DSL on physical level. These parameters are mainly related to the
environmental conditions of the line (spectrum management).
The Spectrum Configuration profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL).
This chapter contains the Reach Extended DSL2 flavor specific parameters.
Note: the activation of the profile has to be done via configure xdsl spectrum-profile.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.6-1 "xDSL Spectrum Profile for RE-ADSL2 Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
Table 7.6-2 "xDSL Spectrum Profile for RE-ADSL2 Configuration Command" Command
Parameters
Parameter Type Description
[no] proprietary-feat Parameter type: boolean obsolete parameter that will be
ignored
enable proprietary features of the
modem
Command Description
This command allows the operator to manage the ADSL2-plus specific part of the DSL spectrum profile. The
spectrum profiles groups all parameters on DSL on physical level. These parameters are mainly related to the
environmental conditions of the line (spectrum management).
The Spectrum Configuration profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL).
This chapter contains the ADSL2-plus flavor specific parameters.
Note: the activation of the profile has to be done via configure xdsl spectrum-profile.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.7-1 "xDSL Spectrum Profile for ADSL2 Plus Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
Table 7.7-2 "xDSL Spectrum Profile for ADSL2 Plus Configuration Command" Command
Parameters
Parameter Type Description
[no] proprietary-feat Parameter type: boolean obsolete parameter that will be
ignored
enable proprietary features of the
Command Description
This command allows the operator to configure the ADSL2-plus custom psd shape in downstream direction.
It helps operator to enter the custom psd shape in a user-friendly way. Instead of entering octets the operator can
enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. When any other breakpoint is set to default values, all
points following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) adsl2-plus cust-psd-pt-down (psd-point) [ no frequency | frequency
<Xdsl::CustFrqAdsl2> ] [ no psd | psd <Xdsl::PsdLevel> ]
Command Parameters
Table 7.8-1 "ADSL2-plus Custom PSD shape Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd point
- range: [1...20]
Table 7.8-2 "ADSL2-plus Custom PSD shape Configuration Command" Command Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFrqAdsl2> optional parameter with default
Format: value: 0
- frequency psd frequency
- unit: khz
- range: [0...2208]
[no] psd Parameter type: <Xdsl::PsdLevel> optional parameter with default
Command Description
This command allows the operator to manage the VDSL specific part of the DSL spectrum profile. The spectrum
profiles groups all parameters on DSL on physical level. These parameters are mainly related to the environmental
conditions of the line (spectrum management).
The Spectrum Configuration profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL).
This chapter contains the VDSL flavor specific parameters.
Note: the activation of the profile has to be done via configure xdsl spectrum-profile. The configured
cust-psd-sc-down/cust-psd-ty-down, cust-rx-psd-sc-up/ cust-rx-psd-ty-up are ignored by the system after activation
of the profile if no corresponding breakpoints are configured before the activation.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.9-1 "xDSL Spectrum Profile for VDSL Configuration Command" Resource Parameters
Command Description
This command allows the operator to configure transmission power of the G.hs tones in VDSL environment.G.hs is
intended to be a robust mechanism for activating a multiplicity of xDSL. Activation of regional standards or legacy
devices can be handled by implicit (escape) or explicit (non-standard facilities) mechanisms.
The parameters defined are used for control of the transmission power.There are various tone sets defined for the
control of the transmission power, viz., A43,B43,A43C and V43.The power of each tone of the set shall be
equivalent to the given PSD value integrated in a total bandwidth of 4.3125 kHz
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl ghstone-set-pwr-ctrl [ no a43 | a43 <Xdsl::GhsTonesTxPwrCtrl> ] [
no b43 | b43 <Xdsl::GhsTonesTxPwrCtrl> ] [ no a43c | a43c <Xdsl::GhsTonesTxPwrCtrl> ] [ no v43 | v43
<Xdsl::GhsTonesTxPwrCtrl> ]
Command Parameters
Table 7.10-1 "VDSL Ghs Tones Transmission Power Control Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
Table 7.10-2 "VDSL Ghs Tones Transmission Power Control Configuration Command" Command
Parameters
Parameter Type Description
[no] a43 Parameter type: <Xdsl::GhsTonesTxPwrCtrl> optional parameter with default
Format: value: "standard"
( standard power control of the ghstones for
| auto tones set a43
| manual : <Xdsl::GhsTonesTxPwrLvl> )
Possible values:
- standard : the max power as per G994.1 standard definition
- auto : the max Tx power level is derived from
psd-shape-down
- manual : custom max Tx power level
Command Description
This command allows the operator to configure the VDSL custom psd shape in downstream direction.
It helps operator to enter the custom psd shape in a user-friendly way. Instead of entering octets the operator can
enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. Using this method, the frequency scale and the psd
shape type will also be reset to the default value. When any other breakpoint is set to default values, all points
following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl cust-psd-pt-down (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::PsdLevel> ]
Command Parameters
Table 7.11-1 "VDSL Custom PSD shape Downstream Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd point
- range: [1...32]
Table 7.11-2 "VDSL Custom PSD shape Downstream Configuration Command" Command
Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
Command Description
This command allows the operator to configure the VDSL custom rx-psd shape in upstream direction.
It helps operator to enter the custom psd shape in a user-friendly way. Instead of entering octets the operator can
enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. Using this method, the frequency scale and the psd
shape type will also be reset to the default value. When any other breakpoint is set to default values, all points
following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl cust-rx-psd-pt-up (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::PsdLevel> ]
Command Parameters
Table 7.12-1 "VDSL Custom RX PSD shape Upstream Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd point
- range: [1...20]
Table 7.12-2 "VDSL Custom RX PSD shape Upstream Configuration Command" Command
Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
Command Description
This command can be used to specify the power back off parameters for each upstream band.
Parameter A and B can be used for computing the PSD reference for US PBO for each band (including optional
band). The range of parameter A for each band is 40..80.95 dBm/Hz in steps of 0.01 dBm/Hz. And the range of
parameter B is 0..40.95 dBm/Hz in steps of 0.01 dBm/Hz.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl pbo (band) [ param-a <Xdsl::PboParamA> ] [ param-b
<Xdsl::PboParamB> ]
Command Parameters
Table 7.13-1 "VDSL Power Back Off Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(band) Format: band index
- equal fext band
- range: [1...5]
Table 7.13-2 "VDSL Power Back Off Configuration Command" Command Parameters
Parameter Type Description
param-a Parameter type: <Xdsl::PboParamA> optional parameter
Format: parameter A value
- pbo param A
- unit: 0.01 dBm/Hz
- range: [4000...8095]
param-b Parameter type: <Xdsl::PboParamB> optional parameter
Format: parameter B value
- pbo param B
- unit: 0.01 dBm/Hz
- range: [0...4095]
Command Description
This command allows the operator to manage the VDSL2 specific part of the DSL spectrum profile. The spectrum
profiles groups all parameters on DSL on physical level. These parameters are mainly related to the environmental
conditions of the line (spectrum management).
The Spectrum Configuration profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL,VDSL2).
This chapter contains the VDSL2 flavor specific parameters.
Note: the activation of the profile has to be done via configure xdsl spectrum-profile. The configured
cust-psd-sc-down/cust-psd-ty-down, cust-psd-sc-up/ cust-psd-ty-up, cust-rx-psd-sc-up/cust-rx-psd-ty-up are ignored
by the system after activation of the profile if no corresponding breakpoints are configured before the activation.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.14-1 "xDSL Spectrum Profile for VDSL2 Configuration Command" Resource Parameters
Command Description
This command allows the operator to configure the VDSL2 custom psd shape in downstream direction.
It helps operator to enter the custom psd shape in a user-friendly way. Instead of entering octets the operator can
enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. Using this method, the frequency scale and the psd
shape type will also be reset to the default value. When any other breakpoint is set to default values, all points
following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl2 cust-psd-pt-down (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::PsdLevel> ]
Command Parameters
Table 7.15-1 "VDSL2 Custom PSD shape Downstream Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd point
- range: [1...32]
Table 7.15-2 "VDSL2 Custom PSD shape Downstream Configuration Command" Command
Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
Command Description
This command allows the operator to configure the VDSL2 custom psd shape in downstream direction.
It helps operator to enter the custom psd shape in a user-friendly way. Instead of entering octets the operator can
enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. Using this method, the frequency scale and the psd
shape type will also be reset to the default value. When any other breakpoint is set to default values, all points
following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl2 cust-psd-pt-up (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::PsdLevel> ]
Command Parameters
Table 7.16-1 "VDSL2 Custom PSD shape Upstream Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd point
- range: [1...20]
Table 7.16-2 "VDSL2 Custom PSD shape Upstream Configuration Command" Command
Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
Command Description
This command allows the operator to configure the VDSL2 custom rx-psd shape in upstream direction.
It helps operator to enter the custom psd shape in a user-friendly way. Instead of entering octets the operator can
enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. Using this method, the frequency scale and the psd
shape type will also be reset to the default value. When any other breakpoint is set to default values, all points
following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl2 cust-rx-psd-pt-up (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::PsdLevel> ]
Command Parameters
Table 7.17-1 "VDSL2 Custom RX PSD shape Upstream Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd point
- range: [1...20]
Table 7.17-2 "VDSL2 Custom RX PSD shape Upstream Configuration Command" Command
Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
Command Description
This command allows the operator to configure VDSL2 virtual noise in downstream direction.
It helps operator to enter the virtual noise in a user-friendly way. Instead of entering octets, as was the case with
the earlier command, the operator can enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. When any other breakpoint is set to default values, all
points following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl2 v-noise-psd-pt-down (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::CustPsdVdsl2VtNoise> ]
Command Parameters
Table 7.18-1 "VDSL2 Virtual Noise Downstream Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd point
- range: [1...32]
Table 7.18-2 "VDSL2 Virtual Noise Downstream Configuration Command" Command Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
- unit: khz
- range: [0...35324]
[no] psd Parameter type: <Xdsl::CustPsdVdsl2VtNoise> optional parameter with default
Command Description
This command allows the operator to configure VDSL2 virtual noise in upstream direction.
It helps operator to enter the custom psd shape in a user-friendly way. Instead of entering octets, as was the case
with the earlier command, the operator can enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. When any other breakpoint is set to default values, all
points following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl2 v-noise-psd-pt-up (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::CustPsdVdsl2VtNoise> ]
Command Parameters
Table 7.19-1 "VDSL2 Virtual Noise Upstream Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd level
- range: [1...16]
Table 7.19-2 "VDSL2 Virtual Noise Upstream Configuration Command" Command Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
- unit: khz
- range: [0...35324]
[no] psd Parameter type: <Xdsl::CustPsdVdsl2VtNoise> optional parameter with default
Command Description
This command can be used to specify the power back off parameters for each upstream band.
The equal FEXT reference electrical length parameter value for each band (including optional band) can be used
for computing the PSD reference for US equal FEXT PBO. The range of this parameter for each band is 1.8 dB to
63 dB in steps of 0.1 dB. The special value 0 dB indicates that the modem has to use dedicated mechanism to
optimally apply the equal FEXT without providing any manual setting for this parameter. The special value 1.8 dB
disables equal FEXT UPBO in the respective upstream band.
Parameter A and B can be used for computing the PSD reference for US PBO for each band (including optional
band). The range of parameter A for each band is 40..80.95 dBm/Hz in steps of 0.01 dBm/Hz. And the range of
parameter B is 0..40.95 dBm/Hz in steps of 0.01 dBm/Hz.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl2 pbo (band) [ no equal-fext | equal-fext
<Xdsl::EqualFextUpstreamParam> ] [ param-a <Xdsl::PboParamA> ] [ param-b <Xdsl::PboParamB> ]
Command Parameters
Table 7.20-1 "VDSL2 Power Back Off Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(band) Format: band index
- equal fext band
- range: [1...5]
Table 7.20-2 "VDSL2 Power Back Off Configuration Command" Command Parameters
Parameter Type Description
[no] equal-fext Parameter type: <Xdsl::EqualFextUpstreamParam> optional parameter with default
Format: value: 0L
- pbo equal fext upstream equal fext upstream param
- unit: 0.1 dB
- range: [0,18...630]
param-a Parameter type: <Xdsl::PboParamA> optional parameter
Format: parameter A value
Command Description
Downstream power back off profile to configure the modem for a physical line.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl ( no dpbo-profile (index) ) | ( dpbo-profile (index) name <AsamProfileName> [ no es-elect-length
| es-elect-length <Xdsl::ElectricalLength> ] [ no es-cable-model-a | es-cable-model-a <Xdsl::CableModelA> ] [ no
es-cable-model-b | es-cable-model-b <Xdsl::CableModelB> ] [ no es-cable-model-c | es-cable-model-c
<Xdsl::CableModelC> ] [ no min-usable-signal | min-usable-signal <Xdsl::MinUsableSignalLevel> ] [ no
min-frequency | min-frequency <Xdsl::MinFrequency> ] [ no max-frequency | max-frequency
<Xdsl::MaxFrequency> ] [ no rs-elect-length | rs-elect-length <Xdsl::RemoteSideElectricalLength> ] [ no
muf-control | muf-control <Xdsl::MaxUsableFrequencyControl> ] [ no offset | offset <Xdsl::DpboOffset> ] [ [ no ]
active ] [ no modification | modification <Xdsl::ModifyStatus> ] )
Command Parameters
Table 7.21-1 "xDSL DPBO Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of profile
- a profile index value
- range: [1...50]
Table 7.21-2 "xDSL DPBO Profile Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <AsamProfileName> mandatory parameter
Format: name of profile
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
[no] es-elect-length Parameter type: <Xdsl::ElectricalLength> optional parameter with default
Format: value: 0L
- electrical length (1/10 * electrical-length) exchange side electrical length
- unit: 0.1 dB
- range: [0...2559]
[no] es-cable-model-a Parameter type: <Xdsl::CableModelA> optional parameter with default
Format: value: 0L
- cable model param (2^-8 * cable-model) cable model a
- unit: 2^-8
- range: [-256...384]
[no] es-cable-model-b Parameter type: <Xdsl::CableModelB> optional parameter with default
Command Description
This command specifies PSD breakpoints of DPBO Mode Independent Custom PSD Mask. A number of 2 to 32
PSD breakpoints can be specified. This parameter matches the PSDMASKds parameter described in ITU-T
G.997.1 This set of breakpoints may contain two subsets :
The first sub-set defines the DPBO Custom PSD Mask. It matches the DPBOPSDMASKds parameter described in
ITU-T G.997.1 The second sub-set (if any), defines the DPBO Minimum Override Mask. It matches the DPBOLFO
parameter described in ITU-T G.997.1 The successive PSD points of each sub-set must have increasing (>/=)
frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a same frequency
(brickwall).
The second sub-set starts at the first breakpoint whose frequency is lower than the frequency of the previous
breakpoint.
Only PSD values within the standard range from -95 to 0 dBm/Hz are guaranteed.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. When any other breakpoint is set to default values, all
points following it will also be set to the default values.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.22-1 "xDSL DPBO Mode Independent Custom PSD Mask Configuration Command"
Resource Parameters
Resource Identifier Type Description
(index) Format: index of profile
- a profile index value
- range: [1...50]
(psd-point) Format: psd point
- psd point
- range: [1...32]
Table 7.22-2 "xDSL DPBO Mode Independent Custom PSD Mask Configuration Command"
Command Parameters
Command Description
This command specifies the Assumed Exchange PSD mask to be protected by the DPBO shaping mechanism at the
remote flexibility point. This parameter matches the DPBOEPSD parameter described in ITU-T G.997.1 A number
of 2 to 16 PSD points can be specified. The successive PSD points must have increasing (>/=) frequencies. It is
allowed that for two successive PSD points, different PSD levels are defined at a same frequency (brickwall).
Only PSD values within the standard range from -95 to 0 dBm/Hz are guaranteed.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. When any other breakpoint is set to default values, all
points following it will also be set to the default values.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl dpbo-profile (index) epsd-pt-down (psd-point) [ no frequency | frequency <Xdsl::DpboFrequency>
] [ no psd | psd <Xdsl::DpboExchangePsd> ]
Command Parameters
Table 7.23-1 "xDSL DPBO Exchange PSD Mask Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of profile
- a profile index value
- range: [1...50]
(psd-point) Format: psd point
- psd point
- range: [1...16]
Table 7.23-2 "xDSL DPBO Exchange PSD Mask Configuration Command" Command Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::DpboFrequency> optional parameter with default
Format: value: 0L
- frequency psd frequency
- unit: khz
- range: [0...35324]
[no] psd Parameter type: <Xdsl::DpboExchangePsd> optional parameter with default
Format: value: 0L
- psd level (-10 * PSD-level) psd level
Command Description
This command allows the operator to configure the RTX profile which can be used to configure the modem for a
physical Line
RTX downstream/upstream parameters will have effect, only when the retransmission feature in
downstream/upstream is not "forbidden" on the line
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl ( no rtx-profile (index) ) | ( rtx-profile (index) name <AsamProfileName> [ version
<SignedInteger> ] [ no rtx-mode-dn | rtx-mode-dn <Xdsl::RtxMode> ] [ no rtx-mode-up | rtx-mode-up
<Xdsl::RtxMode> ] [ no min-exp-thrpt-dn | min-exp-thrpt-dn <Xdsl::BitRate> ] [ no min-exp-thrpt-up |
min-exp-thrpt-up <Xdsl::BitRate> ] [ no plan-exp-thrpt-dn | plan-exp-thrpt-dn <Xdsl::BitRate> ] [ no
plan-exp-thrpt-up | plan-exp-thrpt-up <Xdsl::BitRate> ] [ no max-exp-thrpt-dn | max-exp-thrpt-dn <Xdsl::BitRate>
] [ no max-exp-thrpt-up | max-exp-thrpt-up <Xdsl::BitRate> ] [ no max-net-rate-dn | max-net-rate-dn
<Xdsl::BitRate> ] [ no max-net-rate-up | max-net-rate-up <Xdsl::BitRate> ] [ no min-delay-dn | min-delay-dn
<Xdsl::RtxMinDelay> ] [ no min-delay-up | min-delay-up <Xdsl::RtxMinDelay> ] [ no max-delay-dn |
max-delay-dn <Xdsl::RtxMaxDelay> ] [ no max-delay-up | max-delay-up <Xdsl::RtxMaxDelay> ] [ no
min-inp-shine-dn | min-inp-shine-dn <Xdsl::ShineImpNoiseProtection> ] [ no min-inp-shine-up | min-inp-shine-up
<Xdsl::ShineImpNoiseProtection> ] [ no min-inp-rein-dn | min-inp-rein-dn <Xdsl::ReinImpNoiseProtection> ] [ no
min-inp-rein-up | min-inp-rein-up <Xdsl::ReinImpNoiseProtection> ] [ no int-arr-time-dn | int-arr-time-dn
<Xdsl::RtxInterArrivalTime> ] [ no int-arr-time-up | int-arr-time-up <Xdsl::RtxInterArrivalTime> ] [ no
shine-ratio-dn | shine-ratio-dn <Xdsl::RtxShineRatio> ] [ no shine-ratio-up | shine-ratio-up <Xdsl::RtxShineRatio>
] [ no leftr-thresh-dn | leftr-thresh-dn <Xdsl::RtxLeftrThreshold> ] [ no leftr-thresh-up | leftr-thresh-up
<Xdsl::RtxLeftrThreshold> ] [ [ no ] active ] [ no modification | modification <Xdsl::RtxModifyStatus> ] )
Command Parameters
Table 7.24-1 "xDSL RTX Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile
- a profile index value
- range: [1...128]
Table 7.24-2 "xDSL RTX Profile Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <AsamProfileName> mandatory parameter
Format: profile name
- a profile name
- range: [a-zA-Z0-9-_.]
Command Description
This command allows the operator to configure the vectoring profile which can be used for far end crosstalk
cancellation. The profile contains vectoring related parameters of the modem.
band-control-up/dn : are the values pairs of begin- and end-subcarriers. Maximum 8 bands can be specified. The
successive subcarriers must have increasing (>/=) values. Spectrum bands can be controlled per direction. When a
specified spectrum band overlaps both directions, the actual band control will be restricted to the configured
bandplan for the specified direction.
By default, the whole spectrum shall be used for crosstalk cancellation.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl ( no vect-profile (index) ) | ( vect-profile (index) name <AsamProfileName> [ version
<SignedInteger> ] [ no fext-cancel-up | fext-cancel-up <Xdsl::VectEnable> ] [ no fext-cancel-dn | fext-cancel-dn
<Xdsl::VectEnable> ] [ [ no ] leg-can-dn-m1 ] [ [ no ] leg-can-dn-m2 ] [ [ no ] dis-gvect-cpe ] [ [ no ]
gvecfriend-cpe ] [ [ no ] gvecfriend-dn-cpe ] [ [ no ] legacy-cpe ] [ no band-control-up | band-control-up
<Xdsl::VectBandControl> ] [ no band-control-dn | band-control-dn <Xdsl::VectBandControl> ] [ no
vect-leav-thresh | vect-leav-thresh <Xdsl::VectLeavThresh> ] [ no vect-feat-bitmap | vect-feat-bitmap
<Xdsl::VectFeatValue> ] [ [ no ] active ] [ no modification | modification <Xdsl::RtxModifyStatus> ] )
Command Parameters
Table 7.25-1 "xDSL Vectoring Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile
- a profile index value
- range: [1...25]
Table 7.25-2 "xDSL Vectoring Profile Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <AsamProfileName> mandatory parameter
Format: profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
version Parameter type: <SignedInteger> optional parameter
Format: version maintained by manager,
Command Description
This command allows the operator to configure the SOS profile, which can be used to configure the modem for a
physical line.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl ( no sos-profile (index) ) | ( sos-profile (index) name <AsamProfileName> [ version
<SignedInteger> ] [ no sos-time-down | sos-time-down <Xdsl::XdslSosTime> ] [ no sos-time-up | sos-time-up
<Xdsl::XdslSosTime> ] [ no sos-ntones-down | sos-ntones-down <Xdsl::SosTones> ] [ no sos-ntones-up |
sos-ntones-up <Xdsl::SosTones> ] [ no sos-crc-down | sos-crc-down <Xdsl::SosCRC> ] [ no sos-crc-up | sos-crc-up
<Xdsl::SosCRC> ] [ no max-sos-down | max-sos-down <Xdsl::MaxSOS> ] [ no max-sos-up | max-sos-up
<Xdsl::MaxSOS> ] [ no snrmoffset-roc-dn | snrmoffset-roc-dn <Xdsl::SosSnrmRoc> ] [ no snrmoffset-roc-up |
snrmoffset-roc-up <Xdsl::SosSnrmRoc> ] [ no min-inp-roc-down | min-inp-roc-down <Xdsl::SosMinInpRoc> ] [
no min-inp-roc-up | min-inp-roc-up <Xdsl::SosMinInpRoc> ] [ no roc-mode-down | roc-mode-down
<Xdsl::RocMode> ] [ no roc-mode-up | roc-mode-up <Xdsl::RocMode> ] [ [ no ] active ] [ no modification |
modification <Xdsl::ModifyStatus> ] )
Command Parameters
Table 7.26-1 "xDSL Sos Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile
- a profile index value
- range: [1...25]
Table 7.26-2 "xDSL Sos Profile Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <AsamProfileName> mandatory parameter
Format: profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
version Parameter type: <SignedInteger> optional parameter
Format: version maintained by manager,
- a signed integer usually 1 for new profile
[no] sos-time-down Parameter type: <Xdsl::XdslSosTime> optional parameter with default
Format: value: 0
- Time window after which SOS is triggered. Time window after which SOS is
- unit: 64ms triggered for the downstream
- range: [0...255] direction. Special value '0'
Command Description
This command allows the operator to configure the vectoring control entity profile. The profile contains vectoring
processing related parameters.
vce-min-par-join: Specifies the supported amount of lines for a group joining, with the intention to avoid impact on
active lines. The system should reserve room to guarantee that at least the specified number of lines can join in
parallel. At the moment multiple lines are joining, this is achieved by not canceling the same number of disturbers
which normally could be canceled in the system.
vce-band-plan: The bandplan needs to cover the widest bandplan up to the highest possible frequency that could be
configured via the spectrum profiles to the individual vectored lines. The goal is to force same upstream and
downstream band edges for all lines controlled by the vector control entity, except for differences in US0 frequency
limits (TypeA, TypeB, TypeM). When changing this parameter, all lines connected to this vectoring control entity
need to be re-initialized.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl ( no vce-profile (index) ) | ( vce-profile (index) name <AsamProfileName> [ version
<SignedInteger> ] [ no vce-gain-mode | vce-gain-mode <Xdsl::VectGainAchievedMode> ] [ no vce-join-timeout |
vce-join-timeout <Xdsl::VectJoinTime> ] [ no vce-min-par-join | vce-min-par-join <Xdsl::VectMinParallelJoins> ]
[ no vce-hist-pcoder | vce-hist-pcoder <Xdsl::VectHistPrePostCoder> ] [ no vce-band-plan | vce-band-plan
<Xdsl::VectBandPlan> ] [ no vce-max-vect-freq | vce-max-vect-freq <Xdsl::MaxVectFrequencyMode> ] [ [ no ]
active ] [ no modification | modification <Xdsl::RtxModifyStatus> ] )
Command Parameters
Table 7.27-1 "xDSL Vectoring Control Entity Profile Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: index of the profile
- a profile index value
- range: [1...25]
Table 7.27-2 "xDSL Vectoring Control Entity Profile Configuration Command" Command
Parameters
Parameter Type Description
name Parameter type: <AsamProfileName> mandatory parameter
Format: profile name
Command Description
This command allows the operator to configure xdsl parameters related with a specific board.
An already existing Downstream-Power-Back-Off(DPBO)-profile can be attached to a board.
All lines on this board will use this DPBO-profile unless a line-specific DPBO-profile is configured.
To deconfigure the DBPO-profile, it has to be put to 0.
An already existing Vectoring-Control-Entity(VCE)-profile can be attached to a Board-Level-Vectoring(BLV)-LT
or to a System-Level-Vectoring(SLV)-VP board. The VCE-profile is applicable for vectoring cancellation of all the
physical lines which can be vectored by the board. Note that a physical line can only be vectored if also a vectoring
profile has been assigned to the line and vectoring is enabled.
The auto detect functions of the LT-VP connection can be enabled or disabled on SLV LT boards and VP boards.
The vce-capacity-mode is specific for 7363 systems. It only applies to VP boards, not to LT boards.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.28-1 "xDSL Board Configuration Command" Resource Parameters
Resource Identifier Type Description
(board-index) Format: board index
( ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Table 7.28-2 "xDSL Board Configuration Command" Command Parameters
Parameter Type Description
[no] dpbo-profile Parameter type: <Xdsl::LineDpboProfile> optional parameter with default
Command Output
Table 7.28-3 "xDSL Board Configuration Command" Display parameters
Specific Information
name Type Description
dpbo-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the dpbo profile
- ignored printable string This element is only shown in
detail mode.
vce-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the vectoring control
- ignored printable string entity profile
This element is only shown in
Command Description
This command allows the operator to configure per board the profile selection in case the line enters the vectoring
fallback mode.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.29-1 "xDSL Board Vectoring Fallback Configuration Command" Resource Parameters
Resource Identifier Type Description
(board-index) Format: board index
( ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Table 7.29-2 "xDSL Board Vectoring Fallback Configuration Command" Command Parameters
Parameter Type Description
[no] fb-vplt-com-fail Parameter type: boolean optional parameter
allow fallback mode for vplt
communication failure
[no] fb-cpe-cap-mism Parameter type: boolean optional parameter
allow fallback mode for cpe
capability mismatch
[no] fb-conf-not-feas Parameter type: boolean optional parameter
allow fallback mode for
Command Output
Table 7.29-3 "xDSL Board Vectoring Fallback Configuration Command" Display parameters
Specific Information
name Type Description
spectrum-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the spectrum profile
- ignored printable string This element is only shown in
detail mode.
service-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the service profile
- ignored printable string This element is only shown in
detail mode.
dpbo-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the dpbo profile
- ignored printable string This element is only shown in
detail mode.
rtx-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the rtx profile
- ignored printable string This element is only shown in
detail mode.
sos-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the SOS profile
- ignored printable string This element is only shown in
detail mode.
Command Description
This command allows the operator to configure which LTs should be connected to the vp-board. The lines on these
LTs are expected to be vectored.
Configuring the links bewteen a vp-board and its LTs is only allowed as long as the VPLT auto dicovery feature is
disabled for the vp-board.
Configuring is not allowed for 7363 systems.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.30-1 "xDSL Vectoring Processing Board Configuration Command" Resource Parameters
Resource Identifier Type Description
(board-index) Format: vp board index
( ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
vp-link Parameter type: <Xdsl::VectVpLink> the link on the vp board
Format:
- specifies the vp-link or the soft-link on the vp-board
- range: [1...8]
Table 7.30-2 "xDSL Vectoring Processing Board Configuration Command" Command Parameters
Parameter Type Description
[no] lt-expect Parameter type: <Xdsl::LsmBoardOrZero> optional parameter with default
Format: value: "none"
Command Description
This command allows the operator to configure the xDSL line. One should associate a spectrum, a service, a
downstream power backoff and a retransmission profile to the line.
In case the operator wants to have VDSL2 crosstalk cancellation, a non-null xDSL Vectoring profile should be
associated to a VDSL2 line. Any vectoring profile assigned to a line running in ADSLx mode will be ignored. The
vectoring license counter is incremented when a xDSL Vectoring profile is assigned to an installed xdsl line,
independent of its running mode ADSLx or VDSLx.
Note: VDSL2 Vectoring Control Engine parameters should be configured via a vce-profile. The vce-profile is
applicable for VDSL2 vectoring cancellation of all the physical lines which can be vectored by the board to which
the vce-profile has been attached.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.31-1 "xDSL Line Configuration Command" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the line
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Command Output
Table 7.31-3 "xDSL Line Configuration Command" Display parameters
Specific Information
name Type Description
service-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the service profile
- ignored printable string This element is only shown in
detail mode.
spectrum-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the spectrum profile
- ignored printable string This element is only shown in
detail mode.
dpbo-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the dpbo profile
- ignored printable string This element is only shown in
detail mode.
rtx-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the rtx profile
- ignored printable string This element is only shown in
detail mode.
vect-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the vectoring profile
- ignored printable string This element is only shown in
Command Description
This command allows the operator to configure the Threshold Crossing Alert (TCA) thresholds. The configuration
is specific per xdsl line.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.32-1 "xDSL Line TCA Threshold Configuration Command" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the line
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 7.32-2 "xDSL Line TCA Threshold Configuration Command" Command Parameters
Parameter Type Description
[no] enable Parameter type: boolean optional parameter
Command Description
This command allows the operator to manage part of the DSL OverruleData. The OverruleData parameters give
the ability to the operator to overrule per-line parameters defined in service/spectrum / retransmission profiles.
RTX downstream/upstream parameters will be overruled when the retransmission feature in downstream/upstream
is different from "forbidden" value on the line. As long as the RTX downstream/upstream feature has not been
enabled, the other RTX downstream/upstream parameters will have no effect on the line.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.33-1 "xDSL Per Line Overrule Configuration Command" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 7.33-2 "xDSL Per Line Overrule Configuration Command" Command Parameters
Parameter Type Description
[no] max-bitrate-down Parameter type: <Xdsl::OverruleBitRate> optional parameter with default
Format: value: "no-overrule"
( no-overrule maximum bitrate down
| <Xdsl::OverruleBitRate> )
Possible values:
- no-overrule : no overrule
Field type <Xdsl::OverruleBitRate>
- bitrate
- unit: kbit/s
- range: [0...2147483647]
[no] max-bitrate-up Parameter type: <Xdsl::OverruleBitRate> optional parameter with default
Format: value: "no-overrule"
( no-overrule maximum bitrate up
| <Xdsl::OverruleBitRate> )
Possible values:
- no-overrule : no overrule
Field type <Xdsl::OverruleBitRate>
- bitrate
- unit: kbit/s
- range: [0...2147483647]
[no] max-delay-down Parameter type: <Xdsl::OverruleInterleavingDelay> optional parameter with default
Format: value: "no-overrule"
( no-overrule maximum interleaving delay
| <Xdsl::OverruleInterleavingDelay> ) down
Possible values:
- no-overrule : no overrule
Field type <Xdsl::OverruleInterleavingDelay>
- maximum interleaving delay
- unit: ms
- range: [1...63]
[no] max-delay-up Parameter type: <Xdsl::OverruleInterleavingDelay> optional parameter with default
Format: value: "no-overrule"
( no-overrule maximum interleaving delay up
| <Xdsl::OverruleInterleavingDelay> )
Possible values:
- no-overrule : no overrule
Field type <Xdsl::OverruleInterleavingDelay>
- maximum interleaving delay
- unit: ms
- range: [1...63]
[no] imp-noise-prot-dn Parameter type: <Xdsl::OverruleImpNoiseProtection> optional parameter with default
Command Description
This command allows the operator to configure the virtual/artificial noise in downstream direction.
It helps operator to enter the virtual/artificial noise psd shape in a user-friendly way. The operator can enter
numbers corresponding to frequency and psd level.
The downstream overrule noise PSD shape overrules the downstream virtual or artificial noise PSD shape
configured in the profile,according to the setting of noise-psd-mode-dn
• no-overrule:overrule noise PSD is ignored
• virtual:overrule noise PSD overrules the virtual noise PSD in the profile.
When all the (needed) parameters are configured, the complete Overrule Data has to be activated.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. Using this method, the psd shape mode will also be
reset to the default value. When any other breakpoint is set to default values, all points following it will also be set
to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.34-1 "xDSL Overrule Noise Psd Shape Downstream Configuration Command" Resource
Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Command Description
This command allows the operator to configure the virtual noise in upstream direction.
It helps operator to enter the virtual noise psd shape in a user-friendly way. The operator can enter numbers
corresponding to frequency and psd level.
When all the (needed) parameters are configured, the complete Overrule Data has to be activated.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. Using this method, the psd shape mode will also be
reset to the default value. When any other breakpoint is set to default values, all points following it will also be set
to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).
The upstream overrule noise PSD shape overrules the upstream virtual or artificial noise PSD shape configured in
the profile, according to the setting of noise-psd-mode-up:
• no-overrule:overrule noise PSD is ignored.
• virtual:overrule noise PSD overrules the virtual noise PSD in the profile.In case no overrule noise PSD is
specified (empty), v-noise-snr-up is set to mode-1,otherwise v-noise-snr-up is set to mode-2.
• virtual-rx:overrule noise PSD overrules the virtual noise PSD in the profile.In case no overrule noise PSD is
specified (empty), v-noise-snr-up is set to mode-1, otherwise v-noise-snr-up is set to mode-3.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl overrule-data (if-index) noise-psd-pt-up (psd-point) [ no frequency | frequency <Xdsl::CustFreq> ]
[ no psd | psd <Xdsl::CustPsd> ]
Command Parameters
Table 7.35-1 "xDSL Overrule Noise Psd Shape Upstream Configuration Command" Resource
Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
Command Description
This command allows the operator to configure the Impulse-Noise-Sensor parameters for the near-end side.
The InmMode must be enabled first to be able to start monitoring. To stop monitoring on the line this InmMode
must be disabled.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.36-1 "xDSL INS Near End Configuration Command" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 7.36-2 "xDSL INS Near End Configuration Command" Command Parameters
Parameter Type Description
[no] inm-mode Parameter type: <Xdsl::InmMode> optional parameter with default
Format: value: "disable"
( disable enable upstr impulse noise
| enable ) monitoring stats collection
Possible values:
- disable : disable impulse noise monitoring stats collection
- enable : enable impulse noise monitoring stats collection
[no] inm-eq-inp-mode Parameter type: <Xdsl::InmEquivInpMode> optional parameter with default
Format: value: "mode-0"
Command Description
This command allows the operator to configure the Impulse-Noise-Sensor parameters for the far-end side.
The InmMode must be enabled first to be able to start monitoring. To stop monitoring on the line this InmMode
must be disabled.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.37-1 "xDSL INS Far End Configuration Command" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 7.37-2 "xDSL INS Far End Configuration Command" Command Parameters
Parameter Type Description
[no] inm-mode Parameter type: <Xdsl::InmMode> optional parameter with default
Format: value: "disable"
( disable enable downstr impulse noise
| enable ) monitoring stats collection
Possible values:
- disable : disable impulse noise monitoring stats collection
- enable : enable impulse noise monitoring stats collection
[no] inm-eq-inp-mode Parameter type: <Xdsl::InmEquivInpMode> optional parameter with default
Format: value: "mode-0"
Description
This chapter gives an overview of nodes that are handled by "ATM Configuration Commands".
Command Tree
----configure
----atm
----[no] pvc
- (port-index)
- [no] admin-down
- [no] aal5-encap-type
----X [no] ip-cross-connect
- (interworking-port)
- cpe
- next-hop
Command Description
This command allows the operator to configure an ATM PVC.
The admin status allows or disallows traffic on the PVC.
The encapsulation type configures the way higher-layer traffic is encapsulated in the AAL5 container.
The LLC Encapsulation method allows the multiplexing of multiple protocols over a single ATM VC. The protocol
type of each PDU is identified by a prefixed IEEE 802.2 LLC header.
In the VC Multiplexing method, each ATM VC carries PDUs of exactly one protocol type. When multiple protocols
must be transported, there is a separate VC for each protocol type.
Use of the encapsulations:
• llc-snap and vc-mux-bridged-8023 can be used for cross-connects, ibridge, PPPoE, and IPoE
• llc-snap-routed and vc-mux-routed can be used for IPoA
• llc-nlpid and vc-mux-pppoa can be used for PPPoA
• none can be used for ATM pseudowire
It is also possible to automatically detect the used encapsulation type on the link.
• automatic:ip is used for auto-detection between llc-snap, vc-mux-bridged-8023, llc-snap-routed, and
vc-mux-routed; ipoe and ipoa dataframes are accepted;
• automatic:ppp is used for auto-detection between llc-snap, vc-mux-bridged-8023, llc-nlpid, and vc-mux-pppoa;
pppoa and pppoe dataframes are accepted;
• automatic:pppoa is used for auto-detection between llc-nlpid and vc-mux-pppoa, only pppoa dataframes are
accepted;
• automatic:ipoe-ppp is used for auto-detection between llc-snap, vc-mux-bridged-8023, llc-nlpid and
vc-mux-pppoa; ipoe, pppoa and pppoe dataframes are accepted;
User Level
The command can be accessed by operators with atm privileges, and executed by operators with atm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 8.2-1 "ATM PVC Configuration Command" Resource Parameters
Resource Identifier Type Description
(port-index) Format: the atm static Interface with vpi
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / and vci
Command Description
Obsolete command, replaced by configure ipoa/e-iw.
This command allows the operator to configure the parameter on the IPOA X-connect L2 interworking port level
User Level
The command can be accessed by operators with atm privileges, and executed by operators with atm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 8.3-1 "IPOA X-connect L2 interworking port Configuration Command" Resource
Parameters
Resource Identifier Type Description
(interworking-port) Format: index of rack/shelf/slot/port
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / user-bridgeport
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Table 8.3-2 "IPOA X-connect L2 interworking port Configuration Command" Command
Parameters
Description
This chapter gives an overview of nodes that are handled by "Interface Management Configuration Commands".
Command Tree
----configure
----interface
----port
- (port)
- [no] admin-up
X [no] link-state-trap
- [no] link-updown-trap
- [no] user
- [no] severity
----atm-pvc
- (pvc-index)
- [no] customer-id
----alarm
- (index)
- [no] default-severity
----shub
----[no] vlan-id
- (vlan-id)
- [no] mtu
- [no] admin-status
----ip
- (vlan-id)
- [no] vrf-id
----icmp
- [no] err-msg-suppress
- [no] ping-msg-suppress
----[no] ip-addr
- (ip-addr)
- [no] local-arp-proxy
----[no] unnumbered-as
- (borrowed-index)
----extfwd
- [no] device-ip
----port
- (network-port)
- [no] mode
- [no] port-type
- [no] admin-status
- [no] mc-flooding
----[no] group
- (group-id)
- [no] threshold
----[no] port
- (port)
----mirror
- [no] enable
- [no] to-port
----port
- (mirror-port)
----external
- [no] ingress
- [no] egress
----internal
- [no] ingress
- [no] egress
----mirror-voice-traffic
- [no] enable
- [no] loopback-port
----[no] ingress-port
- (port)
----[no] egress-port
- (port)
Command Description
This command allows the operator to configure interface management parameters.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 9.2-1 "Network Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: the interface index
( xdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| voicefxs : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| ethernet-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| ip-gateway : <Eqpt::VrfId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
Command Description
This command allows the operator to configure extended interface management parameters.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 9.3-1 "Extend Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(pvc-index) Format: the ATM PVC interface index
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Table 9.3-2 "Extend Interface Configuration Command" Command Parameters
Parameter Type Description
[no] customer-id Parameter type: <Itf::asamIfExtCustomerId> optional parameter with default
Format: value: "available"
- a string identifying the customer or user Config the customerId per PVC
- length: x<=64
Command Description
This command allows the operator to configure the default severity for an alarm on this type of interface.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 9.4-1 "Interface Alarm Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the IANA ifType
( xdsl-line
| ethernet-line
| shdsl-line
| voicefxs
| pon
| ont
| uni
| epon
| eont
| euni
| ellid
| lag )
Possible values:
- xdsl-line : xdsl line
- ethernet-line : ethernet line
- shdsl-line : shdsl line
- voicefxs : voicefxs
- pon : pon interface
- ont : ont interface
- uni : uni interface
- epon : epon interface
- eont : epon ont interface
- euni : epon uni interface
- ellid : epon llid interface
- lag : link aggregation group
Command Description
This command allows the operator to configure parameters related to SHub interface management.
The parameter mtu is applicable only for control-plane traffic only
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
> configure interface shub ( no vlan-id (vlan-id) ) | ( vlan-id (vlan-id) [ no mtu | mtu <Shub::ifMainMtu> ] [ no
admin-status | admin-status <Shub::AdminStatus> ] )
Command Parameters
Table 9.5-1 "SHub Management Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
Table 9.5-2 "SHub Management Interface Configuration Command" Command Parameters
Parameter Type Description
[no] mtu Parameter type: <Shub::ifMainMtu> optional parameter with default
Format: value: 1500
- This configuration is not applicable for L3 user-data MTU for the vlan interface
traffic.It is applicable only for control-plane traffic
- range: [90...2026]
[no] admin-status Parameter type: <Shub::AdminStatus> optional parameter with default
Format: value: "down"
( up administrative state of the vlan
| down interface
| auto-up )
Possible values:
- up : up
- down : down
- auto-up : autoup
Command Description
This command allows the operator to configure IP parameters related to SHub.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 9.6-1 "SHub IP Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
Table 9.6-2 "SHub IP Configuration Command" Command Parameters
Parameter Type Description
[no] vrf-id Parameter type: <Vrf::ShubVrfID> optional parameter with default
Format: value: 0
- the vrf id which uniquely identify a vrf the VRF instance to which this
- range: [0...127] interface is associated
Command Description
This command allows the operator to configure ICMP parameters related to SHub.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 9.7-1 "SHub ICMP Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
Table 9.7-2 "SHub ICMP Configuration Command" Command Parameters
Parameter Type Description
[no] err-msg-suppress Parameter type: boolean optional parameter
suppress the sending of ICMP err
msgs
[no] ping-msg-suppress Parameter type: boolean optional parameter
suppress ping packets
Command Description
This command allows the operator to configure multinet IP parameters related to SHub.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
> configure interface shub ip (vlan-id) ( no ip-addr (ip-addr) ) | ( ip-addr (ip-addr) [ [ no ] local-arp-proxy ] )
Command Parameters
Table 9.8-1 "SHub Multi-Network Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
(ip-addr) Format: ip-address
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Table 9.8-2 "SHub Multi-Network Configuration Command" Command Parameters
Parameter Type Description
[no] local-arp-proxy Parameter type: boolean optional parameter
enable local arp-proxy
Command Description
This command allows the operator to configure an unnumber interfaces related to SHub.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 9.9-1 "SHub Unnumbered Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
(borrowed-index) Format: vlan-id of the associated
- vlan id numbered interface
- range: [1...4093]
Command Description
This command allows the operator to configure the SHub external voice forwarding IP related parameter.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 9.10-1 "SHub External Voice forwarding Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
Table 9.10-2 "SHub External Voice forwarding Configuration Command" Command Parameters
Parameter Type Description
[no] device-ip Parameter type: <Ip::V4Address> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address external voice forwarding ip
Command Description
This command allows the operator to configure parameters related to port control configuration of an SHub
interface.
NOTE:
Due to IEEE 802.3 limitation, some special configuration rules for 1Gbps ports should be considered when doing
configuration:
For 1Gbps electrical port , auto-negotiation is mandatory for both sides.
For 1Gbps optical port, both sides should be auto-negotiation or both sides should be fixed.
Detail limitation please refer to IEEE 802.3-2002 section 40.5.1 and 28.2.3.1
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
> configure interface shub port (network-port) [ no mode | mode <Sys::PortCtrlMode> ] [ no port-type | port-type
<Sys::Type> ] [ no admin-status | admin-status <Shub::AdminStatus> ] [ [ no ] mc-flooding ]
Command Parameters
Table 9.11-1 "SHub Port Control Configuration Command" Resource Parameters
Resource Identifier Type Description
(network-port) Format: identifier of the port interface
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Table 9.11-2 "SHub Port Control Configuration Command" Command Parameters
Command Description
This command allows the user to configure parameters related to uplink group configuration of an interface.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
> configure interface shub ( no group (group-id) ) | ( group (group-id) [ no threshold | threshold <Itf::Threshold> ] )
Command Parameters
Table 9.12-1 "SHub Interface Uplink Group Configuration Command" Resource Parameters
Resource Identifier Type Description
(group-id) Format: A unique number for each logical
- the number of uplink group uplink group
- range: [1...7]
Table 9.12-2 "SHub Interface Uplink Group Configuration Command" Command Parameters
Parameter Type Description
[no] threshold Parameter type: <Itf::Threshold> optional parameter with default
Format: value: 0L
- the min nbr of links to be operational UP in grp the min nbr of links to be
- range: [0...7] operational UP in grp
Command Description
This command allows the user to configure parameters related to uplink group portlist configuration of an
interface.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
> configure interface shub group (group-id) ( no port (port) ) | ( port (port) )
Command Parameters
Table 9.13-1 "SHub Interface Uplink Group Portlist Configuration Command" Resource
Parameters
Resource Identifier Type Description
(group-id) Format: A unique number for each logical
- the number of uplink group uplink group
- range: [1...7]
(port) Format: the port
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Command Description
This command is used to control the system for the port mirroring feature.
The mirror-to-port should not be effectively connected to a network, subtending system or user, it is typically
connected to an analysing device.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 9.14-2 "SHub System Port Mirroring Configuration Command" Command Parameters
Parameter Type Description
[no] enable Parameter type: boolean optional parameter
enable port mirroring status
[no] to-port Parameter type: <Sys::NetworkPort> optional parameter with default
Format: value: "none"
( <Shub::NetworkPort> port in which mirror traffic in the
| none system can be copied
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- none : no to-port
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number
Command Description
This command is used for enabling/disabling of ingress and/or egress mirroring of traffic forwarded on the
interface to the mirrored-to port, without service interruption for the normal traffic. External egress mirrored
traffic includes only traffic originated from other ports, sent on the interface. It does not include traffic originated
from CPU; to mirror traffic from CPU, use the command Shub Internal-Traffic-Mirroring-Configuration.
External ingress mirrored traffic includes all traffic, received on the interface.
This configuration is effective in case port mirroring is enabled and the mirrored-to-port is set.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
> configure interface shub mirror port (mirror-port) external [ [ no ] ingress ] [ [ no ] egress ]
Command Parameters
Table 9.15-1 "SHub External-Traffic-Mirroring Configuration Command" Resource Parameters
Resource Identifier Type Description
(mirror-port) Format: identifier of the mirror port
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId> interface
| network : <Shub::NetworkPort>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
Command Description
This command is used for enabling/disabling of ingress and/or egress mirroring of traffic to/from the CPU on the
interface to the mirror-to-port,without service interruption for the normal traffic.
This configuration is effective in case port mirroring is enabled and the mirrored-to-port is set.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
> configure interface shub mirror port (mirror-port) internal [ [ no ] ingress ] [ [ no ] egress ]
Command Parameters
Table 9.16-1 "SHub Internal-Traffic-Mirroring Configuration Command" Resource Parameters
Resource Identifier Type Description
(mirror-port) Format: identifier of the mirror port
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId> interface
| network : <Shub::NetworkPort>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Command Description
This command is used to configure the system for the voice traffic mirroring feature.
When voice traffic mirroring feature is enabled, the loopback port will be autonomously associated to the s-vlan
and the s-vlan id will be assigned as pvid.
A port configured as loopback port will become unused and will lose all existing configurations. To re-use the port
again for normal purposes, the loopback port should be set to zero.
Ingress port list stored the set of port(s) that need to be mirrored for traffic transmitted on it in the upsteam
direction. Only ASAM ports can be members of ingress port list.
Egress port list stored the set of port(s) that need to be mirrored for traffic transmitted on it in the downsteam
direction. Only ASAM ports can be members of the egress port list.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 9.17-2 "SHub System Voice Traffic Mirroring Configuration Command" Command
Parameters
Parameter Type Description
[no] enable Parameter type: boolean optional parameter
enable the voice traffic mirroring
[no] loopback-port Parameter type: <Sys::MirrorLoopbackPort> optional parameter with default
Format: value: "none"
( <Shub::NetworkPort> configure the loopback port
| none
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- none : no loopback port
- nt : active nt slot
Possible values:
Command Description
This command is used to configure the egress port list.
Ingress port list stored the set of port(s) that need to be mirrored for traffic transmitted on it in the upsteam
direction. Only ASAM ports can be members of ingress port list.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 9.18-1 "Ingress Port List Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: port list for ingress port(s)
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId> )
Possible values:
- lt : line board
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Command Description
This command is used to configure the egress port list.
Egress port list stored the set of port(s) that need to be mirrored for traffic transmitted on it in the downsteam
direction. Only ASAM ports can be members of the egress port list.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 9.19-1 "Egress Port List Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: port list for egress port(s)
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId> )
Possible values:
- lt : line board
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Description
This chapter gives an overview of nodes that are handled by "Error Configuration Commands".
Command Tree
----configure
----error
- [no] log-full-action
Command Description
This command allows the operator to configure parameters related to the error log.
User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 10.2-2 "Error Log Configuration Command" Command Parameters
Parameter Type Description
[no] log-full-action Parameter type: <Error::errorLogFullAction> optional parameter with default
Format: value: "wrap"
( wrap set the action when error log
| halt ) buffer is full
Possible values:
- wrap : older log records are overwritten by recent ones
- halt : logging is stopped until the log buffer is reset
Description
This chapter gives an overview of nodes that are handled by "System Configuration Commands".
Command Tree
----configure
----system
- [no] id
- name
- location
- [no] access-oper-id
- contact-person
- [no] en-snmp-auth-trap
- mgnt-vlan-id
- [no] periph-mgnt-vlan
- system-mac
- [no] port-num-in-proto
- [no] user2user-hairpin
- [no] ntr-ssmout-vlan
- [no] voiceoswp
----management
- host-ip-address
----[no] vlan
- (vlan)
- host-ip-address
----[no] default-route
- (default-route)
----sntp
- server-ip-addr
- [no] server-port
- [no] polling-rate
- [no] enable
- [no] timezone-offset
----server-table
----[no] ip-address
- (ip-addr)
- [no] port
- priority
----loop-id-syntax
- [no] atm-based-dsl
- [no] efm-based-dsl
- [no] efm-based-pon
- [no] efm-based-epon
- [no] efm-based-ngpon2
----shub
----filter
----ip-filter
----[no] icmp
- (index-num)
- [no] action-drop
- [no] dst-ip-addr
- [no] src-ip-addr
- [no] msg-type
- [no] msg-code
- [no] direction
- [no] vlan-id
----[no] in-port
- (port)
----[no] out-port
- (port)
----[no] tcp
- (index-num)
- [no] action-drop
- [no] dst-ip-addr
- [no] src-ip-addr
- [no] min-dst-port
- [no] max-dst-port
- [no] min-src-port
- [no] max-src-port
- [no] ack
- [no] rst
- [no] tos
- [no] direction
- [no] vlan-id
----[no] in-port
- (port)
----[no] out-port
- (port)
----[no] udp
- (index-num)
- [no] action-drop
- [no] dst-ip-addr
- [no] src-ip-addr
- [no] min-dst-port
- [no] max-dst-port
- [no] min-src-port
- [no] max-src-port
- [no] direction
- [no] vlan-id
----[no] in-port
- (port)
----[no] out-port
- (port)
----X [no] port-filter
- (filter-rule)
- [no] protocol
- [no] action-drop
- [no] dst-ip-addr
- [no] src-ip-addr
- [no] direction
- [no] vlan-id
----X [no] in-port
- (port)
----X [no] out-port
- (port)
----[no] in-port
- (filter-rule)
- port
- [no] protocol
- [no] action-drop
- [no] dst-ip-addr
- [no] src-ip-addr
- [no] vlan-id
----[no] out-port
- (filter-rule)
- port
- [no] protocol
- [no] action-drop
- [no] dst-ip-addr
- [no] src-ip-addr
- [no] vlan-id
----entry
----id
- [no] contact
- [no] location
----vlan
- ext-vlan-id
----icmp
- [no] time-stamp-reply
----clock-mgmt
- [no] priority-scheme
- [no] ext-source
- [no] ais-sensitivity
----sync-if-timing
- [no] revert
- [no] wait-time
- [no] output-ql-thresh
- [no] ssmout-ceiling
----bits
- (interface-type)
----ref-order
- (index)
- (priority)
----ssm
- (index)
- [no] ssmenable
- [no] default-ql
- [no] target-ql
----synce
- (index)
- (port)
----force-reference
- (force-reference)
----ssmout-synce
- (index)
- [no] ssmout-enable
----[no] ssmout-ltport
- (index)
- [no] ssmout-enable
----max-lt-link-speed
- [no] link-speed
----auto-laser-shutdown
- [no] action
----auto-switch
- [no] xdsl-atm-ptm
- [no] xdsl-stepup-delay
Command Description
This command displays the ID that represents the SID (System ID) of the NE and is used to identify the NE in TL1
messages. The System ID may only include letters, digits, and hyphens, and must be unique for each NE in a
managed network. The name is an administratively assigned name for this managed node. By convention, this is the
node's fully qualified domain name. The accessOperatorID is an identifier randomly generated by Alcatel-Lucent
and assigned to an operator. The Customer Depenedent Engineering features are enabled based on the
accessOperatorID. The location is the physical location of this node. The textual identification of the contact
person for this managed node, together with information on how to contact this person, is given by contact-person.
The snmp-auth-traps indicates whether the SNMP agent process is permitted to generate authentication-failure
traps. The ether-shape-rate indicates the Ethernet frame shaping rate in kb/s.
The system-mac is used to configure the system MAC address in ISAM. The systemMacAddr is the MAC address of
the LANX interface on the NT board. The lanxBaseMacAddr is the first MAC address of the consecutive MAC
addresses used by the LANX. The lanxRangeMac is the number of MAC addresses supported in LANX.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.2-2 "System Configuration Command" Command Parameters
Parameter Type Description
[no] id Parameter type: <Sys::systemId> optional parameter with default
Format: value: """"
- system ID the system ID of the NE
- range: printable string (no white-spaces)
- length: x<=64
name Parameter type: <Transport::sysName> optional parameter
Format: fully-qualified domain name of
- a printable string the system
- length: x<=255
location Parameter type: <Transport::sysLocation> optional parameter
Format: location of this system
Command Description
This command allows the operator to configure the IP address to be used to manage the system.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.3-2 "System Management IP related Configuration Command" Command Parameters
Parameter Type Description
host-ip-address Parameter type: <Ip::ExternalAddress> optional parameter
Format: the host ip-address specification
( bootp
| manual : <Ip::V4Address> / <Ip::PrefixLengthHost> )
Possible values:
- bootp : use bootp to get ip-address
- manual : set ip-address manually
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthHost>
- IP address prefix length
- range: [8...30,32]
Command Description
This command allows the operator to configure the IP-address of the system.
User Level
none
Command Syntax
The command has the following syntax:
> configure system management ( no vlan (vlan) ) | ( vlan (vlan) host-ip-address <Sys::ExternalAddress> )
Command Parameters
Table 11.4-1 "System Management Vlan Host IP-Address Configuration Command" Resource
Parameters
Resource Identifier Type Description
(vlan) Format: the management vlan
- vlan id
- range: [6]
Table 11.4-2 "System Management Vlan Host IP-Address Configuration Command" Command
Parameters
Parameter Type Description
host-ip-address Parameter type: <Sys::ExternalAddress> mandatory parameter
Format: the host ip-address specification
( bootp
| manual : <Ip::V4Address> / <Ip::PrefixLengthHost> )
Possible values:
- bootp : use bootp to get ip-address
- manual : set ip-address manually
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthHost>
- IP address prefix length
- range: [8...30,32]
Command Description
This command allows the operator to configure the default route of the system. Before the default route can be
configured, the IP address of the system must be set.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.5-2 "System Management Default Route Configuration Command" Command Parameters
Parameter Type Description
(default-route) Format: mandatory parameter
- IPv4-address IP-address of the default-route
Command Description
This command allows the operator to configure the SNTP and its related parameters.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.6-2 "System SNTP Configuration Command" Command Parameters
Parameter Type Description
server-ip-addr Parameter type: <Ip::V4Address> optional parameter
Format: configure the ip address of the
- IPv4-address sntp server
[no] server-port Parameter type: <Sys::portNumber> optional parameter with default
Format: value: 123
- index number configure the port number of the
- range: [0...65535] sntp server
[no] polling-rate Parameter type: <Sys::pollingRate> optional parameter with default
Format: value: 3600
- polling rate in second configure polling rate for the sntp
- unit: seconds agent
- range: [60...864000]
[no] enable Parameter type: boolean optional parameter
sntp application in the NE is
enabled
[no] timezone-offset Parameter type: <Sys::timeZoneOffset> optional parameter with default
Format: value: 0
- specify the offset for timezone from GMT/UTC set the offset of the local
- unit: minutes timezone from GMT/UTC
- range: [-780...840]
Command Description
This command allows the operator to configure SNTP Server Table and its related parameters.
User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.
Command Syntax
The command has the following syntax:
> configure system sntp server-table ( no ip-address (ip-addr) ) | ( ip-address (ip-addr) [ no port | port
<Sys::ServerPortNumber> ] [ priority <Sys::priority> ] )
Command Parameters
Table 11.7-1 "System SNTP Server Table Configuration Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: configure the ip-address of the
- IPv4-address sntp server
Table 11.7-2 "System SNTP Server Table Configuration Command" Command Parameters
Parameter Type Description
[no] port Parameter type: <Sys::ServerPortNumber> optional parameter with default
Format: value: 123
- port number configure the port number of the
- range: [0...65535] sntp server
priority Parameter type: <Sys::priority> optional parameter
Format: configure the priority number of
- sntp server priority(1 - high) the sntp server
- range: [1...3]
Command Description
This command allows the operator to configure the system loop ID syntax. For atm-based-dsl, default value is
"Access_Node_ID atm Rack/Frame/Slot/Port:VPI.VCI". For efm-based-dsl, default value is "Access_Node_ID eth
Rack/Frame/Slot/Port". For efm-based-pon, default value is "Access_Node_ID eth
Rack/Frame/Slot/Port/ONU/OnuSlt/UNI".For efm-based-epon, default value is "Bras
Access_Node_ID/Rack/Frame/Slot/Subslot/Port/ONT Oft".
The system loop ID syntax is a concatenation of keywords, separators and free text strings.
The operator can use the following predefined keywords to construct the system loop ID :
• Bras to specify the Bras identifier.
• Access_Node_ID to specify the system id.
• Rack to specify the rack number.
• Frame to specify the shelf number.
• Slot to specify the slot number.
• Subslot to specify the slot number in ONT.
• ShSlt to specify the slot number without leading zero.
• Port to specify the port number.
• ShPrt to specify the port number without leading zero.
• VPI to specify the vpi.
• VCI to specify the vci.
• Q-VID to specify the vlan identifier.
• LzQVID to specify the vlan identifier with leading zero.
• DUVID to specify that user untagged vlan identifier is not added in string.
• U-VID to specify that user untagged vlan identifier is not added in string.When it is the last keyword and the
value is null, it removes all non-keywords before it.
• I-VID to specify the user side inner vlan identifier.
• ONT to specify the ONT id which connecting to OLT. Here using the ONUs MAC as id. it is represented with
12 ASCII characters.
• ONU to specify the number of the ONU without leading zero.
• LzOnu to specify the number of the ONU with leading zero.
• OnuSlt to specify the slot number on the ONU without leading zero.
• UNI to specify the number of UNI on the ONU without leading zero.
• N-VID to specify the network VLAN identifier.
• LzNVID to specify the network VLAN identifier with leading zeros (should not be used on GPON/EPON,
neither for ANCP).
• LzSVID to specify the network S-VLAN identifier in S+C VLAN forwarding model with leading zeros (should
not be used on GPON/EPON, neither for ANCP).
• Oft to specify the ONU format. It is a string.
• OnuSN to specify the ONU with the serial number.
• OnuLD to specify the ONU with logial authentication ID.
Note : the ONT and ONU related keywords are relevant only for the pon and epon syntax.
Note : according to Broadband Forum TR-156, the ONT always adds a VLAN tag before sending the traffic to the
OLT. In such case, the OLT not longer knows if traffic arrived at the ONT untagged or tagged. Therefore for
GPON, the keywords "DUVID" and "U-VID" will have the same behavior as "Q-VID".
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.8-2 "System Loop ID Syntax Configuration Command" Command Parameters
Parameter Type Description
[no] atm-based-dsl Parameter type: <PrintableString-0-80> optional parameter with default
Format: value: "Access_Node_ID atm
- a printable string Rack/Frame/Slot/Port : VPI.VCI"
- length: x<=80 define the syntax of loop Id for
atm based dsl lines
[no] efm-based-dsl Parameter type: <PrintableString-0-80> optional parameter with default
Format: value: "Access_Node_ID eth
- a printable string Rack/Frame/Slot/Port"
- length: x<=80 defines the syntax of loop Id for
efm based dsl lines
[no] efm-based-pon Parameter type: <PrintableString-0-80> optional parameter with default
Format: value: "Access_Node_ID eth
- a printable string Rack/Frame/Slot/Port/ONU/OnuSlt/UNI
- length: x<=80 defines the syntax of loop Id for
efm based pon lines
[no] efm-based-epon Parameter type: <PrintableString-0-80> optional parameter with default
Format: value: "Bras
- a printable string Access_Node_ID/Rack/Frame/Slot/Subsl
- length: x<=80 Oft"
defines the syntax of loop Id for
efm based epon lines,suggest
OntMAC for dpoe
[no] efm-based-ngpon2 Parameter type: <PrintableString-0-80> optional parameter with default
Format: value: "Access_Node_ID eth ng2
- a printable string :
- length: x<=80 Channelgroup/Subchannelgroup/ONU/O
defines the syntax of loop Id for
efm based epon lines,suggest
OntMAC for dpoe
Command Description
This command allows the operator to configure an ICMP filter on the SHub. The ICMP filter takes into account
source and/or destination IP addresses; either or both must be specified. Optionally the ICMP message type and/or
the ICMP message code can be specified.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.
action-drop : this configuration is not supported for outgoing traffic (direction out).
Clarification regarding 'entry-status': If a failure occurs during the configuration of the L3 ICMP filter, please
check if the filter was created and if the corresponding entry-status is valid. If not, please delete and re-create the
entire L3 ICMP filter.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter ( no icmp (index-num) ) | ( icmp (index-num) [ [ no ] action-drop ] [ no
dst-ip-addr | dst-ip-addr <Ip::AddressAndIpMaskFull> ] [ no src-ip-addr | src-ip-addr
<Ip::AddressAndIpMaskFull> ] [ no msg-type | msg-type <Sys::MsgType> ] [ no msg-code | msg-code
<Sys::MsgCode> ] [ no direction | direction <Sys::Direction> ] [ no vlan-id | vlan-id <Vlan::VlanFilterIndex> ] )
Command Parameters
Table 11.9-1 "SHub System ICMP Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
Table 11.9-2 "SHub System ICMP Filter Configuration Command" Command Parameters
Parameter Type Description
[no] action-drop Parameter type: boolean optional parameter
the packet will be discarded
[no] dst-ip-addr Parameter type: <Ip::AddressAndIpMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
Command Output
Table 11.9-3 "SHub System ICMP Filter Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Sys::WaitRowStatusICMP> the status of L3 ICMP filter
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
Possible values:
- valid : ICMP filter configuration is ok
- corrupted : ICMP filter configuration is not
operational(not-in-service)
- corrupted : ICMP filter configuration is not
operational(not-ready)
Command Description
This command allows the operator to configure the physical ports where the ICMP filter is to be applied. It is used
for ICMP filters related to incoming traffic.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter icmp (index-num) ( no in-port (port) ) | ( in-port (port) )
Command Parameters
Table 11.10-1 "SHub System ICMP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the network port
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Command Description
This command allows the operator to configure the physical ports where the ICMP filter is to be applied. It is used
for ICMP filters related to outgoing traffic.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter icmp (index-num) ( no out-port (port) ) | ( out-port (port) )
Command Parameters
Table 11.11-1 "SHub System ICMP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the port
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Command Description
This command allows the operator to configure a TCP filter on the SHub. The TCP filter takes into account source
and/or destination IP addresses; either or both must be specified.
When both source and destination protocol ports need to be configured, the latter must be performed through
separate commands.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.
action-drop : this configuration is not supported for outgoing traffic (direction out).
Clarification regarding 'entry-status': If a failure occurs during the configuration of the L3 TCP filter, please check
if the filter was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire
TCP filter.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter ( no tcp (index-num) ) | ( tcp (index-num) [ [ no ] action-drop ] [ no
dst-ip-addr | dst-ip-addr <Ip::NetworkAddressAndIpMaskFull> ] [ no src-ip-addr | src-ip-addr
<Ip::NetworkAddressAndIpMaskFull> ] [ no min-dst-port | min-dst-port <Sys::Port> ] [ no max-dst-port |
max-dst-port <Sys::Port> ] [ no min-src-port | min-src-port <Sys::Port> ] [ no max-src-port | max-src-port
<Sys::Port> ] [ no ack | ack <Sys::AckBit> ] [ no rst | rst <Sys::RstBit> ] [ no tos | tos <Sys::Tos> ] [ no direction |
direction <Sys::Direction> ] [ no vlan-id | vlan-id <Vlan::VlanFilterIndex> ] )
Command Parameters
Table 11.12-1 "SHub System TCP Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
Table 11.12-2 "SHub System TCP Filter Configuration Command" Command Parameters
Command Output
Table 11.12-3 "SHub System TCP Filter Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Sys::WaitRowStatusTCP> the status of L3 TCP filter
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
Possible values:
- valid : TCP filter configuration is ok
- corrupted : TCP filter configuration is not
operational(not-in-service)
- corrupted : TCP filter configuration is not
operational(not-ready)
Command Description
This command allows the operator to configure the physical ports where the TCP filter is to be applied. It is used
for TCP filters related to incoming traffic.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter tcp (index-num) ( no in-port (port) ) | ( in-port (port) )
Command Parameters
Table 11.13-1 "SHub System TCP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the network port
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Command Description
This command allows the operator to configure the physical ports where the TCP filter is to be applied. It is used
for TCP filters related to outgoing traffic.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter tcp (index-num) ( no out-port (port) ) | ( out-port (port) )
Command Parameters
Table 11.14-1 "SHub System TCP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the port
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Command Description
This command allows the operator to configure a UDP filter on the SHub. The UDP filter takes into account
source and/or destination IP addresses; either or both must be specified.
When both source and destination protocol ports need to be configured, the latter must be performed through
separate commands.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.
action-drop : this configuration is not supported for outgoing traffic (direction out).
Clarification regarding 'entry-status': If a failure occurs during the configuration of the L3 UDP filter, please
check if the filter was created and if the corresponding entry-status is valid. If not, please delete and re-create the
entire UDP filter.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter ( no udp (index-num) ) | ( udp (index-num) [ [ no ] action-drop ] [ no
dst-ip-addr | dst-ip-addr <Ip::NetworkAddressAndIpMaskFull> ] [ no src-ip-addr | src-ip-addr
<Ip::NetworkAddressAndIpMaskFull> ] [ no min-dst-port | min-dst-port <Sys::Port> ] [ no max-dst-port |
max-dst-port <Sys::Port> ] [ no min-src-port | min-src-port <Sys::Port> ] [ no max-src-port | max-src-port
<Sys::Port> ] [ no direction | direction <Sys::Direction> ] [ no vlan-id | vlan-id <Vlan::VlanFilterIndex> ] )
Command Parameters
Table 11.15-1 "SHub System UDP Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
Table 11.15-2 "SHub System UDP Filter Configuration Command" Command Parameters
Parameter Type Description
[no] action-drop Parameter type: boolean optional parameter
Command Output
Table 11.15-3 "SHub System UDP Filter Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Sys::WaitRowStatusUDP> the status of L3 UDP filter
Command Description
This command allows the operator to configure the physical ports where the UDP filter is to be applied. It is used
for UDP filters related to incoming traffic.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter udp (index-num) ( no in-port (port) ) | ( in-port (port) )
Command Parameters
Table 11.16-1 "SHub System UDP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the network port
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Command Description
This command allows the operator to configure the physical ports where the UDP filter is to be applied. It is used
for UDP filters related to outgoing traffic.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter udp (index-num) ( no out-port (port) ) | ( out-port (port) )
Command Parameters
Table 11.17-1 "SHub System UDP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the port
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Command Description
Obsolete command, replaced by two commands 1.configure system shub filter ip-filter in-port 2.configure
system shub filter ip-filter out-port.
This command allows the operator to configure an IP filter on the SHub, for protocols other than ICMP, TCP or
UDP. The IP filter takes into account source and/or destination IP addresses; either or both must be specified.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.
Clarification regarding 'entry-status': If a failure occurs during the configuration of the L3 IP filter, please check if
the filter was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire IP
filter.
Clarification regarding duplicate filters : If the same filter is configured for both in-port and out-port, then the
second filter overrides the first filter. Only one filter will be existing under this scenario,as the filter row gets
created on basis of the filter rule
If a filter rule is configured on a particular port , then operator is not allowed to configure another filter rule on
the same port.Though internally this filter entry will be corrupted.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter ( no port-filter (filter-rule) ) | ( port-filter (filter-rule) [ no protocol | protocol
<Sys::RestrictedProtocol> ] [ [ no ] action-drop ] [ no dst-ip-addr | dst-ip-addr
<Ip::NetworkAddressAndIpMaskFull> ] [ no src-ip-addr | src-ip-addr <Ip::NetworkAddressAndIpMaskFull> ] [ no
direction | direction <Sys::Direction> ] [ no vlan-id | vlan-id <Vlan::VlanFilterIndex> ] )
Obsolete command, replaced by two commands 1.configure system shub filter ip-filter in-port 2.configure
system shub filter ip-filter out-port.
Command Parameters
Table 11.18-1 "SHub System Other Protocol Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(filter-rule) Format: L3 filter rule number
Command Output
Table 11.18-3 "SHub System Other Protocol Filter Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Sys::WaitRowStatusPortList> the status of L3 IP filter
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
Possible values:
- valid : IP filter configuration is ok
- corrupted : IP filter configuration is not
operational(not-in-service)
- corrupted : IP filter configuration is not
operational(not-ready)
Command Description
Obsolete command, replaced by configure system shub filter ip-filter in-port.
This command allows the operator to configure the physical ports where the "other Protocol" filter is to be applied.
It is used for "other Protocol" filters related to incoming traffic.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter port-filter (filter-rule) ( no in-port (port) ) | ( in-port (port) )
Obsolete command, replaced by configure system shub filter ip-filter in-port.
Command Parameters
Table 11.19-1 "SHub System Other Protocol Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(filter-rule) Format: L3 filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the network port
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Command Description
Obsolete command, replaced by configure system shub filter ip-filter out-port.
This command allows the operator to configure the physical ports where the "other Protocol" filter is to be applied.
It is used for "other Protocol" filters related to outgoing traffic.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter port-filter (filter-rule) ( no out-port (port) ) | ( out-port (port) )
Obsolete command, replaced by configure system shub filter ip-filter out-port.
Command Parameters
Table 11.20-1 "SHub System Other Protocol Filter Out Port List Configuration Command"
Resource Parameters
Resource Identifier Type Description
(filter-rule) Format: L3 filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the port
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
Command Description
This command allows the operator to configure an IP filter on the SHub, for protocols other than ICMP, TCP or
UDP. The IP filter takes into account source and/or destination IP addresses; either or both must be specified.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.
action-drop : this configuration is not supported for outgoing traffic (direction out).
Clarification regarding 'entry-status': If a failure occurs during the configuration of the L3 IP filter, please check if
the filter was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire IP
filter.
Clarification regarding duplicate filters : If the same filter is configured for both in-port and out-port, then the
second filter overrides the first filter. Only one filter will be existing under this scenario,as the filter row gets
created on basis of the filter rule
If a filter rule is configured on a particular port , then operator is not allowed to configure another filter rule on
the same port.Though internally this filter entry will be corrupted.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter ( no in-port (filter-rule) port <Shub::InNetworkPort> ) | ( in-port (filter-rule)
port <Shub::InNetworkPort> [ no protocol | protocol <Sys::RestrictedProtocol> ] [ [ no ] action-drop ] [ no
dst-ip-addr | dst-ip-addr <Ip::NetworkAddressAndIpMaskFull> ] [ no src-ip-addr | src-ip-addr
<Ip::NetworkAddressAndIpMaskFull> ] [ no vlan-id | vlan-id <Vlan::VlanFilterIndex> ] )
Command Parameters
Table 11.21-1 "SHub System Other Protocol Filter Ip-filter In-port Configuration Command"
Resource Parameters
Resource Identifier Type Description
(filter-rule) Format: L3 filter rule number
- Filter rule number
- range: [1...65535]
port Parameter type: <Shub::InNetworkPort> the network port
Command Output
Table 11.21-3 "SHub System Other Protocol Filter Ip-filter In-port Configuration Command"
Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Sys::WaitRowStatusPortList> the status of L3 IP filter
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
Possible values:
- valid : IP filter configuration is ok
- corrupted : IP filter configuration is not
operational(not-in-service)
- corrupted : IP filter configuration is not
operational(not-ready)
Command Description
This command allows the operator to configure an IP filter on the SHub, for protocols other than ICMP, TCP or
UDP. The IP filter takes into account source and/or destination IP addresses; either or both must be specified.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.
action-drop : this configuration is not supported for outgoing traffic (direction out).
Clarification regarding 'entry-status': If a failure occurs during the configuration of the L3 IP filter, please check if
the filter was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire IP
filter.
Clarification regarding duplicate filters : If the same filter is configured for both in-port and out-port, then the
second filter overrides the first filter. Only one filter will be existing under this scenario,as the filter row gets
created on basis of the filter rule
If a filter rule is configured on a particular port , then operator is not allowed to configure another filter rule on
the same port.Though internally this filter entry will be corrupted.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter ( no out-port (filter-rule) port <Shub::OutPort> ) | ( out-port (filter-rule) port
<Shub::OutPort> [ no protocol | protocol <Sys::RestrictedProtocol> ] [ [ no ] action-drop ] [ no dst-ip-addr |
dst-ip-addr <Ip::NetworkAddressAndIpMaskFull> ] [ no src-ip-addr | src-ip-addr
<Ip::NetworkAddressAndIpMaskFull> ] [ no vlan-id | vlan-id <Vlan::VlanFilterIndex> ] )
Command Parameters
Table 11.22-1 "SHub System Other Protocol Filter Ip-filter Out-port Configuration Command"
Resource Parameters
Resource Identifier Type Description
(filter-rule) Format: L3 filter rule number
- Filter rule number
- range: [1...65535]
port Parameter type: <Shub::OutPort> the port
Command Output
Table 11.22-3 "SHub System Other Protocol Filter Ip-filter Out-port Configuration Command"
Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Sys::WaitRowStatusPortList> the status of L3 IP filter
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
Possible values:
- valid : IP filter configuration is ok
- corrupted : IP filter configuration is not
operational(not-in-service)
- corrupted : IP filter configuration is not
operational(not-ready)
Command Description
This command allows the operator to configure information regarding the location and contact person for the
node.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system shub entry id [ no contact | contact <Sys::IssSysContact> ] [ no location | location
<Sys::IssSysLocation> ]
Command Parameters
Table 11.23-2 "SHub System ID Configuration Command" Command Parameters
Parameter Type Description
[no] contact Parameter type: <Sys::IssSysContact> optional parameter with default
Format: value: """"
- textual identification of the contact person textual identification of the
- length: x<=50 contact person
[no] location Parameter type: <Sys::IssSysLocation> optional parameter with default
Format: value: """"
- physical location of this node physical location of this node
- length: x<=50
Command Description
This command allows the operator to configure the SHub system VLAN group.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.24-2 "SHub System VLAN Group Configuration Command" Command Parameters
Parameter Type Description
ext-vlan-id Parameter type: <Vlan::ExtVlanIndex> optional parameter
Format: External Vlan id
- external vlan id
- range: [2...4093]
Command Description
This command allows the operator to configure ICMP related parameters. Currently this command is used to
enable ICMP timestamp reply.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.25-2 "SHub System ICMP Configuration Command" Command Parameters
Parameter Type Description
[no] time-stamp-reply Parameter type: <Sys::TsReply> optional parameter with default
Format: value: "enable"
( enable allow sending icmp time stamp
| disable ) reply Message
Possible values:
- enable : allow sending ICMP time stamp reply message
- disable : disable ICMP time stamp reply message
Command Description
This command allows the operator to configure the clock source priority scheme.
This command allows the operator to configure the external clock source as E1 or DS1, or 2048Khz
ext-source parameter is ignored when priority-scheme is selected local for Non-BITS card.
The system takes default ds1 for ANSI markets and e1 for ETSI markets.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.26-2 "System Clock Configuration Command" Command Parameters
Parameter Type Description
[no] priority-scheme Parameter type: <Sys::SysClkSrcPriorityScheme> optional parameter with default
Format: value: "autoselect"
( autoselect select the clock priority cheme
| local
| external-local )
Possible values:
- autoselect : select based on location
- local : always select local clock
- external-local : external clock > local clock
[no] ext-source Parameter type: <Sys::SysClkExtSource> optional parameter with default
Format: value: "autoselect"
( e1 select the BITS mode for the
| ds1 external clock source: E1 or DS1
| khz2048 or 2048Khz
| autoselect )
Possible values:
- e1 : select E1 Source
- ds1 : select DS1 Source
- khz2048 : select 2048KHz Source
- autoselect : autoselect Source
[no] ais-sensitivity Parameter type: <Sys::SysClkAisSensitivity> optional parameter with default
Command Description
This command allows the operator to configure all the Clock Synchronization (NTR) characteristics of the ISAM
node.
The underlying commands and parameters are applicable for the NT's supporting Enhanced Clock Management.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.27-2 "System Synchronous Interface Timing Clock Configuration Command" Command
Parameters
Parameter Type Description
[no] revert Parameter type: boolean optional parameter
configure system clock to
revertive or non-revertive
[no] wait-time Parameter type: <Sys::SysClkWaitTime> optional parameter with default
Format: value: 10
- time to wait on the reference switchover configure time to wait on the
- unit: seconds reference switchover
- range: [0...720]
[no] output-ql-thresh Parameter type: <Ntr::SysClkSrcQL> optional parameter with default
Format: value: "clk-ql-dnu-dus"
( clk-ql-stu configure system threshold of
| clk-ql-prs BITS output QL
| clk-ql-prc
| clk-ql-inv3
| clk-ql-ssu-a-tnc
| clk-ql-ssu-a
| clk-ql-tnc
| clk-ql-inv5
| clk-ql-inv6
Command Description
This command allows the operator to configure the clock bits mode. This command allow the operator to configure
the BITS clock source based on the Network Timing Reference used as a BITS source. The operator can configure
the values: E1, Ds1, 2048Khz or autoselect. When "autoselect" is configured, the system takes the default values:
• ds1 for NTs with CLOCK capability=T1.
• e1 for NTs with CLOCK capability=E1.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.28-2 "System Clock Bits Mode Configuration Command" Command Parameters
Parameter Type Description
(interface-type) Format: optional parameter
( e1 select the external clock type E1
| ds1 or DS1 or 2048Khz
| khz2048
| autoselect )
Possible values:
- e1 : select E1 Source
- ds1 : select DS1 Source
- khz2048 : select 2048KHz Source
- autoselect : autoselect Source
Command Description
This command allows the operator to configure the clock source priority.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.29-1 "System Clock Source Priority Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: clock priority index
( prio1
| prio2 )
Possible values:
- prio1 : configure primary clock source
- prio2 : configure secondary clock source
Table 11.29-2 "System Clock Source Priority Configuration Command" Command Parameters
Parameter Type Description
(priority) Format: optional parameter
( bits-a frequency clock priority selection
| bits-b
| synce-1
| synce-2
| ieee1588-a
| ieee1588-b
| none )
Possible values:
- bits-a : select BITS-A for this priority
- bits-b : select BITS-B for this priority
- synce-1 : select SyncE reference 1 for this priority
- synce-2 : select SyncE reference 2 for this priority
- ieee1588-a : select IEEE 1588-A clock for this priority
- ieee1588-b : select IEEE 1588-B clock for this priority
- none : remove clock source for this priority
Command Description
This command allows the operator to configure the support of synchronous status message (SSM) for the
configured clock source.
Note: When the default-ql is unconfigured, the system resets the default QL value as clk-ql-stu or clk-ql-prc based
on the bits mode.All QL Values are applicable to both ETSI/ANSI unless the difference specified in CLI help.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.30-1 "System Clock Synchronous Status Message Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: clock synchronous status
( bits-a message index
| bits-b
| synce-1
| synce-2
| ieee1588-a
| ieee1588-b )
Possible values:
- bits-a : configure SSM for bits-a
- bits-b : configure SSM for bits-b
- synce-1 : configure SSM for SyncE reference 1
- synce-2 : configure SSM for SyncE reference 2
- ieee1588-a : configure SSM for ieee1588-a
- ieee1588-b : configure SSM for ieee1588-b
Table 11.30-2 "System Clock Synchronous Status Message Configuration Command" Command
Parameters
Parameter Type Description
[no] ssmenable Parameter type: boolean optional parameter
Command Description
This command allows the operator to configure the binding of the syncE reference to the physical port which
provides the clock source for synchronous Ethernet.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.31-1 "System Clock Synchronous Source port Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: reference number of the port
( synce-1
| synce-2 )
Possible values:
- synce-1 : configure port for SyncE reference 1
- synce-2 : configure port for SyncE reference 2
Table 11.31-2 "System Clock Synchronous Source port Configuration Command" Command
Parameters
Parameter Type Description
(port) Format: optional parameter
( ntio-1 : sfp : <ClkSys::SfpFaceplateNumber> port number supporting synce
| ntio-1 : xfp : <ClkSys::SfpFaceplateNumber> clock source
| ntio-2 : sfp : <ClkSys::SfpFaceplateNumber>
| ntio-2 : xfp : <ClkSys::SfpFaceplateNumber>
| nt-a : xfp : <ClkSys::SfpFaceplateNumber>
| nt-b : xfp : <ClkSys::SfpFaceplateNumber>
| nt : sfp : <ClkSys::SfpFaceplateNumber>
| none )
Possible values:
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
Command Description
This command allows the operator to manually select the clock source. Note that the operator must release the
manual clock selection ([none]) to restore the automatic (external) clock source selection.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.32-2 "System Clock Force Reference Configuration Command" Command Parameters
Parameter Type Description
(force-reference) Format: optional parameter
( local manually force system clock
| none ) source
Possible values:
- local : select hold over clock
- none : select autonomous clock selection
Command Description
This command allows the operator to enable or disable SSMout for synce ports. This command is applicable to
NT's supporting enhanced clock management
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.33-1 "SSMOut Configuration Command for synce ports" Resource Parameters
Resource Identifier Type Description
(index) Format: xdsl port supporting synce clock
( ntio-1 : sfp : <ClkSys::SynceOutFaceplateNumber> source
| ntio-1 : xfp : <ClkSys::SynceOutFaceplateNumber>
| ntio-2 : sfp : <ClkSys::SynceOutFaceplateNumber>
| ntio-2 : xfp : <ClkSys::SynceOutFaceplateNumber>
| nt-a : sfp : <ClkSys::SynceOutFaceplateNumber>
| nt-a : xfp : <ClkSys::SynceOutFaceplateNumber>
| nt-b : sfp : <ClkSys::SynceOutFaceplateNumber>
| nt-b : xfp : <ClkSys::SynceOutFaceplateNumber>
| nt : sfp : <ClkSys::SynceOutFaceplateNumber>
| none )
Possible values:
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : active nt slot
- none : no port
Possible values:
- nosfp : no SFP/XFP port
- sfp : SFP port
- xfp : XFP port
Field type <ClkSys::SynceOutFaceplateNumber>
- host SFP faceplate number
Table 11.33-2 "SSMOut Configuration Command for synce ports" Command Parameters
Parameter Type Description
[no] ssmout-enable Parameter type: boolean optional parameter
enable ssm-out for synce port
Command Description
This command allows the operator to enable or disable SSMout for xDSL ports. This command is applicable to
NT's supporting enhanced clock management
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.34-1 "SSMOut Configuration Command for XDSL ports" Resource Parameters
Resource Identifier Type Description
(index) Format: xdsl port supporting synce clock
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / source
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Command Description
This command allows the operator to configure the maximum lt link speed.
Note: maxltlinkspeed value 20Gb is not supported on NANT-E, this is only supported on FANT-F.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.35-2 "Maximum Lt Link Speed Configuration Command" Command Parameters
Parameter Type Description
[no] link-speed Parameter type: <Sys::MaxLtLinkSpeed> optional parameter with default
Format: value: "ten-gb"
( one-gb the maximum lt link speed
| twodotfive-gb
| ten-gb
| twenty-gb
| forty-gb )
Possible values:
- one-gb : enables max 1 Gbps lt link speed
- twodotfive-gb : enables max 2.5 Gbps lt link speed
- ten-gb : enables max 10 Gbps lt link speed
- twenty-gb : enables max 20 Gbps lt link speed
- forty-gb : enables max 40 Gbps lt link speed
Command Description
This command allows the operator to enable or disable the system wide ALS state.
User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.36-2 "ALS State Configuration Command" Command Parameters
Parameter Type Description
[no] action Parameter type: <Sys::AlsState> optional parameter with default
Format: value: "enable"
( enable system wide ALS handling state
| disable )
Possible values:
- enable : enable ALS state
- disable : disable ALS state
Command Description
This command allows the operator to configure system-wide auto-switching parameters.
User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 11.37-2 "Configure system auto-switch" Command Parameters
Parameter Type Description
[no] xdsl-atm-ptm Parameter type: boolean optional parameter
enable system-wide
auto-switching between ATM
and PTM on XDSL ports.
[no] xdsl-stepup-delay Parameter type: <Sys::AutoSwitchDelayTime> optional parameter with default
Format: value: 3600
- delay time in seconds auto-switching step up delay time
- unit: seconds (seconds) for PTM service(s).
- range: [0...65535]
Description
This chapter gives an overview of nodes that are handled by "Security Configuration Commands".
Command Tree
----configure
----system
----security
- [no] oper-policy-prio
- [no] login-banner
- [no] welcome-banner
----[no] operator
- (name)
- profile
- password
- [no] prompt
- [no] description
- [no] more
----[no] profile
- (name)
- [no] prompt
- [no] password-timeout
- [no] terminal-timeout
- [no] slot-numbering
- [no] description
- [no] aaa
- [no] atm
- [no] alarm
- [no] dhcp
- [no] equipment
- [no] igmp
- [no] ip
- [no] pppoe
- [no] qos
- [no] software-mngt
- [no] transport
- [no] vlan
- [no] xdsl
- [no] sip
- [no] megaco
- [no] lacp
- [no] mstp
- [no] security
- [no] service
- [no] debug
- [no] debug-mirror
- [no] filter
- [no] link
- [no] log
- [no] oam
- [no] liadmin
- [no] liuser
- [no] drouter
- [no] ai
----default-profile
- [no] prompt
- [no] password-timeout
- [no] terminal-timeout
- [no] slot-numbering
- [no] description
- [no] aaa
- [no] atm
- [no] alarm
- [no] dhcp
- [no] equipment
- [no] igmp
- [no] ip
- [no] pppoe
- [no] qos
- [no] software-mngt
- [no] transport
- [no] vlan
- [no] xdsl
- [no] sip
- [no] megaco
- [no] lacp
- [no] mstp
- [no] security
- [no] service
- [no] debug
- [no] debug-mirror
- [no] filter
- [no] link
- [no] log
- [no] oam
- [no] liadmin
- [no] liuser
- [no] drouter
- [no] ai
----snmp
----[no] view
- (notify-view)
- subtree
- type
----[no] community
- (name)
- host-address
- [no] context
- [no] privilege
- [no] read-view
- [no] write-view
- [no] notify-view
----[no] group
- (name)
- security-level
- context
- [no] read-view
- [no] write-view
- [no] notify-view
----[no] user
- (name)
- [no] authentication
- [no] privacy
- [no] public
----[no] map-user-group
- (name)
- group-name
----[no] notify-view
- (notify-view)
- subtree
- type
----[no] notify-profile
- (name)
- snmp-version
----[no] filter
- notify-view
----[no] manager
- (name)
- destination
- notify-profile
- [no] nt
- [no] shub
- [no] epon
- [no] xvps1
- [no] xvps2
- [no] xvps3
- [no] xvps4
- [no] xvps5
- [no] xvps6
- [no] xvps7
- [no] xvps8
----radius
- [no] relay
- [no] auth-super-user
- [no] operator-policy
- [no] aut-s-unreach-act
----[no] auth-server
- (name)
- vrf-index
- ip-address
- [no] port
- secret
- [no] retry-limit
- [no] timeout-limit
- [no] admin-down
- [no] dead-interval
----[no] acc-server
- (name)
- vrf-index
- ip-address
- [no] port
- secret
- [no] retry-limit
- [no] timeout-limit
- [no] admin-down
- [no] dead-interval
----[no] dyn-auth-client
- (name)
- vrf-index
- ip-address
- secret
- [no] admin-down
----[no] policy
- (name)
- nas-id
- nas-ip-address
- [no] keep-domain-name
- [no] disable-accnt-msg
- [no] acc-interval
- [no] disable-eap
----[no] servers
- (index)
- auth-server
- vrf-index-auth
- [no] acc-server
- [no] vrf-index-acc
- priority
----[no] domain
- (name)
- vrf-index
- [no] vlan-id
- [no] primary-dns
- [no] second-dns
- [no] primary-nbns
- [no] second-nbns
- [no] sess-timeout
- [no] qos-policy
- authenticator
- [no] admin-down
----[no] conn-profile
- (name)
- version
- [no] reject-no-domain
- [no] reject-inv-domain
- domain-name
----[no] conn-policy
- conn-profile-name
----pae
- [no] port-access
----authenticator
- (port)
- [no] controlled-port
- [no] quiet-period
- [no] tx-period
- [no] supp-timeout
- [no] server-timeout
- [no] max-req
- [no] re-auth-enabled
- [no] re-auth-period
----ext-authenticator
- (port)
- [no] authentication
- [no] init-authreq-off
- [no] handshake
- [no] handshake-period
----port
- (port)
- [no] initialize
----password
- min-length
- min-num-numeric-char
- min-num-special-char
- [no] mixed-case
----filetransfer
- [no] protocol
- [no] tftp-rollovr
----[no] server
- (serverid)
- user-name
- password
----pmfile
----[no] upload
- (upload-index)
- pri-server-addr
- upload-path
- interval-type
- [no] auto-upload
- [no] retry-num
- [no] max-delay
----peripheral-mgnt
----mac-filter
- (index-num)
- [no] filter
Command Description
This command allows the operator to configure the login banner and the welcome banner.
There is a limit to the number of characters that can be entered in a single CLI command. For lengthy banners,
Alcatel-Lucent recommends that the operator enter separate commands to configure the login banner and the
welcome banner.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 12.2-2 "Security Banner Configuration Commmand" Command Parameters
Parameter Type Description
[no] oper-policy-prio Parameter type: <Aaa::AaaPolicyPriority> optional parameter with default
Format: value: "rrn"
( rrn aaa policy priority for operator
| rrt
| ttt )
Possible values:
- rrn : authentication and authorization using Radius without
remote accounting
- rrt : authentication and authorization using Radius while
accounting using TACACS+
- ttt : authentication, authorization and accounting using
TACACS+
[no] login-banner Parameter type: <Sec::Banner> optional parameter with default
Format: value: ""
- a banner to be shown to the operator Note: up to 2048 banner to be shown before the
length of banner is only supported on FANT-F, 480 for other operator enters its name
NT. If using special and functional characters like pound,
reversed slash,space, the whole banner must be in the
quotation marks. Quotation marks and reversed slash is not
counted in length. A reversed slash followed by 'r' combined
with reversed slash followed by 'n' is used to change line.
- length: x<=2048
[no] welcome-banner Parameter type: <Sec::Banner> optional parameter with default
Format: value: ""
Command Description
This command allows the operator to specify an operator instance.
After this instance is created, an operator can log in to the system with the specified name and password.
Operators have a profile that determines most of the operator properties. The operator profile must be created
before the operator can be created.
The operator profile is assigned when the operator is created. The profile cannot be changed afterward. If the
operator wants to change the profile, the operator must first delete the operator and then recreate it.
The default values for prompt can be found in configure system security profile profile-name.
The following rules apply to a plain text password.
• The password must consist of a minimum of six and a maximum of 20 printable characters.
• The password must contain at least one non-alphanumeric character.
• A new password must be different from the last three passwords.
Never specify a new password using the encrypted option. You could mistakenly enter any hexadecimal string that
is not necessarily linked to a password, and it is almost impossible to calculate a password from an encrypted
string. The encrypted method of specifying passwords is only intended to restore an existing configuration.
An operator must enter a new password when logging in for the first time after another operator has changed his
or her password.
There is no separate command to change a password. An operator must change the password in the operator's
operator node.
The prompt can be composed with following components :
• %n : the name of the current operator.
• %s : the current numbering scheme (typ|leg|pos).
• %i : the current system id.
• %! : the current history number.
• % num d : the current context.
- num is the maximum number of components (starting from the last) that are shown (default is all).
- each component will be separated from the next one with a >.
- a > is also added in front of the first component.
• %% : a %
• %c : # if the current node was an existing node or $ if it is newly created.
• %h : the current system id.
• any other character is just added to the prompt as is.
User Level
The command can be accessed by operators with all,admin privileges, and executed by operators with all
privileges.
The last operator with security write permissions cannot be deleted.
An operator can be deleted when still logged in. The operator instance is only removed after the operator has
logged out or is logged out by the system.
Operators without security read or write permissions cannot see other operators.
Operators without security write permissions cannot create, delete, or modify another operator, but they can enter
the commands to perform these actions. However, these commands always fail when executed.
Command Syntax
The command has the following syntax:
> configure system security ( no operator (name) ) | ( operator (name) profile <Sec::ProfileName> password
<Sec::OperatorPassword> [ no prompt | prompt <Sec::Prompt> ] [ no description | description
<Sec::OperatorDesc> ] [ [ no ] more ] )
Command Parameters
Table 12.3-1 "Operator Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: the name of the operator
- the name of an operator
- range: [a-z0-9]
- length: 1<=x<=11
Table 12.3-2 "Operator Configuration Command" Command Parameters
Parameter Type Description
profile Parameter type: <Sec::ProfileName> mandatory parameter
Format: The parameter is not visible
- the name of an operator profile during modification.
- range: [a-z0-9] the name of an operator profile
- length: 1<=x<=11
password Parameter type: <Sec::OperatorPassword> mandatory parameter
Format: the password needed to log in
( prompt
| plain : <Sec::OperatorPlainPassword>
| encrypted : <Sec::EncryptedPassword> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
- encrypted : the hashed password
Field type <Sec::OperatorPlainPassword>
- the password in plain text is placed in double quotes when
# ? [ or ] is used.\n In double quotes, backslash is regared as
escape, and it is used to escape control character, quotation
mark, and itself.
- length: 6<=x<=20
Field type <Sec::EncryptedPassword>
- the encrypted password
- length: 20
[no] prompt Parameter type: <Sec::Prompt> optional parameter with default
Format: value: ""
- a specification of the prompt the specification of the prompt
- length: x<=28
[no] description Parameter type: <Sec::OperatorDesc> optional parameter with default
Format: value: ""
- any description to be used by the operator any description to be used by the
- length: x<=31 operator
[no] more Parameter type: boolean optional parameter
the output is passed via the more
Command Description
This command allows the operator to specify an operator profile.
The operator profile determines most of the operator properties.
An operator profile is typically used to limit the commands that a group of operators can execute to those for which
they have the necessary skills and for which they are responsible.
Any change of the attribute slot-numbering will only take effect for new CLI sessions. The slot-numbering of an
active CLI session will never be changed. The actual slot-numbering used for a session can be made visible with
the command show sessions
terminal-timeout: A value of 0 equals an infinite timeout value (i.e. the terminal will never time out).
The prompt can be composed with following components :
• %n : the name of the current operator.
• %s : the current numbering scheme (typ|leg|pos).
• %i : the current system id.
• %! : the current history number.
• % num d : the current context.
- num is the maximum number of components (starting from the last) that are shown (default is all).
- each component will be separated from the next one with a >.
- a > is also added in front of the first component.
• %% : a %
• %c : # if the current node was an existing node or $ if it is newly created.
• %h : the current system id.
• any other character is just added to the prompt as is.
User Level
The command can be accessed by operators with all,admin privileges.
The last operator with security write permissions cannot be deleted.
The permissions of a profile cannot be changed as long as one operator belongs to the profile.
Operators without security read or write permissions cannot see other operator profiles.
Command Syntax
The command has the following syntax:
> configure system security ( no profile (name) ) | ( profile (name) [ no prompt | prompt <Sec::Prompt> ] [ no
password-timeout | password-timeout <Sec::PasswordTimeout> ] [ no terminal-timeout | terminal-timeout
<Sec::InactivityTimeout> ] [ no slot-numbering | slot-numbering <Sec::SlotDesc> ] [ no description | description
<Sec::ProfileDesc> ] [ no aaa | aaa <Sec::Aaa> ] [ no atm | atm <Sec::Atm> ] [ no alarm | alarm <Sec::Alarm> ] [
no dhcp | dhcp <Sec::Dhcp> ] [ no equipment | equipment <Sec::Equipment> ] [ no igmp | igmp <Sec::Igmp> ] [ no
ip | ip <Sec::Ip> ] [ no pppoe | pppoe <Sec::Pppoe> ] [ no qos | qos <Sec::Qos> ] [ no software-mngt |
software-mngt <Sec::Sw> ] [ no transport | transport <Sec::Transport> ] [ no vlan | vlan <Sec::Vlan> ] [ no xdsl |
xdsl <Sec::Xdsl> ] [ no sip | sip <Sec::Sip> ] [ no megaco | megaco <Sec::Megaco> ] [ no lacp | lacp <Sec::Lacp> ]
[ no mstp | mstp <Sec::Mstp> ] [ no security | security <Sec::Security> ] [ no service | service <Sec::Service> ] [ no
Command Parameters
Table 12.4-1 "Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: the name of the profile
- the name of an operator profile
- range: [a-z0-9]
- length: 1<=x<=11
Table 12.4-2 "Profile Configuration Command" Command Parameters
Parameter Type Description
[no] prompt Parameter type: <Sec::Prompt> optional parameter with default
Format: value: "\"%s : %n%d%c \""
- a specification of the prompt the specification of the prompt
- length: x<=28
[no] password-timeout Parameter type: <Sec::PasswordTimeout> optional parameter with default
Format: value: 0
- the maximum time a password may be unchanged the maximum time a password
- unit: days may be unchanged
- range: [0...365]
[no] terminal-timeout Parameter type: <Sec::InactivityTimeout> optional parameter with default
Format: value: 30
- specify the inactivity timeout of the terminal specify the inactivity timeout of
- unit: minutes the terminal
- range: [0...120]
[no] slot-numbering Parameter type: <Sec::SlotDesc> optional parameter with default
Format: value: "legacy-based"
( type-based slot numbering scheme to be used
| position-based by the operator
| legacy-based )
Possible values:
- type-based : flat-numbering per slot-type (tl1-like)
- position-based : flat-numbering independent of slot-type
- legacy-based : numbering used since the early days
(position-based-like)
[no] description Parameter type: <Sec::ProfileDesc> optional parameter with default
Format: value: ""
- any description to be used by the operator any description to be used by the
- length: x<=31 operator
[no] aaa Parameter type: <Sec::Aaa> optional parameter with default
Format: value: "none"
( write the access rights to AAA related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] atm Parameter type: <Sec::Atm> optional parameter with default
Format: value: "none"
( write the access rights to ATM related
Command Description
This command allows the superuser to specify a default operator profile. The default profile is used when an
operator is authenticated via a RADIUS server but the RADIUS server does not support vendor-specific attributes.
The default profile determines most of the operator properties.
The prompt can be composed with following components :
• %n : the name of the current operator.
• %s : the current numbering scheme (typ|leg|pos).
• %i : the current system id.
• %! : the current history number.
• % num d : the current context.
- num is the maximum number of components (starting from the last) that are shown (default is all).
- each component will be separated from the next one with a >.
- a > is also added in front of the first component.
• %% : a %
• %c : # if the current node was an existing node or $ if it is newly created.
• any other character is just added to the prompt as is.
User Level
The command can be accessed by operators with all,admin privileges.
Operators without security read or write permissions cannot see the default profile.
Operators withouit security read or write permissions can never see default-profile.
Command Syntax
The command has the following syntax:
Command Parameters
Table 12.5-2 "Default Profile Configuration Command" Command Parameters
Command Description
This command allows the operator to configure a view.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
A subtree is identified by an object ID, which is a sequence of numbers (example: 1.3.6.1.6.3.12.1.3). This sequence
uniquely identifies a node or a leaf in the MIB tree.
The same subtree can also be addressed using symbolic MIB names (example: snmpTargetParamsTable).
Combinations of symbolic names and numbers are also possible: 1.3.6.1.6.3.12.1.3.1.7.97.97.97 can be written as
snmpTargetParamsTable.1.7.97.97.97 or as snmpTargetParamsRowStatus.97.97.97, ...
For each number, we can indicate that it may be ignored when comparing it with MIB elements, by adding an
asterisk after the number (example: snmpTargetParamsRowStatus.97.97*.97). Because the number is ignored
anyway, we recommend replacing it with a 0. For example, snmpTargetParamsRowStatus.97.0*.97. 0* can be
abbreviated as *. So, the recommended representation is snmpTargetParamsRowStatus.97.*.97.
The system stores a view entry based on the view name and the object ID: snmpTargetParamsRowStatus.97.0*.97
and snmpTargetParamsRowStatus.97.97*.97 are stored in two different locations, but match the same MIB
elements. A consequence of this strategy is that snmpTargetParamsRowStatus.97.97*.97 and
snmpTargetParamsRowStatus.97.97.97 can not exist at the same time.
The most specific filter element takes precedence in the case where more than one filter element matches the same
MIB element.
Clarification regarding 'entry-status': If a failure occurs during the configuration of an SNMP view, please check if
the view was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire
SNMP view.
Command Syntax
The command has the following syntax:
> configure system security snmp ( no view (notify-view) subtree <Snmp::ViewSubtree> ) | ( view (notify-view)
subtree <Snmp::ViewSubtree> type <Snmp::FilterType> )
Command Parameters
Table 12.6-1 "SNMP View Configuration Command" Resource Parameters
Resource Identifier Type Description
(notify-view) Format: the name of the view
- the name of a view
- length: x<=32
subtree Parameter type: <Snmp::ViewSubtree> the subtree
Format:
Command Output
Table 12.6-3 "SNMP View Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Transport::WaitRowStatusVacmFilter> the status of an SNMP view
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
Possible values:
- valid : SNMP view configuration is ok
- corrupted : SNMP view configuration is not
operational(not-in-service)
- corrupted : SNMP view configuration is not
operational(not-ready)
Command Description
This command allows the operator to configure community names.
An existing community can not be modified.
SNMP uses community names as a kind of password without user name to verify if a request may be executed.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
There must be at least one community with read-write privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 12.7-1 "Security SNMP Community Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: the name of the community
- the community name\n The name in plain text is placed in
double quotes when # ? [ or ] is used.\n In double quotes,
backslash is regarded as escape, and it is used to escape
control character, quotation mark, and itself.
- length: x<=32
host-address Parameter type: <Ip::AddressAndIpMaskFull> the host IP address from where
Format: access is allowed
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Table 12.7-2 "Security SNMP Community Configuration Command" Command Parameters
Command Description
This command allows the operator to configure an SNMPv3 Group.
Clarification regarding 'entry-status': If a failure occurs during the configuration of an SNMPv3 Group, please
check if the group was created and if the corresponding entry-status is valid. If not, please delete and re-create the
entire SNMPv3 Group.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system security snmp ( no group (name) security-level <Snmp::SecurityLevel> context
<Snmp::Context> ) | ( group (name) security-level <Snmp::SecurityLevel> context <Snmp::Context> [ no
read-view | read-view <Snmp::AssociatedViewName> ] [ no write-view | write-view
<Snmp::AssociatedViewName> ] [ no notify-view | notify-view <Snmp::AssociatedViewName> ] )
Command Parameters
Table 12.8-1 "Security SNMPv3 Group Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of snmpV3 group
- name of the snmpv3 group\n The name in plain text is
placed in double quotes when # ? [ or ] is used.\n In double
quotes, backslash is regarded as escape, and it is used to
escape control character, quotation mark, and itself.
- length: 1<=x<=32
security-level Parameter type: <Snmp::SecurityLevel> security level for the group
Format:
( none
| authentication
| privacy-and-auth )
Possible values:
- none : no authentication and no privacy
- authentication : authentication without privacy
- privacy-and-auth : authentication and privacy
context Parameter type: <Snmp::Context> context for the group
Format:
( single : nt
Command Output
Table 12.8-3 "Security SNMPv3 Group Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Transport::WaitRowStatusconfigGroup> the status of an SNMPv3 group
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
Possible values:
- valid : SNMPv3 group configuration is ok
- corrupted : SNMPv3 group configuration is not
operational(not-in-service)
- corrupted : SNMPv3 group configuration is not
operational(not-ready)
Command Description
This command allows the operator to configure an SNMPv3 user.
Clarification regarding 'entry-status': If a failure occurs during the configuration of an SNMPv3 user, please check
if the user was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire
SNMPv3 user.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system security snmp ( no user (name) ) | ( user (name) [ no authentication | authentication
<Snmp::AuthType> ] [ no privacy | privacy <Snmp::PrivacyType> ] [ no public | public <Snmp::Identifier> ] )
Command Parameters
Table 12.9-1 "Security SNMPv3 User Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the user
- snmpv3 user name\n The name in plain text is placed in
double quotes when # ? [ or ] is used.\n In double quotes,
backslash is regarded as escape, and it is used to escape
control character, quotation mark, and itself.
- length: 1<=x<=32
Table 12.9-2 "Security SNMPv3 User Configuration Command" Command Parameters
Parameter Type Description
[no] authentication Parameter type: <Snmp::AuthType> optional parameter with default
Format: value: "none"
( none authentication for the user
| md5 : prompt
| sha1 : prompt
| md5 : plain : <Sec::UsmPlainPassword>
| sha1 : plain : <Sec::UsmPlainPassword>
| md5 : encrypted : <Snmp::AuthEncryptedKey>
| sha1 : encrypted : <Snmp::AuthEncryptedKey> )
Possible values:
- none : no authentication
Command Output
Table 12.9-3 "Security SNMPv3 User Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Transport::WaitRowStatusSnmpUser> the status of an SNMPv3 user
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
Possible values:
- valid : SNMPv3 user configuration is ok
- corrupted : SNMPv3 user configuration is not
operational(not-in-service)
- corrupted : SNMPv3 user configuration is not
Command Description
This command allows the operator to map an SNMPv3 user to an SNMPv3 group.
Clarification regarding 'entry-status': If a failure occurs during the configuration of mapping an SNMPv3 user to
SNMPv3 user-group , please check if the mapping was done and if the corresponding entry-status is valid. If not,
please delete and re-create the entire configuration of mapping an SNMPv3 user to SNMPv3 user-group.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system security snmp ( no map-user-group (name) ) | ( map-user-group (name) group-name
<Snmp::AssociatedGroupName> )
Command Parameters
Table 12.10-1 "Security SNMPv3 User-Group Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the snmpV3 user
- snmpv3 user name\n The name in plain text is placed in
double quotes when # ? [ or ] is used.\n In double quotes,
backslash is regarded as escape, and it is used to escape
control character, quotation mark, and itself.
- length: 1<=x<=32
Table 12.10-2 "Security SNMPv3 User-Group Configuration Command" Command Parameters
Parameter Type Description
group-name Parameter type: <Snmp::AssociatedGroupName> mandatory parameter
Format: name of the snmpV3 group
- name of the snmpv3 group
- length: 1<=x<=32
Command Output
Table 12.10-3 "Security SNMPv3 User-Group Configuration Command" Display parameters
Specific Information
Command Description
This command allows the operator to configure a Notify View.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
A subtree is identified by an object ID, which is a sequence of numbers (example: 1.3.6.1.6.3.12.1.3). This sequence
uniquely identifies a node or a leaf in the MIB tree.
The same subtree can also be addressed using symbolic MIB names (example: snmpTargetParamsTable).
Combinations of symbolic names and numbers are also possible: 1.3.6.1.6.3.12.1.3.1.7.97.97.97 can be written as
snmpTargetParamsTable.1.7.97.97.97 or as snmpTargetParamsRowStatus.97.97.97, ...
For each number, we can indicate that it may be ignored when comparing it with MIB elements, by adding an
asterisk after the number (example: snmpTargetParamsRowStatus.97.97*.97). Because the number is ignored
anyway, we recommend replacing it with a 0. For example, snmpTargetParamsRowStatus.97.0*.97. 0* can be
abbreviated as *. So, the recommended representation is snmpTargetParamsRowStatus.97.*.97.
The system stores a view entry based on the view name and the object ID: snmpTargetParamsRowStatus.97.0*.97
and snmpTargetParamsRowStatus.97.97*.97 are stored in two different locations, but match the same MIB
elements. A consequence of this strategy is that snmpTargetParamsRowStatus.97.97*.97 and
snmpTargetParamsRowStatus.97.97.97 can not exist at the same time.
The most specific filter element takes precedence in the case where more than one filter element matches the same
MIB element.
Clarification regarding 'entry-status': If a failure occurs during the configuration of a Notify View, please check if
the view was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire
Notify View.
Command Syntax
The command has the following syntax:
> configure system security snmp ( no notify-view (notify-view) subtree <Snmp::ViewSubtree> ) | ( notify-view
(notify-view) subtree <Snmp::ViewSubtree> type <Snmp::FilterType> )
Command Parameters
Table 12.11-1 "SNMP Notify View Configuration Command" Resource Parameters
Resource Identifier Type Description
(notify-view) Format: the name of the notify view
- the name of a view
- length: x<=32
subtree Parameter type: <Snmp::ViewSubtree> the subtree
Format:
Command Output
Table 12.11-3 "SNMP Notify View Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Transport::WaitRowStatusNotifyFilter> the status of an SNMP notify
( valid view
| corrupted This element is only shown in
| corrupted ) detail mode.
Possible values:
- valid : SNMP Notify View configuration is ok
- corrupted : SNMP notify view configuration is not
operational(not-in-service)
- corrupted : SNMP notify view configuration is not
operational(not-ready)
Command Description
This command allows the operator to configure a notification profile.
Clarification regarding 'entry-status': If a failure occurs during the configuration of the SNMP notification profile,
please check if the profile was created and if the corresponding entry-status is valid. If not, please delete and
re-create the entire SNMP notification profile.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system security snmp ( no notify-profile (name) ) | ( notify-profile (name) snmp-version
<Snmp::SnmpVersion> )
Command Parameters
Table 12.12-1 "Security SNMP Notification Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the notification profile
- notification-profile name
- length: 1<=x<=32
Table 12.12-2 "Security SNMP Notification Profile Configuration Command" Command
Parameters
Parameter Type Description
snmp-version Parameter type: <Snmp::SnmpVersion> mandatory parameter
Format: The parameter is not visible
( v1 : <Snmp::CommunityString> during modification.
| v2 : <Snmp::CommunityString> snmp-version of the profile
| v3 : <Snmp::SecurityName> : none
| v3 : <Snmp::SecurityName> : authentication
| v3 : <Snmp::SecurityName> : privacy-and-auth )
Possible values:
- v1 : SNMP version1
- v2 : SNMP version2
- v3 : SNMP version3
Field type <Snmp::CommunityString>
- community string
Command Output
Table 12.12-3 "Security SNMP Notification Profile Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Transport::WaitRowStatusProfile> the status of notification profile
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
Possible values:
- valid : notification profile configuration is ok
- corrupted : notification profile configuration is not
operational(not-in-service)
- corrupted : notification profile configuration is not
operational(not-ready)
Command Description
This command allows the operator to configure a filter for a notification profile.
Clarification regarding 'entry-status': If a failure occurs during the configuration of a filter for SNMP notification
profile, please check if the filter was created and if the corresponding entry-status is valid. If not, please delete and
re-create the entire notification profile filter.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system security snmp notify-profile (name) ( no filter ) | ( filter notify-view <Snmp::ViewName> )
Command Parameters
Table 12.13-1 "Security SNMP Notification Profile Filter Configuration Command" Resource
Parameters
Resource Identifier Type Description
(name) Format: name of the notification profile
- notification-profile name
- length: 1<=x<=32
Table 12.13-2 "Security SNMP Notification Profile Filter Configuration Command" Command
Parameters
Parameter Type Description
notify-view Parameter type: <Snmp::ViewName> mandatory parameter
Format: view to be accessed
- the name of a view
- length: x<=32
Command Output
Table 12.13-3 "Security SNMP Notification Profile Filter Configuration Command" Display
parameters
Specific Information
name Type Description
entry-status Parameter type: <Transport::WaitRowStatusNotifyView> the status of notification profile
Command Description
This command allows the operator to configure an Element Manager using a Profile.
Clarification regarding 'entry-status': If a failure occurs during the configuration of the SNMP element manager,
please check if the element manager was created and if the corresponding entry-status is valid. If not, please delete
and re-create the entire SNMP element manager.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system security snmp ( no manager (name) ) | ( manager (name) destination <Snmp::Address>
notify-profile <Snmp::NotifyProfile> [ [ no ] nt ] [ [ no ] shub ] [ [ no ] epon ] [ [ no ] xvps1 ] [ [ no ] xvps2 ] [ [ no
] xvps3 ] [ [ no ] xvps4 ] [ [ no ] xvps5 ] [ [ no ] xvps6 ] [ [ no ] xvps7 ] [ [ no ] xvps8 ] )
Command Parameters
Table 12.14-1 "Security SNMP Element Manager Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the element manager
- element manager name
- length: 1<=x<=32
Table 12.14-2 "Security SNMP Element Manager Configuration Command" Command Parameters
Parameter Type Description
destination Parameter type: <Snmp::Address> mandatory parameter
Format: The parameter is not visible
<Snmp::IpAddress> : <Snmp::AddressPort> during modification.
Field type <Snmp::IpAddress> destination address of the element
- ip-address for the manager manager
Field type <Snmp::AddressPort>
- port number for the manager
- range: [1...65535]
notify-profile Parameter type: <Snmp::NotifyProfile> mandatory parameter
Format: name of the notification profile
- notification-profile name
- length: 1<=x<=32
[no] nt Parameter type: boolean optional parameter
Command Output
Table 12.14-3 "Security SNMP Element Manager Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Transport::WaitRowStatusconfigManger> the status of an SNMP Element
( valid Manager
| corrupted This element is only shown in
| corrupted ) detail mode.
Possible values:
- valid : SNMPv3 element manager configuration is ok
- corrupted : SNMPv3 element manager configuration is not
operational(not-in-service)
- corrupted : SNMPv3 element manager configuration is not
operational(not-ready)
Command Description
This command allows to configure generic parameters for when a Radius Client is used. More details can be found
in the description per parameter.
User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 12.15-2 "Security RADIUS Client Configuration Command" Command Parameters
Parameter Type Description
[no] relay Parameter type: boolean optional parameter
enable radius relay
[no] auth-super-user Parameter type: boolean optional parameter
enable superuser RADIUS
Authentication
[no] operator-policy Parameter type: <Aaa::RadiusPolicyName> optional parameter with default
Format: value: "none"
( none name of Radius policy to be
| name : <Aaa::IgnoredRadiusPolicyName> ) applied to this operator
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <Aaa::IgnoredRadiusPolicyName>
- name of the RADIUS policy
- length: 1<=x<=64
[no] aut-s-unreach-act Parameter type: <Aaa::RadiusAuthServUnreachAction> optional parameter with default
Format: value: "reject-all"
( reject-all action to be taken for 802.1x
| accept-all ) users when authentication server
Possible values: is unreachable
- reject-all : All session requests are rejected
- accept-all : All session requests are accepted
Command Description
This command allows the operator to configure the RADIUS authentication servers. The conceptual table lists the
RADIUS authentication servers with their configurable parameters. If an entry (server) must be deleted, it must not
be associated with any RADIUS policy. If an entry is associated with a policy, the deletion is not allowed.
Note: the products from the ISAM 7363 and 7367 family support only vrf-index=0.
User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
> configure system security radius ( no auth-server (name) vrf-index <Aaa::VrfIndex> ) | ( auth-server (name)
vrf-index <Aaa::VrfIndex> ip-address <Aaa::InetAddress> [ no port | port <Aaa::InetPortNumber> ] secret
<Security::Password3> [ no retry-limit | retry-limit <Aaa::RadiusRetryLimit> ] [ no timeout-limit | timeout-limit
<Aaa::RadiusTimeout> ] [ [ no ] admin-down ] [ no dead-interval | dead-interval <Aaa::RadiusDeadInterval> ] )
Command Parameters
Table 12.16-1 "Security RADIUS Authentication Server Configuration Command" Resource
Parameters
Resource Identifier Type Description
(name) Format: name of RADIUS authentication
- name of the RADIUS auth server server
- length: 1<=x<=64
vrf-index Parameter type: <Aaa::VrfIndex> vrf to which this auth server
Format: belongs
- a vrf index
- range: [0...127]
Table 12.16-2 "Security RADIUS Authentication Server Configuration Command" Command
Parameters
Parameter Type Description
ip-address Parameter type: <Aaa::InetAddress> mandatory parameter
Format: IP address of RADIUS
- IPv4-address authentication server
[no] port Parameter type: <Aaa::InetPortNumber> optional parameter with default
Format: value: 1812
- the port number that is used to communicate with an AAA UDP port to which RADIUS auth
server messages should be sent
Command Description
This command allows the operator to configure the RADIUS accounting servers. The conceptual table lists the
RADIUS accounting servers with their configurable parameters. If an entry (server) must be deleted, it must not be
associated with any RADIUS policy. If an entry is associated with a policy, the deletion is not allowed.
Note: the products from the ISAM 7363 and 7367 family support only vrf-index=0.
User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
> configure system security radius ( no acc-server (name) vrf-index <Aaa::VrfIndex> ) | ( acc-server (name)
vrf-index <Aaa::VrfIndex> ip-address <Aaa::InetAddress> [ no port | port <Aaa::InetPortNumber> ] secret
<Security::Password3> [ no retry-limit | retry-limit <Aaa::RadiusRetryLimit> ] [ no timeout-limit | timeout-limit
<Aaa::RadiusTimeout> ] [ [ no ] admin-down ] [ no dead-interval | dead-interval <Aaa::RadiusDeadInterval> ] )
Command Parameters
Table 12.17-1 "Security RADIUS Accounting Server Configuration Command" Resource
Parameters
Resource Identifier Type Description
(name) Format: name of the RADIUS accounting
- name of the RADIUS accounting server server
- length: 1<=x<=64
vrf-index Parameter type: <Aaa::VrfIndex> vrf to which the RADIUS Acc
Format: Server belongs
- a vrf index
- range: [0...127]
Table 12.17-2 "Security RADIUS Accounting Server Configuration Command" Command
Parameters
Parameter Type Description
ip-address Parameter type: <Aaa::InetAddress> mandatory parameter
Format: IP address of RADIUS
- IPv4-address accounting server
[no] port Parameter type: <Aaa::InetPortNumber> optional parameter with default
Format: value: 1813
- the port number that is used to communicate with an AAA UDP port to which RADIUS
server accounting messages be sent
Command Description
This command allows the operator to configure the RADIUS Dynamic Authorization Clients. The conceptual table
lists the RADIUS Dynamic Authorization Clients with their configurable parameters.
Note: the products from the ISAM 7363 and 7367 family support only vrf-index=0.
User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
> configure system security radius ( no dyn-auth-client (name) vrf-index <Aaa::VrfIndex> ) | ( dyn-auth-client
(name) vrf-index <Aaa::VrfIndex> ip-address <Aaa::InetAddress> secret <Security::Password3> [ [ no ]
admin-down ] )
Command Parameters
Table 12.18-1 "Security RADIUS Dynamic Authorization Client Configuration Command"
Resource Parameters
Resource Identifier Type Description
(name) Format: name of the RADIUS Dynamic
- name of dynamic auth client name Authorization client
- length: 1<=x<=64
vrf-index Parameter type: <Aaa::VrfIndex> vrf to which the RADIUS Dyn
Format: Auth Client belongs
- a vrf index
- range: [0...127]
Table 12.18-2 "Security RADIUS Dynamic Authorization Client Configuration Command"
Command Parameters
Parameter Type Description
ip-address Parameter type: <Aaa::InetAddress> mandatory parameter
Format: IP address of RADIUS
- IPv4-address authentication server
secret Parameter type: <Security::Password3> mandatory parameter
Format: secret string used between
( prompt RADIUS server and client
| plain : <Security::PlainPassword3>
| encrypted : <Security::EncryptedPasswordx> )
Possible values:
Command Description
This command allows the operator to configure RADIUS policies. The conceptual table lists the RADIUS policies
with the parameters that apply globally for each RADIUS policy. An entry in this table (policy) can be deleted only
if it is not associated with any of the domains. If this entry is deleted, the corresponding entry in the RADIUS server
is also deleted.
User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
> configure system security radius ( no policy (name) ) | ( policy (name) nas-id <Aaa::NasId> nas-ip-address
<Aaa::InetAddress> [ [ no ] keep-domain-name ] [ [ no ] disable-accnt-msg ] [ no acc-interval | acc-interval
<Aaa::AccInt> ] [ [ no ] disable-eap ] )
Command Parameters
Table 12.19-1 "Security RADIUS Policy Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the RADIUS policy
- name of the radius policy
- length: 1<=x<=64
Table 12.19-2 "Security RADIUS Policy Configuration Command" Command Parameters
Parameter Type Description
nas-id Parameter type: <Aaa::NasId> mandatory parameter
Format: NAS-Identifier used in messages
- a binary string of min 0 and max 64 towards Radius servers
- length: x<=64
nas-ip-address Parameter type: <Aaa::InetAddress> mandatory parameter
Format: NAS-IP-Address used in
- IPv4-address messages towards Radius servers
[no] keep-domain-name Parameter type: boolean optional parameter
don't strip domain name when
sending to RADIUS server
[no] disable-accnt-msg Parameter type: boolean optional parameter
disable
[no] acc-interval Parameter type: <Aaa::AccInt> optional parameter with default
Format: value: 0
- radius accnt interval Interim Accounting Interval in
Command Description
This command allows the operator to configure RADIUS servers. The conceptual table lists the set of RADIUS
servers with the parameters of each set. The servers that are placed in a set using this table must first be defined in
the RADIUS Authenticaion and Accounting server configuration commands. The value returned by the RADIUS
server is used by the management station as the value for the index when a new entry in this table is created.
It is always mandatory to configure acc-server along with vrf-index-acc and auth-server with vrf-index-auth,
otherwise the configuration will not succeed.
Note: the products from the ISAM 7363 and 7367 family support only vrf-index=0.
User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
> configure system security radius policy (name) ( no servers (index) ) | ( servers (index) auth-server
<Aaa::RadAuthServer> vrf-index-auth <Aaa::VrfIndex> [ no acc-server | acc-server <Aaa::RadAccServer> ] [ no
vrf-index-acc | vrf-index-acc <Aaa::IgnoredVrfIndex> ] priority <Aaa::Priority> )
Command Parameters
Table 12.20-1 "Security RADIUS Server Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the RADIUS policy
- name of the radius policy
- length: 1<=x<=64
(index) Format: index of RADIUS profile
- unique nbr identifying a set within a RADIUS profile.
- range: [1...2]
Table 12.20-2 "Security RADIUS Server Configuration Command" Command Parameters
Parameter Type Description
auth-server Parameter type: <Aaa::RadAuthServer> mandatory parameter
Format: the radius authentication server
name : <Aaa::RadAuthServerName>
Possible values:
- name : use a radius server for authentication
Field type <Aaa::RadAuthServerName>
- name of the RADIUS auth server
- length: 1<=x<=64
Command Description
This command allows the operator to configure the domain.
User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
> configure system security ( no domain (name) ) | ( domain (name) vrf-index <Aaa::DomainVrfIndex> [ no
vlan-id | vlan-id <Vlan::VlanIndexOrZero> ] [ no primary-dns | primary-dns <Aaa::InetAddress> ] [ no second-dns
| second-dns <Aaa::InetAddress> ] [ no primary-nbns | primary-nbns <Aaa::InetAddress> ] [ no second-nbns |
second-nbns <Aaa::InetAddress> ] [ no sess-timeout | sess-timeout <Aaa::DomainSessionTimeout> ] [ no
qos-policy | qos-policy <Aaa::QosProfileName> ] authenticator <Aaa::Authenticator> [ [ no ] admin-down ] )
Command Parameters
Table 12.21-1 "Security Domain Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the domain
- name of the domain
- length: 1<=x<=64
Table 12.21-2 "Security Domain Configuration Command" Command Parameters
Parameter Type Description
vrf-index Parameter type: <Aaa::DomainVrfIndex> mandatory parameter
Format: valid VRF index
- a vrf index for a domain
- range: [-1,1...127]
[no] vlan-id Parameter type: <Vlan::VlanIndexOrZero> optional parameter with default
Format: value: 0
- vlan id a vlan id
- range: [0...4092]
[no] primary-dns Parameter type: <Aaa::InetAddress> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address IP address of primary DNS server
[no] second-dns Parameter type: <Aaa::InetAddress> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address IP address of secondary DNS
server
[no] primary-nbns Parameter type: <Aaa::InetAddress> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address IP address of primary NBNS
server
Command Description
This command allows the operator to configure the connection profile parameters.
User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
> configure system security ( no conn-profile (name) ) | ( conn-profile (name) version <SignedInteger> [ [ no ]
reject-no-domain ] [ [ no ] reject-inv-domain ] domain-name <Aaa::DomainName> )
Command Parameters
Table 12.22-1 "Security Connection Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of connection profile
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 12.22-2 "Security Connection Profile Configuration Command" Command Parameters
Parameter Type Description
version Parameter type: <SignedInteger> mandatory parameter
Format: version number to be associated
- a signed integer to the Profile
[no] reject-no-domain Parameter type: boolean optional parameter
reject user session auth if no
domain
[no] reject-inv-domain Parameter type: boolean optional parameter
reject user session auth if invalid
domain
domain-name Parameter type: <Aaa::DomainName> mandatory parameter
Format: name of the domain
- name of the domain
- length: 1<=x<=64
Command Description
This command allows the operator to configure a connection policy associated with the specified policy. The
operator should specify the index that indicates which connection policy to apply and the profile-index, which
provides the connection profile associated with this policy.
User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 12.23-2 "Security Connection Policy Configuration Command" Command Parameters
Parameter Type Description
conn-profile-name Parameter type: <AsamProfileName> mandatory parameter
Format: connection profile associated
- a profile name with this policy
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Command Description
This command allows the operator to configure the administrative enable and disable state for port access control
in a system.
User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 12.24-2 "Security 802.1x PAE System Configuration Command" Command Parameters
Parameter Type Description
[no] port-access Parameter type: boolean optional parameter
enable port access control
Command Description
This command allows the operator to configure security 802.1x port authentication.
This command is valid for user ports. If the user port resides on a board that does not support user authentication,
this command will fail.
User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 12.25-1 "Security 802.1x Port Authentication Configuration Command" Resource
Parameters
Resource Identifier Type Description
(port) Format: identification of the port or
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : <Eqpt::LLId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Command Description
This command allows the operator to configure the security 802.1x extension port authentication.
User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 12.26-1 "Security 802.1x Extension, Port Authentication Configuration Command" Resource
Parameters
Resource Identifier Type Description
(port) Format: identification of the port or
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : <Eqpt::LLId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Command Description
This command allows the operator to configure the security 802.1x port.
User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 12.27-1 "Security 802.1x Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identification of the port or
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
Command Description
This command allows the operator to configure the password policy.
User Level
The command can be accessed by operators with security,all privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 12.28-2 "Security Password Policy Configuration Commmand" Command Parameters
Parameter Type Description
min-length Parameter type: <Sec::PwdLength> optional parameter
Format: the minimum length of the
- the minimum length of the password password
- unit: characters
- range: [6...20]
min-num-numeric-char Parameter type: <Sec::PwdNumChars> optional parameter
Format: minimum number of numerical
- minimum number of numerical characters characters
- unit: characters
- range: [0...20]
min-num-special-char Parameter type: <Sec::PwdSpeChars> optional parameter
Format: minimum number of special
- minimum number of special character character
- unit: characters
- range: [1...20]
[no] mixed-case Parameter type: <Sec::MixCase> optional parameter with default
Format: value: "not-mandatory"
( mandatory both upper and lower case
| not-mandatory ) characters must be present
Possible values:
- mandatory : both upper and lower case characters must be
present
- not-mandatory : both upper and lower case characters not
Command Description
This command configure file transfer states and attributes.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 12.29-2 "File Transfer Configure Command" Command Parameters
Parameter Type Description
[no] protocol Parameter type: <SwMngt::FileTransferProtocolType> optional parameter with default
Format: value: "tftp"
( tftp the protocol that is to be used for
| ftp file transfer
| sftp )
Possible values:
- tftp : the tftp protocol is selected for file transfer
- ftp : the ftp protocol is selected for file transfer
- sftp : the sftp protocol is selected for file transfer
[no] tftp-rollovr Parameter type: <SwMngt::FileTransferRolloverType> optional parameter with default
Format: value: 0
- TFTP Block Number The value with which TFTP
- range: [0...1] Block number rollover will
happen
Command Description
This command configures file transfer server states and attributes.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system security filetransfer ( no server (serverid) ) | ( server (serverid) user-name
<SwMngt::UserName> password <Security::Password1> )
Command Parameters
Table 12.30-1 "file Transfer server Configure Commands" Resource Parameters
Resource Identifier Type Description
(serverid) Format: (IP address) of the file transfer
- IPv4-address server
Table 12.30-2 "file Transfer server Configure Commands" Command Parameters
Parameter Type Description
user-name Parameter type: <SwMngt::UserName> mandatory parameter
Format: the username used to access the
- the username used to access the file server file server
- length: x<=32
password Parameter type: <Security::Password1> mandatory parameter
Format: the password used to access the
( prompt file server
| plain : <Security::PlainPassword1>
| encrypted : <Security::EncryptedPasswordx> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
- encrypted : the encrypted password
Field type <Security::PlainPassword1>
- the password used to access the file server
- length: 1<=x<=32
Field type <Security::EncryptedPasswordx>
- password string exposed to users
- length: 8<=x<=64
Command Description
This command configures PM file upload related parameters
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system security pmfile ( no upload (upload-index) ) | ( upload (upload-index) pri-server-addr
<SwMngt::pmFileUploadPrimaryServerAddr> upload-path <SwMngt::pmFileUploadPath> interval-type
<SwMngt::pmFileUploadIntervalType> [ no auto-upload | auto-upload <SwMngt::pmFileAutoUpload> ] [ no
retry-num | retry-num <SwMngt::pmFileUploadRetryNum> ] [ no max-delay | max-delay
<SwMngt::pmFileUploadMaxDelay> ] )
Command Parameters
Table 12.31-1 "PM File Upload Configure Command" Resource Parameters
Resource Identifier Type Description
(upload-index) Format: the unique internal identifier of
- the unique internal identifier of PM file upload entry PM file upload entry
(1-VOICE, 2-DSL)
- range: [1...2]
Table 12.31-2 "PM File Upload Configure Command" Command Parameters
Parameter Type Description
pri-server-addr Parameter type: mandatory parameter
<SwMngt::pmFileUploadPrimaryServerAddr> IP address of the primary SFTP
Format: file server
- IPv4-address
upload-path Parameter type: <SwMngt::pmFileUploadPath> mandatory parameter
Format: the path to be addressed for PM
- the path to be addressed for PM file upload, must not start file upload, must not start with '/'
with '/' but must end with a '/' but must end with a '/'
- length: x<=127
interval-type Parameter type: <SwMngt::pmFileUploadIntervalType> mandatory parameter
Format: the type of interval to be used to
( 15-min transfer the PM counters
| 24-hour )
Possible values:
- 15-min : PM counters collected based on the 15-min
interval
- 24-hour : PM counters collected based on the 1-day
Command Description
By using this command, upstream traffic from any peripheral attached to the management port on the system will
be filtered at mac level.
The filter is implemented using a white-list of 20 MAC ranges, with each begin and end MAC address having the
same OUI. (Original manufacturer Unique Identifier, covering the 3 most significant bytes)
On the NRCD-B the filter is a filter on the destination mac address of the frames received over this port.
On other cards/systems, such as the NRCD-C and the 7363 ISAM MX, 7367 ISAM SX-16F the filter is a filter on
the source mac address of the frames received over this port.
Mac filter entry possibilities
- 1:32 consecutive MAC addresses
- range xx:xx:xx:xx:xx:00-xx:xx:xx:xx:xx:ff
- range xx:xx:xx:xx:00:00-xx:xx:xx:xx:ff:ff
- range xx:xx:xx:00:00:00-xx:xx:xx:ff:ff:ff
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system security peripheral-mgnt mac-filter (index-num) [ no filter | filter <Sys::PeriphMacFilter> ]
Command Parameters
Table 12.32-1 "MAC Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(index-num) Format: filter number
- Filter rule number
- range: [1...20]
Table 12.32-2 "MAC Filter Configuration Command" Command Parameters
Parameter Type Description
[no] filter Parameter type: <Sys::PeriphMacFilter> optional parameter with default
Format: value: "00 : 00 : 00 : 00 : 00 :
( any - any 00-00 : 00 : 00 : 00 : 00 : 00"
| <Sys::MacAddr> - <Sys::MacAddr> ) specifies to MAC addresses to be
Possible values: matched with the packet
- any : all source MAC address
Field type <Sys::MacAddr>
Description
This chapter gives an overview of nodes that are handled by "Secure Shell Configuration Commands".
Command Tree
----configure
----system
----security
----ssh
----server-profile
- [no] server-retries
- [no] idle-timeout
- [no] dis-hmac-sha-1
- [no] dis-hmac-sha-1-96
- [no] dis-aes
- [no] dis-des-3
- [no] dis-blowfish
- [no] dis-des-56
----[no] user
- (name)
- key
----access
- [no] protocol
- [no] cli
- [no] tl1
- [no] debug
----sftp-user
- (username)
- password
Command Description
This command configures the SSH Server parameters like maximum number of server retries, idle timeout,
authentiation and encryption algorithm to be used
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 13.2-2 "SSH Server Configuration Command" Command Parameters
Parameter Type Description
[no] server-retries Parameter type: <SSH::ServerRetries> optional parameter with default
Format: value: 3
- maximum number of attempts can be tried maximum number of attempts
- range: [1...3] can be tried
[no] idle-timeout Parameter type: <SSH::ServerIdleTimeOut> optional parameter with default
Format: value: 1800
- maximum idle time allowed maximum idle time allowed
- unit: sec
- range: [0...1800]
[no] dis-hmac-sha-1 Parameter type: boolean optional parameter
disable hma-sha-1 authentication
[no] dis-hmac-sha-1-96 Parameter type: boolean optional parameter
disable hma-sha-1-96
authentication
[no] dis-aes Parameter type: boolean optional parameter
disable aes encryption
[no] dis-des-3 Parameter type: boolean optional parameter
disable 3des encryption
[no] dis-blowfish Parameter type: boolean optional parameter
disable blowfish encryption
[no] dis-des-56 Parameter type: boolean optional parameter
disable des-56 encryption
Command Description
This command is used to configure a client (user, operator) who is authorised to manage the system in a secure
way and choosing the public key authentication (as opposed to password authentication)method. A maximum of 10
such users can be configured. As parameters, the command requires a client user name and the corresponding
public key. The public key is generated by the user using e.g. ssh-keygen (Unix), PuTTYgen (PC), etc.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system security ssh ( no user (name) ) | ( user (name) [ key <SSH::SshClientPublicKey> ] )
Command Parameters
Table 13.3-1 "Secure Shell User Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: unique index to the table
- unique index to the table
- length: 1<=x<=11
Table 13.3-2 "Secure Shell User Configuration Command" Command Parameters
Parameter Type Description
key Parameter type: <SSH::SshClientPublicKey> optional parameter
Format: public string of the client
- user public key to be stored
- length: 1<=x<=1200
Command Description
This command allows the operator to enable and disable the remote management access channels like TL1,CLI and
debug.
This command allows also configuration of file transfer protocol.
Options for cli
1. ssh - enables only CLI/SSH and disables CLI/TELNET
2. telnet - enables only CLI/TELNET and disables CLI/SSH
3. telnet-ssh - enables both CLI/SSH and CLI/TELNET
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system security ssh access [ no protocol | protocol <SwMngt::FileTransferProtocolType> ] [ no cli | cli
<SSH::ChannelCLISSH> ] [ no tl1 | tl1 <SSH::ChannelTL1SSH> ] [ no debug | debug
<SSH::ChannelDebugUDP> ]
Command Parameters
Table 13.4-2 "Secure Shell Access Configuration Command" Command Parameters
Parameter Type Description
[no] protocol Parameter type: <SwMngt::FileTransferProtocolType> optional parameter with default
Format: value: "tftp"
( tftp the protocol that is to be used for
| ftp file transfer
| sftp )
Possible values:
- tftp : the tftp protocol is selected for file transfer
- ftp : the ftp protocol is selected for file transfer
- sftp : the sftp protocol is selected for file transfer
[no] cli Parameter type: <SSH::ChannelCLISSH> optional parameter with default
Format: value: "telnet-ssh"
( ssh enable/disable cli over ssh or
| telnet telnet
| telnet-ssh )
Possible values:
- ssh : enable only cli over ssh
- telnet : enable only cli over telnet
- telnet-ssh : enable both cli over ssh and telnet
[no] tl1 Parameter type: <SSH::ChannelTL1SSH> optional parameter with default
Format: value: "udp-ssh-telnet"
( none enable/disable tl1 over ssh, telnet,
| ssh or udp
| telnet
| udp
| udp-ssh
| udp-telnet
| ssh-telnet
| udp-ssh-telnet )
Possible values:
- none : disable tl1 over ssh/telnet/udp
- ssh : enable only tl1 over ssh
- telnet : enable only tl1 over telnet
- udp : enable only tl1 over udp
- udp-ssh : enable both tl1 over ssh and udp
- udp-telnet : enable both tl1 over udp and telnet
- ssh-telnet : enable both tl1 over ssh and telnet
- udp-ssh-telnet : enable tl1 over udp, ssh and telnet
[no] debug Parameter type: <SSH::ChannelDebugUDP> optional parameter with default
Format: value: "udp"
( none enable/disable debug
| udp )
Possible values:
- none : disable debug ports
- udp : enable debug over udp
Command Description
The system acts as an SFTP client towards an external SFTP server. This command allows the operator to
configure the user name and password the system should use towards the external SFTP server.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 13.5-2 "Secure Shell SFTP User Configuration Command" Command Parameters
Parameter Type Description
(username) Format: optional parameter
- specifies sftp user name to be used user name used when ISAM acts
- length: x<=32 as SFTP client
password Parameter type: <SSH::SftpPassword> optional parameter
Format: password used when ISAM acts
( prompt as SFTP client
| plain : <SSH::SftpPassword>
| encrypted : <SSH::SftpEncryptedPassword> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
- encrypted : the encrypted password
Field type <SSH::SftpPassword>
- sftp password
- length: 6<=x<=32
Field type <SSH::SftpEncryptedPassword>
- sftp encrypted password
- length: 23<=x<=95
Description
This chapter gives an overview of nodes that are handled by "Transaction Configuration Commands".
Command Tree
----configure
----system
----transaction
- [no] time-out-value
- log-full-action
Command Description
This command allows the operator to configure transaction parameters.
User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 14.2-2 "Transaction Configuration Command" Command Parameters
Parameter Type Description
[no] time-out-value Parameter type: <Trans::TimeoutValue> optional parameter with default
Format: value: 6000
( indefinite set the timeout for transaction
| <Trans::TimeoutValue> )
Possible values:
- indefinite : indefinite timeout value
Field type <Trans::TimeoutValue>
- timeout of the transaction
- unit: 1/100 sec
- range: [6000...360000]
log-full-action Parameter type: <Trans::logFullaction> optional parameter
Format: set action to be taken when the
( wrap log is full
| halt )
Possible values:
- wrap : older log records are overwritten by recent ones
- halt : logging is stopped until the log buffer is reset
Description
This chapter gives an overview of nodes that are handled by "SYSLOG Configuration Commands".
Command Tree
----configure
----system
----syslog
----[no] destination
- (name)
- type
- [no] disable
- [no] upload-rotate
----[no] route
- (name)
- msg-type
- facility
- [no] emergency
- [no] alert
- [no] critical
- [no] error
- [no] warning
- [no] notice
- [no] information
- [no] debug
Command Description
This command allows the operator to configure a syslog destination. Log messages can be sent to a file or, for
rotated files, to a file on a designated upload server (file:), a remote server (udp:), all logged in CLI-users (all-cli)
or all logged in TL1-users (all-tl1) or both (all-users).
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system syslog ( no destination (name) ) | ( destination (name) type <Sys::ServerType> [ [ no ] disable ]
[ [ no ] upload-rotate ] )
Command Parameters
Table 15.2-1 "SYSLOG Destination Configuration command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the syslog destination
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 15.2-2 "SYSLOG Destination Configuration command" Command Parameters
Parameter Type Description
type Parameter type: <Sys::ServerType> mandatory parameter
Format: destination type
( file : <Sys::ServName> : <Sys::FileSize>
| remote-file : <Ip::V4Address> : <Sys::UploadPathName> :
<Sys::ServName> : <Sys::FileSize>
| udp : <Ip::V4Address> : <Sys::NetworkPort> : unlimited
| udp : <Ip::V4Address> : <Sys::NetworkPort> :
<SYS::MaxRate>
| all-cli
| all-tl1
| all-users )
Possible values:
- file : file in which logs to be stored
- remote-file : remote file in which logs to be stored
- udp : log messages to the destination
- all-cli : cli users terminal logging
- all-tl1 : tl1 users terminal logging
- all-users : all cli and tl1 users
Command Description
This command allows an operator to configure which messages must be sent to a given syslog destination and to
assign the appropriate syslog parameters to them.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure system syslog ( no route (name) msg-type <Sys::MessageType> ) | ( route (name) msg-type
<Sys::MessageType> facility <Sys::LogFacility> [ [ no ] emergency ] [ [ no ] alert ] [ [ no ] critical ] [ [ no ] error ]
[ [ no ] warning ] [ [ no ] notice ] [ [ no ] information ] [ [ no ] debug ] )
Command Parameters
Table 15.3-1 "SYSLOG Route Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the destination where
- a profile name messages must be sent to
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
msg-type Parameter type: <Sys::MessageType> type of the message to be routed
Format:
( all
| authentication
| cli-config-chgs
| tl1-config-chgs
| cli-msgs
| tl1-msgs
| tracing1
| tracing2
| tracing3
| video-cdr
| eqpt
| li-config-chgs
| omci
| docsis )
Possible values:
- all : messages of any type
- authentication : authentication messages
- cli-config-chgs : cli commands
- tl1-config-chgs : tl1 commands
Description
This chapter gives an overview of nodes that are handled by "PCCP Configuration Commands".
Command Tree
----configure
----pccp
- [no] module-status
----[no] group
- (groupid)
- [no] admin-state
- [no] ping-interval
- ping-dest-ipaddr
- [no] switchover
----[no] ports-list
- (port)
Command Description
This command allows the operator to enable/disable the Path Connectivity Check Protection feature.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 16.2-2 "SHub PCCP Module Configuration Command" Command Parameters
Parameter Type Description
[no] module-status Parameter type: <Shub::ModulStatus> optional parameter with default
Format: value: "disable"
( enable path connectivity check
| disable ) protection status
Possible values:
- enable : enable the path connectivity check protection
feature
- disable : disable the path connectivity check protection
feature
Command Description
This command allows the operator to configure the Path Connectivity Check Protection feature parameters.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
> configure pccp ( no group (groupid) ) | ( group (groupid) [ no admin-state | admin-state <Shub::AdminState> ] [
no ping-interval | ping-interval <Shub::PingInterval> ] ping-dest-ipaddr <Ip::V4Address> [ no switchover |
switchover <Shub::SwitchOver> ] )
Command Parameters
Table 16.3-1 "SHub PCCP Group Entry Configuration Command" Resource Parameters
Resource Identifier Type Description
(groupid) Format: path connectivity check
- pccp identifier number protection group identifier
- range: [1...4]
Table 16.3-2 "SHub PCCP Group Entry Configuration Command" Command Parameters
Parameter Type Description
[no] admin-state Parameter type: <Shub::AdminState> optional parameter with default
Format: value: "disable"
( enable path connectivity check
| disable ) protection at group level
Possible values:
- enable : enable the path connectivity check protection at
group level
- disable : disable the path connectivity check protection at
group level
[no] ping-interval Parameter type: <Shub::PingInterval> optional parameter with default
Format: value: "5"
- time interval between 2 pings time interval between 2
- unit: seconds pings(0...60)
- range: [0...60]
ping-dest-ipaddr Parameter type: <Ip::V4Address> mandatory parameter
Format: destination IP address of the ping
- IPv4-address check
Command Description
This command allows the operator to specify network ports that should transmit packets for PCCP Group as
untagged.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 16.4-1 "SHub Static network Port for PCCP Group Configuration Command" Resource
Parameters
Resource Identifier Type Description
(groupid) Format: path connectivity check
- pccp identifier number protection group identifier
- range: [1...4]
(port) Format: the pccp network port
network : <Shub::NetworkPort>
Possible values:
- network : network port
Field type <Shub::NetworkPort>
- network port on Shub
Description
This chapter gives an overview of nodes that are handled by "Software Management Configuration Commands".
Command Tree
----configure
----software-mngt
----oswp
- (index)
- primary-file-server-id
- second-file-server-id
X download-set
X autofetch
- [no] activate
----database
- [no] activate
- [no] backup
- [no] auto-backup-intvl
Introduction
The Overall Software Package (OSWP) can be in any one of the following states: operational, aborting,
downloading, enabled, disabled, activated, and committed. The operator can perform such functions as download
the OSWP or set of files, abort its download, or enable or disable its autofetch property. The operator can also
specify primary and secondary TFTP-server IDs for downloading the database.
The operator can also configure the download set or the set of files that are needed before triggering activation.
Abort an OSWP
The manager can abort an OSWP when the system has two OSWPs. The state of the first OSWP is
Enabled/Active/Committed while the second OSWP is in one of the following three states:
Enabled/NotActive/UnCommitted, Downloading/NotActive/UnCommitted, or Disabled/NotActive/UnCommitted.
The management channel between the system and the manager is established and the system is not involved in any
other software download process.
The manager requests that the system remove the NotActive/UnCommitted OSWP. The system removes all the
persistent stored files and databases not related to the Enabled/Active/Committed OSWP. The state of the OSWP to
be removed is Aborting/NotActive/UnCommitted during the complete removal operation.
After a successful abort, the system has only one OSWP. The state of this OSWP is Enabled/Active/Committed.
Only files and databases related to this OSWP are stored persistently in the system.
state of the second OSWP is Enabled/NotActive. The management channel between the system and the manager is
established and the system is not involved in another software download process.
The manager requests that the system activates the Enabled/NotActive OSWP. In case the manager requests to
activate with linked database, the system first selects an available database that is compatible with and linked to the
Enabled/NotActive OSWP. In case the manager requests to activate with default database, the system creates a
default database that is compatible with the Enabled/NotActive OSWP. The system then starts the activation
process of the NotActive OSWP.
The activation can happen on active NT or on standby NT. Activation on standby NT is only possible in case the
redundant NT board is equipped and hot standby and the NT board type supports it. In case the conditions to do the
activation on standby NT are fulfilled, the system will select this option. In case these conditions are not fulfilled
the system will select activation on active NT.
Finally, after the successful activation of the Not-active OSWP, the system has two OSWPs. The previous
Not-active OSWP is now active, together with the selected compatible database. Also, the previous Active OSWP
is still available, but NotActive. In case the activation was done on standby NT, the standby NT from before the
activation will be the active NT after the activation.
Commit an OSWP
To commit an OSWP, the system requires two OSWPs. The state of the first OSWP is
Enabled/Active/UnCommitted and the state of the second OSWP is Enabled/NotActive/Committed.
The manager requests that the system commit the active OSWP. The system removes all the persistent stored files
and databases that do not belong to the Enabled/Active OSWP. The state of the OSWP to be committed is
Enabled/Active/Committing during the complete commit operation.
Finally, after a successful commit process, the system has only one OSWP. The state of this OSWP is
Enabled/Active/Committed. Only files related to this OSWP are stored persistently in the system.
Command Description
This command allows the operator to configure various OSWP attributes and parameters.
User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 17.2-1 "Software Management Overall Software Package Configuration Command"
Resource Parameters
Resource Identifier Type Description
(index) Format: index to the swm oswp table
Command Description
This command configure database automatic activation and automatic backup states and attributes.
User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 17.3-2 "Database Automatic Activation Configure Command" Command Parameters
Parameter Type Description
[no] activate Parameter type: <SwMngt::DbAutoAct> optional parameter with default
Format: value: "manually"
( after-download determines when to active
| manually ) database
Possible values:
- after-download : enable the automatic activation of
database after downloading
- manually : manually activate the OSWP
[no] backup Parameter type: <SwMngt::DbAutoBackup> optional parameter with default
Format: value: "manually"
( manually backup destination of database
| activate : <Ip::V4Address> : <SwMngt::dbpath> )
Possible values:
- manually : manually backup of the database
- activate : automatic backup of the database
Field type <Ip::V4Address>
- IPv4-address
Field type <SwMngt::dbpath>
- path for the db (example: /path_to_db)
- range: [a-zA-Z0-9-_./]
- length: x<=255
[no] auto-backup-intvl Parameter type: <SwMngt::DbAutoBackIntvl> optional parameter with default
Format: value: 24
- the interval period for automatic backup the interval period for automatic
Description
This chapter gives an overview of nodes that are handled by "Ethernet Configuration Commands".
Command Tree
----configure
----transport
----X ip
- default-ttl
----shub
----X [no] mac-filter
- (index-num)
- [no] protocol-type
- filter
- vlan-id
- [no] action-drop
----X [no] in-port
- (port)
----[no] mac-infilter
- (index-num)
- port
- [no] protocol-type
- filter
- vlan-id
- [no] action-drop
----rate-limit
- (ctrl-index)
- [no] lookup-enabled
- [no] bcast-pkt-enabled
- [no] mcast-pkt-enabled
- max-nbr-pkts
Command Description
Obsolete command, replaced by configure system management default-ttl.
This command allows the operator to configure the Ethernet IP.The parameters are configured to forwarding or
not forwarding of the datagrams, along with whether the TTL value has been provided by the transport layer.
The default value inserted into the Time-To-Live field of the IP header of datagrams originated at this entity,
whenever a TTL value is not supplied by the transport layer protocol. The indication of whether this entity is acting
as an IP router in respect to the forwarding of datagrams received by, but not addressed to, this entity. IP routers
forward datagrams, IP hosts do not.
User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 18.2-2 "Ethernet IP Configuration Command" Command Parameters
Parameter Type Description
default-ttl Parameter type: <Ip::TTL> optional parameter
Format: default value for time-to-live
- time-to-live value of IP-header field of IP header
- range: [1...255]
Command Description
Obsolete command, replaced by configure transport shub mac-infilter (index-num) port.
By using this command traffic from an LT can be filtered but not from an individual DSL port.
User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 18.3-1 "SHub Ethernet MAC Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(index-num) Format: L2 Filter rule number
- Filter rule number
- range: [1...65535]
Table 18.3-2 "SHub Ethernet MAC Filter Configuration Command" Command Parameters
Parameter Type Description
[no] protocol-type Parameter type: <Sys::ProtocolType> optional parameter with default
Format: value: 0
- message protocol type specifies the non IP protocol type
- range: [0,1536...65535] to be filtered
filter Parameter type: <Sys::MacFilter> mandatory parameter
Format: specifies to MAC addresses to be
( any - any matched with the packet
| any - <Sys::MacAddr>
| <Sys::MacAddr> - any
| <Sys::MacAddr> - <Sys::MacAddr> )
Possible values:
- any : all source MAC address
Field type <Sys::MacAddr>
- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Command Description
Obsolete command, replaced by configure transport shub mac-infilter (index-num) port.
This command allows the operator to limit the filter to only the traffic coming from one specific port.
This command allows traffic from an LT to be filtered, but not from an individual DSL port.
By using this command, traffic from an LT can be filtered but not from an individual DSL port.
User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.
Command Syntax
The command has the following syntax:
> configure transport shub mac-filter (index-num) ( no in-port (port) ) | ( in-port (port) )
Obsolete command, replaced by configure transport shub mac-infilter (index-num) port.
Command Parameters
Table 18.4-1 "SHub Ethernet MAC Filter Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) Format: L2 Filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the port number
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex> )
Possible values:
- lt : line board
- network : network port
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
Command Description
By using this command traffic from an LT can be filtered but not from an individual DSL port.
User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.
Command Syntax
The command has the following syntax:
> configure transport shub ( no mac-infilter (index-num) port <Shub::InDataPort> ) | ( mac-infilter (index-num)
port <Shub::InDataPort> [ no protocol-type | protocol-type <Sys::ProtocolType> ] filter <Sys::MacFilter> [ vlan-id
<Sys::FilterVlanId> ] [ [ no ] action-drop ] )
Command Parameters
Table 18.5-1 "SHub Ethernet MAC Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(index-num) Format: L2 Filter rule number
- Filter rule number
- range: [1...65535]
port Parameter type: <Shub::InDataPort> the port number
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| all
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : line board
- network : network port
- all : apply to all ports
- nt : active nt slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
Command Description
This command allows the operator to configure the rate limit.
User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 18.6-1 "SHub Ethernet Rate Configuration Command" Resource Parameters
Resource Identifier Type Description
(ctrl-index) Format: control index of the rate
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Table 18.6-2 "SHub Ethernet Rate Configuration Command" Command Parameters
Parameter Type Description
[no] lookup-enabled Parameter type: boolean optional parameter
enable this status
[no] bcast-pkt-enabled Parameter type: boolean optional parameter
enable this status
[no] mcast-pkt-enabled Parameter type: boolean optional parameter
enable this status
max-nbr-pkts Parameter type: <Sys::RateCtrlLimit> optional parameter
Format: maximum number of DLF,MC
- max nbr of packets transmitted on this interface and BC packets on an
Description
This chapter gives an overview of nodes that are handled by "QoS Configuration Commands".
Command Tree
----configure
----qos
- [no] atm-overhead-fact
- [no] eth-efm-fact
- [no] enable-alignment
- [no] cac-mode
- [no] use-dei
- [no] set-dei
----tc-map-dot1p
- (index)
X queue
- tc
- dpcolor
- policer-color
----dsl-ctrl-pkt-policer
- [no] sustained-rate
- [no] burst-size
- [no] protocol-ctrl
----nni-ctrl-pkt-policer
- [no] sustained-rate
- [no] burst-size
----dscp-map-dot1p
- (index)
- dot1p-value
----profiles
----[no] queue
- (name)
- (bac-complex-type)
- [no] unit
----[no] scheduler-node
- (name)
- priority
- weight
- shaper-profile
- [no] ext-shaper
- [no] mcast-inc-shape
----[no] cac
- (name)
- res-voice-bandwidth
- max-mcast-bandwidth
- res-data-bandwidth
- [no] cac-type
----marker
----[no] d1p
- (name)
- default-dot1p
----[no] dscp
- (name)
- default-dscp
- [no] alignment
----[no] dscp-contract
- (name)
- [no] alignment
----codepoint
- (codepoint)
- [no] dscp-value
----[no] d1p-dscp-contract
- (name)
- dot1p-value
X [no] alignment
----codepoint
- (codepoint)
- [no] dscp-value
----[no] d1p-dscp
- (name)
- default-dscp
- default-dot1p
----[no] d1p-alignment
- (name)
- (alignment)
- [no] dscp-pbit-prof
----[no] dot1p-remark
- (name)
----dot1p-value
- (dot1p-value)
- [no] remark-value
----[no] policer
- (name)
- committed-info-rate
- committed-burst-size
- [no] policer-type
- [no] excess-info-rate
- [no] excess-burst-size
- [no] coupling-flag
- [no] color-mode
- [no] green-action
- [no] yellow-action
- [no] red-action
- [no] policed-size-ctrl
- [no] peak-info-rate
- [no] peak-burst-size
- [no] cos-threshold
----[no] l2-filter
- (name)
- [no] dst-mac-addr
- [no] src-mac-addr
- [no] ethertype
- [no] dot1p-priority
- [no] canonical-format
- [no] vlan-id
----[no] l3-filter
- (name)
- [no] filter-type
- [no] dst-ip-addr
- [no] src-ip-addr
- [no] dst-ipv6-addr
- [no] src-ipv6-addr
- [no] min-dst-port
- [no] max-dst-port
- [no] min-src-port
- [no] max-src-port
- [no] dscp-value
- [no] protocol
----[no] policy-action
- (name)
- [no] dscp-value
- [no] dot1p-value
- [no] discard-packet
- [no] shared-policer
- [no] policer-profile
----[no] policy
- (name)
- filter
- [no] precedence
- [no] policy-action
----[no] session
- (name)
- logical-flow-type
- [no] up-policer
- [no] down-policer
- [no] up-marker
- [no] ing-outer-marker
----[no] up-policy
- (name)
----[no] down-policy
- (name)
----[no] shaper
- (name)
- committed-info-rate
- committed-burst-size
- [no] excess-info-rate
- [no] type
- [no] autoshape
----[no] bandwidth
- (name)
- committed-info-rate
- assured-info-rate
- excessive-info-rate
- [no] delay-tolerance
- [no] assu-burst-size
- [no] exce-burst-size
----[no] ingress-qos
- (name)
- [no] dot1-p0-tc
- [no] dot1-p1-tc
- [no] dot1-p2-tc
- [no] dot1-p3-tc
- [no] dot1-p4-tc
- [no] dot1-p5-tc
- [no] dot1-p6-tc
- [no] dot1-p7-tc
- [no] use-dei
- [no] dot1-p0-color
- [no] dot1-p1-color
- [no] dot1-p2-color
- [no] dot1-p3-color
- [no] dot1-p4-color
- [no] dot1-p5-color
- [no] dot1-p6-color
- [no] dot1-p7-color
- [no] dot1-p0-pol-tc
- [no] dot1-p1-pol-tc
- [no] dot1-p2-pol-tc
- [no] dot1-p3-pol-tc
- [no] dot1-p4-pol-tc
- [no] dot1-p5-pol-tc
- [no] dot1-p6-pol-tc
- [no] dot1-p7-pol-tc
----[no] rate-limit
- (name)
- [no] total-rate
- [no] total-burst
- [no] arp-rate
- [no] arp-burst
- [no] dhcp-rate
- [no] dhcp-burst
- [no] igmp-rate
- [no] igmp-burst
- [no] pppoe-rate
- [no] pppoe-burst
- [no] nd-rate
- [no] nd-burst
- [no] icmpv6-rate
- [no] icmpv6-burst
- [no] mld-rate
- [no] mld-burst
- [no] dhcpv6-rate
- [no] dhcpv6-burst
- [no] cfm-rate
- [no] cfm-burst
----[no] dscp-pbit
- (name)
----codepoint
- (codepoint)
- dot1p-value
----[no] cos-threshold
- (name)
- [no] tc0-threshold
- [no] tc1-threshold
- [no] tc2-threshold
- [no] tc3-threshold
- [no] tc4-threshold
- [no] tc5-threshold
- [no] tc6-threshold
- [no] tc7-threshold
----global
- (index)
- [no] buffer-occ-thresh
- [no] queue-stats
- [no] dsload-tca
- [no] dsload-thresh
- [no] buffer-tca
- [no] up-buf-thresh
- [no] up-obc-thresh
- [no] dn-obc-thresh
- [no] dn-buf-thresh
- [no] part-buf-thresh
----tca
- (index)
- queue
- [no] tca-enable
- [no] load-thresh
- [no] dis-frame-th
----X dsl-port
- (index)
- [no] scheduler-profile
- cac-profile
----X queue
- (queue)
- queue-profile
----X shdsl-port
- (index)
- scheduler-profile
- cac-profile
----X queue
- (queue)
- queue-profile
----interface
- (index)
- [no] scheduler-node
- [no] ingress-profile
- [no] cac-profile
- [no] ext-cac
- [no] ds-queue-sharing
- [no] us-queue-sharing
- [no] ds-num-queue
- [no] ds-num-rem-queue
- [no] us-num-queue
- [no] queue-stats-on
- [no] autoschedule
- oper-weight
- oper-rate
- [no] us-vlanport-queue
- [no] dsfld-shaper-prof
- [no] gem-sharing
----queue
- (queue)
- priority
- weight
- oper-weight
- queue-profile
- shaper-profile
----upstream-queue
- (queue)
- [no] priority
- [no] weight
- [no] bandwidth-profile
- [no] ext-bw
- [no] bandwidth-sharing
- [no] queue-profile
- [no] shaper-profile
----ds-rem-queue
- (queue)
- [no] priority
- [no] weight
----shub
----tc-map-dot1p
- (tc-priority)
- traffic-class
----queue-config
- (port)
- [no] queue0-weight
- [no] queue1-weight
- [no] rx-pause
- [no] egress-rate
- [no] dscp2p-enable
----dscp-map-dot1p
- (dscp-index)
- dot1p-value
----[no] flow
- (index)
- [no] name
X (old-type)
- [no] type
----[no] policer
- (port-id)
- flow
- meter
----[no] meter
- (index)
- [no] name
- max-ingress-rate
- burst-size
----[no] ctrl-pkt-policer
- (protocol-id)
- [no] sustained-rate
- [no] burst-size
----pbit-scheduling
- [no] sc-xcon-us
- [no] sc-xcon-dn
- [no] sc-rb-us
- [no] sc-rb-dn
----upstr-prot-dsl
- [no] enable
Command Description
This command allows the operator to specify global QoS parameters.
The ATM overhead factor is used to calculate ATM bandwidth required by streams for which bandwidth
parameters are specified as Ethernet bandwidth. The ATM overhead factor specifies in terms of percentage what
part of a given raw ATM bit rate will be available for Ethernet frames. The default value is 85%, which means a
typical overhead of 15% for ATM/AAL5. QoS management will use this value to deduct the available Ethernet rate
on ATM-based DSL interfaces.
The Eth EFM overhead factor is used to calculate EFM bandwidth required by streams for which bandwidth
parameters are specified as Ethernet bandwidth. The Eth EFM overhead factor specifies in terms of percentage
what part of a given raw EFM bit rate will be available for Ethernet frames. The default value is 97%, which
means a typical overhead of 3% for EFM Encapsulation.
The enable alignment is used to enable or disable the DSCP to P-bits alignment for all the L3 forwarded traffic.
The Global CAC-mode selection switch determines whether Connection Admission Control relies on the
guaranteed sync rate or the actual line rate of the physical interface.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.2-2 "QoS Configuration Command" Command Parameters
Parameter Type Description
[no] atm-overhead-fact Parameter type: <Qos::AtmFactor> optional parameter with default
Format: value: 85
- over head factor introduced by atm layer over head factor introduced by
- unit: % atm layer
- range: [1...100]
[no] eth-efm-fact Parameter type: <Qos::EthEfmFactor> optional parameter with default
Format: value: 97
- value to estimate bandwidth overhead inserted by efm value to estimate bandwidth
layer overhead inserted by efm layer
- unit: %
- range: [1...100]
[no] enable-alignment Parameter type: boolean optional parameter
DSCP to P-bit alignment for all
Command Description
This command allows the operator to configure the downstream traffic class mapping table. This table defines
which 802.1P codepoint is cast to which egress buffer on the L3 units.
There is a second class to the queue mapping table on the SHub/IHub, but this class is independent from the
configuration perspective of this table. (See the traffic class configuration section for more information.) The
second class is used mainly for upstream traffic segregation into egress buffers on the SHub/IHub.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.3-1 "QoS 802.1P Class-to-Queue Mapping Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: value of 802.1p field
- value of 802.1p field
- range: [0...7]
Table 19.3-2 "QoS 802.1P Class-to-Queue Mapping Configuration Command" Command
Parameters
Parameter Type Description
queue Parameter type: <Qos::Queues> obsolete parameter replaced by
Format: parameter "tc"
- output dsl/gpon/epon port queue number output dsl port queue number
- range: [0...7,255]
tc Parameter type: <Qos::QosTrafficClass> optional parameter
Format: the traffic class number
- the traffic class number
- range: [0...7]
dpcolor Parameter type: <Qos::Color> optional parameter
Format: output discard precedence on
( green queue
| yellow )
Command Description
This command allows the operator to configure a upstream QoS Dsl Control Packet Policer.This control packet
policer serves to prevent DoS attacks from subscriber premises against the control plane of the ISAM. The policing
parameters that can be configured are the sustainable rate in packets/sec and the maximum burst size in packets.
Control packets arriving at a higher rate then the sustainable rate are dropped by the policer.
Control packets arriving in a longer burst then the maximum burst size are dropped by the policer.
Control packets are packets directed to the LSM itself or inserted by the LSM. The control packet protocol type
depends on the applied forwarding model, and can be 802.1x, ARP, RIP, DHCP, IGMP, PPPoEDiscovery , PPP
LCP, PPP control, PPP LCP termination acknowledgement. Policing is not applied on control packets inserted by
the LSM.
This command allows the operator to control the DSL line level control packet policer (enable or disable) for
control protocol packets that remains in the data plane. And this feature is supported only for ARP and RIP
protocol.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.4-2 "QoS Dsl Control Pkt Policer Configuration Command" Command Parameters
Parameter Type Description
[no] sustained-rate Parameter type: <Qos::SustainedRate> optional parameter with default
Format: value: 15
- the police rate of inc user pkts in pps max sustainable rate in
- range: [1...64] packets/sec
[no] burst-size Parameter type: <Qos::DslCtrlBurstSize> optional parameter with default
Format: value: 10
- the burst size max burst size, in packets
- range: [1...128]
[no] protocol-ctrl Parameter type: <Qos::ControlProtocolPolicerCtrl> optional parameter with default
Format: value: "police-arprip"
( police-arprip DSL control packet policer
| nopolice-arprip ) applicability for control protocol
Command Description
This command allows the operator to configure a upstream QoS Nni Control Packet Policer.This control packet
policer serves to prevent DoS attacks from subscriber premises against the control plane of the ISAM. The policing
parameters that can be configured are the sustainable rate in packets/sec and the maximum burst size in packets.
Control packets arriving at a higher rate then the sustainable rate are dropped by the policer.
Control packets arriving in a longer burst then the maximum burst size are dropped by the policer.
Control packets are packets directed to the LSM itself or inserted by the LSM. The control packet protocol type
depends on the applied forwarding model, and can be 802.1x, ARP, RIP, DHCP, IGMP, PPPoEDiscovery , PPP
LCP, PPP control, PPP LCP termination acknowledgement. Policing is not applied on control packets inserted by
the LSM.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.5-2 "QoS Nni Control Pkt Policer Configuration Command" Command Parameters
Parameter Type Description
[no] sustained-rate Parameter type: <Qos::NniSustainedRate> optional parameter with default
Format: value: 64
- the police rate of inc user pkts in pps max sustainable rate in
- range: [1...256] packets/sec
[no] burst-size Parameter type: <Qos::NniCtrlBurstSize> optional parameter with default
Format: value: 128
- the burst size max burst size, in packets
- range: [1...256]
Command Description
This command allows the operator to configure a DSCP-to-Dot1P Alignment Table for L3 forwarded traffic.This
facility allows DSCP to P-bits alignment without the use of QoS session profiles via configuring a mapping table
with global scope. It is only applied to traffic in interfaces with L3 forwarding.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.6-1 "QoS DSCP-to-Dot1P Alignment for L3 Forwarded Traffic Configuration Command"
Resource Parameters
Resource Identifier Type Description
(index) Format: the DSCP value
- the DSCP value
- range: [0...63]
Table 19.6-2 "QoS DSCP-to-Dot1P Alignment for L3 Forwarded Traffic Configuration Command"
Command Parameters
Parameter Type Description
dot1p-value Parameter type: <Qos::DscpToDot1PAlign> optional parameter
Format: the DOT1P value
- the DOT1P value
- range: [0...7]
Command Description
This command allows the operator to configure a QoS queue profile. A queue profile or buffer acceptance control
(BAC) profile contains configuration information on data plane queues. BAC profiles can be used on the L3 line
cards.
Minimum and Maximum Threshold value for queues are given in packets.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles ( no queue (name) ) | ( queue (name) (bac-complex-type) [ no unit | unit <Qos::Units> ] )
Command Parameters
Table 19.7-1 "QoS Queue Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.7-2 "QoS Queue Profile Configuration Command" Command Parameters
Parameter Type Description
(bac-complex-type) Format: mandatory parameter
( tail-drop : <Qos::MaxThreshold> buffer acceptance control
| red : <Qos::MinThreshold> : <Qos::MaxThreshold> : algorithm
<Qos::DiscardProbability>
| twocolour-taildrop : <Qos::MaxThreshold> :
<Qos::MaxThresholdYellow>
| twocolourred : <Qos::MinThreshold> :
<Qos::MaxThreshold> : <Qos::DiscardProbability> :
<Qos::MinThresholdYellow> :
<Qos::MaxThresholdYellow> : <Qos::DiscardProbYellow>
| gpon-tail-drop : <Qos::MinThreshold> :
<Qos::MaxThreshold>
| threecolour-taildrop : <Qos::MaxThreshold> :
<Qos::MaxThresholdYellow> : <Qos::MaxThresholdRed>
| threecolour-red : <Qos::MinThreshold> :
<Qos::MaxThreshold> : <Qos::DiscardProbability> :
<Qos::MinThresholdYellow> :
<Qos::MaxThresholdYellow> : <Qos::DiscardProbYellow>
Command Description
This command allows the operator to configure a QoS scheduler node profile. The scheduler node profiles contain
configuration settings for the data plane schedulers. These scheduler node profiles are applicable to downstream
schedulers on the L3 line cards. The scheduler node settings on the service hub can be modified separately.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles ( no scheduler-node (name) ) | ( scheduler-node (name) priority <Qos::QosPriority> weight
<Qos::QosWeight> shaper-profile <Qos::QosShaperProfileName> [ no ext-shaper | ext-shaper
<Qos::QosShaperProfileName> ] [ no mcast-inc-shape | mcast-inc-shape <Qos::QosMulticastInclShaping> ] )
Command Parameters
Table 19.8-1 "QoS Scheduler Node Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.8-2 "QoS Scheduler Node Profile Configuration Command" Command Parameters
Parameter Type Description
priority Parameter type: <Qos::QosPriority> mandatory parameter
Format: relative priority of the
- relative priority scheduler-node
- range: [1...8]
weight Parameter type: <Qos::QosWeight> mandatory parameter
Format: relative weight of the
- relative weight scheduler-node
- range: [0...127]
shaper-profile Parameter type: <Qos::QosShaperProfileName> mandatory parameter
Format: the associated shaper profile. For
( none EPON OLT in downstream, this
| name : <Qos::IgnoredQosProfileName> ) profile used for LLID shaper on
Possible values: 1G PON bandwidth.
- none : no profile name to associated
- name : enter profile name to be associated
Command Description
This command allows the operator to configure a connection admission control (CAC) profile. CAC profiles are
used primarily for multicast video admission control. CAC profiles can be attached to subscriber interfaces. The
scope of a CAC profile is a DSL link (and not a PVC), regardless of the number of PVCs on a DSL link.
The system derives the line rate from the physical interfaces and calculates an estimate of the available Ethernet
bandwidth using configurable overhead factors. The line rate taken into account may be the guaranteed sync rate
or the actual line rate in case of DSL, based on a global configuration setting.
From this bandwidth, a part can be reserved for voice and data applications and the remaining part will be kept by
the system as the available bandwidth for multicast video. Only preconfigured multicast streams are considered for
CAC. Note that unicast video (regardless of whether it is premium content or generic Internet streaming video) is
ignored by the CAC function.
The maximum bandwidth that video will occupy can be further confined using the maximum multicast bandwidth
'max-mcast-bandwidth' parameter.
CAC profiles are applicable to line cards, but not to SHub/IHub interfaces.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles ( no cac (name) ) | ( cac (name) res-voice-bandwidth <Qos::BandWidthKBPS>
max-mcast-bandwidth <Qos::BandWidthKBPS> res-data-bandwidth <Qos::BandWidthKBPS> [ no cac-type |
cac-type <Qos::QosCacType> ] )
Command Parameters
Table 19.9-1 "QoS CAC Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.9-2 "QoS CAC Profile Configuration Command" Command Parameters
Parameter Type Description
res-voice-bandwidth Parameter type: <Qos::BandWidthKBPS> mandatory parameter
Format: reserved bandwidth for the voice
- interface bandwidth services
- unit: kbps
- range: [0...2147483647]
max-mcast-bandwidth Parameter type: <Qos::BandWidthKBPS> mandatory parameter
Command Description
This command allows the operator to configure a marker for singleDot1P.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker ( no d1p (name) ) | ( d1p (name) default-dot1p <Qos::ExtVlanSysPrio> )
Command Parameters
Table 19.10-1 "QoS Single Dot1P Marker Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.10-2 "QoS Single Dot1P Marker Configuration Command" Command Parameters
Parameter Type Description
default-dot1p Parameter type: <Qos::ExtVlanSysPrio> mandatory parameter
Format: the default dot-1p bit value to be
- the dot-1p bit value applied on all frames
- range: [0...7]
Command Description
This command allows the operator to configure a marker for a single DSCP.
All IP packets will be marked with the specified DSCP value. This marker type is incompatible with DSCP to P-bits
alignment.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker ( no dscp (name) ) | ( dscp (name) default-dscp
<Qos::DscpToDot1PAlignmentDscpIndex> [ [ no ] alignment ] )
Command Parameters
Table 19.11-1 "QoS Single DSCP Marker Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.11-2 "QoS Single DSCP Marker Configuration Command" Command Parameters
Parameter Type Description
default-dscp Parameter type: <Qos::DscpToDot1PAlignmentDscpIndex> mandatory parameter
Format: the default DSCP value to be
- the DSCP value applied on all frames
- range: [0...63]
[no] alignment Parameter type: boolean optional parameter
enable DSCP to P-bits alignment
Command Description
This command allows the operator to configure a marker for a DSCP contract table. To configure the DSCP
codepoints in the contract table, the command "configure qos profiles marker dscp-contract (name) codepoint
(codepoint)" is to be used.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker ( no dscp-contract (name) ) | ( dscp-contract (name) [ [ no ] alignment ] )
Command Parameters
Table 19.12-1 "QoS DSCP Contract Table Marker Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.12-2 "QoS DSCP Contract Table Marker Configuration Command" Command
Parameters
Parameter Type Description
[no] alignment Parameter type: boolean optional parameter
enable DSCP to P-bits alignment
Command Description
This command allows the operator to configure codepoints in the DSCP contract table. To configure a marker, use
the command "configure qos profiles marker dscp-contract (name)".
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker dscp-contract (name) codepoint (codepoint) [ no dscp-value | dscp-value
<Qos::DscpToDot1PAlignmentDscpIndex> ]
Command Parameters
Table 19.13-1 "QoS DSCP Contract Table Code-point Configuration Command For
DSCP-contract" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
(codepoint) Format: the value of the codepoint
- the number of the DSCP codepoint
- range: [0...63]
Table 19.13-2 "QoS DSCP Contract Table Code-point Configuration Command For
DSCP-contract" Command Parameters
Parameter Type Description
[no] dscp-value Parameter type: <Qos::DscpToDot1PAlignmentDscpIndex> optional parameter with default
Format: value: 0L
- the DSCP value the dscp value to be assigned to
- range: [0...63] the codepoint
Command Description
This command allows the operator to configure a marker for Dot1P and a DSCP contract table. To configure the
DSCP codepoints in the contract table, the command "configure qos profiles marker d1p-dscp-contract (name)
codepoint (codepoint)" is to be used.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker ( no d1p-dscp-contract (name) ) | ( d1p-dscp-contract (name) dot1p-value
<Qos::ExtVlanSysPrio> [ [ no ] alignment ] )
Command Parameters
Table 19.14-1 "QoS Dot1P and DSCP Contract Table Marker Configuration Command" Resource
Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.14-2 "QoS Dot1P and DSCP Contract Table Marker Configuration Command" Command
Parameters
Parameter Type Description
dot1p-value Parameter type: <Qos::ExtVlanSysPrio> mandatory parameter
Format: the default dot-1p bit value to be
- the dot-1p bit value applied on all frames
- range: [0...7]
[no] alignment Parameter type: boolean obsolete parameter that will be
ignored
enable DSCP to P-bits alignment
Command Description
This command allows the operator to configure codepoints for a DSCP contract table. To configure a Dot1P and
DSCP contract table , use the command "configure qos profiles marker d1p-dscp-contract (name)".
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker d1p-dscp-contract (name) codepoint (codepoint) [ no dscp-value | dscp-value
<Qos::DscpToDot1PAlignmentDscpIndex> ]
Command Parameters
Table 19.15-1 "DSCP Contract Table Codepoint Configuration Command For D1p-dscp-contract"
Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
(codepoint) Format: the number of the codepoint
- the number of the DSCP codepoint
- range: [0...63]
Table 19.15-2 "DSCP Contract Table Codepoint Configuration Command For D1p-dscp-contract"
Command Parameters
Parameter Type Description
[no] dscp-value Parameter type: <Qos::DscpToDot1PAlignmentDscpIndex> optional parameter with default
Format: value: 0L
- the DSCP value the dscp value to be assigned to
- range: [0...63] the codepoint
Command Description
This command allows the operator to configure a marker for Dot1P and single DSCP.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker ( no d1p-dscp (name) ) | ( d1p-dscp (name) default-dscp
<Qos::DscpToDot1PAlignmentDscpIndex> default-dot1p <Qos::ExtVlanSysPrio> )
Command Parameters
Table 19.16-1 "QoS Dot1P and Single DSCP Marker Configuration Command" Resource
Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.16-2 "QoS Dot1P and Single DSCP Marker Configuration Command" Command
Parameters
Parameter Type Description
default-dscp Parameter type: <Qos::DscpToDot1PAlignmentDscpIndex> mandatory parameter
Format: the default DSCP value to be
- the DSCP value applied on all frames
- range: [0...63]
default-dot1p Parameter type: <Qos::ExtVlanSysPrio> mandatory parameter
Format: the default dot-1p bit value to be
- the dot-1p bit value applied on all frames
- range: [0...7]
Command Description
This command allows the operator to configure a marker for Dot1P alignment.
Default value for the global DSCP To Dot1P Alignment Table
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker ( no d1p-alignment (name) ) | ( d1p-alignment (name) (alignment) [ no
dscp-pbit-prof | dscp-pbit-prof <Qos::QosDscpToPbitProfileName> ] )
Command Parameters
Table 19.17-1 "QoS Dot1P Alignment Marker Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.17-2 "QoS Dot1P Alignment Marker Configuration Command" Command Parameters
Parameter Type Description
(alignment) Format: mandatory parameter
Command Description
This command allows the operator to configure a marker for a Dot1P Remark table. To configure the Dot1P
Remark value in remark table, the command "configure qos profiles marker dot1p-remark (name) dot1p-value
(val) remark-value (val)" is to be used.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.18-1 "QoS Dot1P Remark Table Marker Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Command Description
This command allows the operator to configure remark dot1p value in the Dot1P Remark table. To configure the
remark value in the Dot1P Remark table, use the command "configure qos profiles marker dot1p-remark (name)
dot1p-value (val) remark-value (val)".
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker dot1p-remark (name) dot1p-value (dot1p-value) [ no remark-value | remark-value
<Qos::ExtVlanSysPrioNc> ]
Command Parameters
Table 19.19-1 "QoS Dot1P Remark Table Dot1p-value Configuration Command For
Dot1P-Remark" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
(dot1p-value) Format: the dot1p value
- the dot-1p bit value
- range: [0...7]
Table 19.19-2 "QoS Dot1P Remark Table Dot1p-value Configuration Command For
Dot1P-Remark" Command Parameters
Parameter Type Description
[no] remark-value Parameter type: <Qos::ExtVlanSysPrioNc> optional parameter with default
Format: value: 8L
- the remarked dot-1p bit value (8 means no change) the remarked dot1p value
- range: [0...8]
Command Description
This command allows the operator to configure a QoS policer profile. A QoS policer profile contains all settings
related to a policer. The ISAM supports single token bucket policers, where the action upon conformance is either
pass or discard.
The L3 line cards units support both upstream and downstream policing. A policer profile can be used within a
QoS session profile for upstream and downstream policing.
The L2 line cards units do not support policing.
The SHub/IHub supports ingress policing, but it does not use policer profiles. See the section about the QoS
Ingress Policing Configuration Command to set up ingress policing on the SHub/IHub.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles ( no policer (name) ) | ( policer (name) committed-info-rate <Qos::CommittedInfoRate>
committed-burst-size <Qos::CommittedBurstSize> [ no policer-type | policer-type <Qos::PolicerType> ] [ no
excess-info-rate | excess-info-rate <Qos::ExcessInfoRate > ] [ no excess-burst-size | excess-burst-size
<Qos::ExcessBurstSize> ] [ no coupling-flag | coupling-flag <Qos::CouplingFlag> ] [ no color-mode | color-mode
<Qos::ColorMode> ] [ no green-action | green-action <Qos::GreenAction> ] [ no yellow-action | yellow-action
<Qos::YellowAction> ] [ no red-action | red-action <Qos::RedAction> ] [ no policed-size-ctrl | policed-size-ctrl
<Qos::PoliceFrameCtrl> ] [ no peak-info-rate | peak-info-rate <Qos::PeakInfoRate> ] [ no peak-burst-size |
peak-burst-size <Qos::PeakBurstSize> ] [ no cos-threshold | cos-threshold <Qos::QosCoSThresholdProfileName> ]
)
Command Parameters
Table 19.20-1 "QoS Policer Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.20-2 "QoS Policer Profile Configuration Command" Command Parameters
Parameter Type Description
committed-info-rate Parameter type: <Qos::CommittedInfoRate> mandatory parameter
Format: committed information rate of a
- information rate policer
- unit: kbps
- range: [0...2147483647]
Command Description
This command allows the operator to configure an L2 filter. The created L2 filter can be reused to build policy
actions based on L2 filtering criteria, inside QoS session profiles.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles ( no l2-filter (name) ) | ( l2-filter (name) [ no dst-mac-addr | dst-mac-addr
<Qos::MacAddrAndMask> ] [ no src-mac-addr | src-mac-addr <Qos::MacAddrAndMask> ] [ no ethertype |
ethertype <Qos::FilterEthernetType> ] [ no dot1p-priority | dot1p-priority <Qos::MatchDot1pValue> ] [ no
canonical-format | canonical-format <Qos::FilterCfi> ] [ no vlan-id | vlan-id <Qos::FilterVlanId> ] )
Command Parameters
Table 19.21-1 "QoS L2 Filter Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.21-2 "QoS L2 Filter Profile Configuration Command" Command Parameters
Parameter Type Description
[no] dst-mac-addr Parameter type: <Qos::MacAddrAndMask> optional parameter with default
Format: value: "00 : 00 : 00 : 00 : 00 :
<Qos::MacAddress> / <Qos::MacPrefixLength> 00/0"
Field type <Qos::MacAddress> destination mac address to be
- a mac-address (example : 01:02:03:04:05:06) matched with the packet
- length: 6
Field type <Qos::MacPrefixLength>
- the mac address prefix length
- range: [0...48]
[no] src-mac-addr Parameter type: <Qos::MacAddrAndMask> optional parameter with default
Format: value: "00 : 00 : 00 : 00 : 00 :
<Qos::MacAddress> / <Qos::MacPrefixLength> 00/0"
Field type <Qos::MacAddress> source mac address to be
- a mac-address (example : 01:02:03:04:05:06) matched with the packet
- length: 6
Field type <Qos::MacPrefixLength>
- the mac address prefix length
- range: [0...48]
Command Description
This command allows the operator to configure an L3 filter. The created L3 filter can be reused to build policy
actions based on L3 filtering criteria, inside QoS session profiles.
DSCP mask is supported with defined L3-filter name with a prefix "DSCPMASKx_", 'x' must be 1~6, which means
treat dscp-value as a last 'x' bits masking -The first 8 characters are UPPER CASE ALPHABETIC = DSCPMASK;
and -The 9 character is NUMERICAL = {1, 2, 3, 4, 5, 6}; and -The 10 character is UNDERSCORE; -the remaining
is configurable.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles ( no l3-filter (name) ) | ( l3-filter (name) [ no filter-type | filter-type <Qos::L3FilterType> ]
[ no dst-ip-addr | dst-ip-addr <Ip::AddressAndMaskFull> ] [ no src-ip-addr | src-ip-addr
<Ip::AddressAndMaskFull> ] [ no dst-ipv6-addr | dst-ipv6-addr <ipv6::PrefixAndLength> ] [ no src-ipv6-addr |
src-ipv6-addr <ipv6::PrefixAndLength> ] [ no min-dst-port | min-dst-port <Qos::L4PortNumber> ] [ no
max-dst-port | max-dst-port <Qos::L4PortNumber> ] [ no min-src-port | min-src-port <Qos::L4PortNumber> ] [ no
max-src-port | max-src-port <Qos::L4PortNumber> ] [ no dscp-value | dscp-value <Qos::MatchDscpValue> ] [ no
protocol | protocol <Qos::Protocol> ] )
Command Parameters
Table 19.22-1 "QoS L3 Filter Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.22-2 "QoS L3 Filter Profile Configuration Command" Command Parameters
Parameter Type Description
[no] filter-type Parameter type: <Qos::L3FilterType> optional parameter with default
Format: value: "ipv4"
( ipv4 The parameter is not visible
| ipv6 ) during modification.
Possible values: L3 Filter type. Indicates to what
- ipv4 : ipv4 kind of ip frames (ipv4 or ipv6)
- ipv6 : ipv6 the L3 filter is applicable.
[no] dst-ip-addr Parameter type: <Ip::AddressAndMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> destination ipv4 address to be
Command Description
This command allows the operator to configure a QoS policy action profile. A QoS policy action contains: discard
packet, set a DSCP value, set a Dot1P value, policing with a policer, policer sharing attribute.
Dot1P and DSCP values are set to frames matched by the filter associated with this policy action.
The forwarding action for the frames matched by the filter can be discard or pass. The default forwarding action is
pass. When the forwarding action is discard, the other policy actions in this entry will not be checked; the frame
will be discarded immediately.
Policy sharing causes multiple QoS subflow with the same policy action profile to share their policer instance, in
case they are set up within the same session profile in the same direction.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles ( no policy-action (name) ) | ( policy-action (name) [ no dscp-value | dscp-value
<Qos::SetDscpValue> ] [ no dot1p-value | dot1p-value <Qos::SetDot1pValue> ] [ [ no ] discard-packet ] [ [ no ]
shared-policer ] [ no policer-profile | policer-profile <Qos::QosPolicerProfileName> ] )
Command Parameters
Table 19.23-1 "QoS Policy Action Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.23-2 "QoS Policy Action Profile Configuration Command" Command Parameters
Parameter Type Description
[no] dscp-value Parameter type: <Qos::SetDscpValue> optional parameter with default
Format: value: -1L
- dscp value set in a matched packet, -1 means no change dscp value set in a matched
- range: [-1...63] packet, -1 means no change
[no] dot1p-value Parameter type: <Qos::SetDot1pValue> optional parameter with default
Format: value: -1L
- dot1p value set in a matched packet, -1 means no change dot1p value set in a matched
- range: [-1...7] packet, -1 means no change
Command Description
This command allows the operator to configure a QoS policy profile. A policy rule groups together a policy
condition (filter) with a set of associated actions. A policy rule contains:
• Filter type (L2 filter or L3 filter)
• L2 or L3 filter
• Precedence of this policy rule
• Policy action
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles ( no policy (name) ) | ( policy (name) filter <Qos::PolicyFilter> [ no precedence |
precedence <Qos::PolicyPrecedence> ] [ no policy-action | policy-action <Qos::QosPolicyActionProfileName> ] )
Command Parameters
Table 19.24-1 "QoS Policy Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.24-2 "QoS Policy Profile Configuration Command" Command Parameters
Parameter Type Description
filter Parameter type: <Qos::PolicyFilter> mandatory parameter
Format: the filter for the policy rule
( l2-name : <Qos::IgnoredQosProfileName>
| l3-name : <Qos::IgnoredQosProfileName> )
Possible values:
- l2-name : refer to a l2 filter
- l3-name : refer to a l3 filter
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Command Description
This commmand allows the operator to configure the QoS session profile. The QoS session profile is the main
building block for conveying user traffic contractual rights and treatment. The QoS session profile is a
"macro"-profile, which consists of individual settings as well as references to smaller profiles.
A QoS session profile is composed of
• a logical flow type,
• a marker profile,
• two policer profiles for up and downstream policing,
• two lists for upstream and downstream policy conditions and actions.
The logical flow type is a legacy parameter which is ignored. Any value is interpreted as "Generic", that is, the
QoS session profile can be attached to any interface. If the QoS session profile contains settings that are not
supported on the interface, then these are silently ignored by the system.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles ( no session (name) ) | ( session (name) logical-flow-type <Qos::LogicalFlowType> [ no
up-policer | up-policer <Qos::QosPolicerProfileName> ] [ no down-policer | down-policer
<Qos::QosPolicerProfileName> ] [ no up-marker | up-marker <Qos::QosMarkerProfileName> ] [ no
ing-outer-marker | ing-outer-marker <Qos::QosMarkerProfileName> ] )
Command Parameters
Table 19.25-1 "QoS Session Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.25-2 "QoS Session Profile Configuration Command" Command Parameters
Parameter Type Description
logical-flow-type Parameter type: <Qos::LogicalFlowType> mandatory parameter
Format: a traffic stream up on which
( generic policy to be made. Important
| pvc note: this mandatory parameter is
| dot-1x-session depreciated. No distinction is
| pvc-vlan-combination made any more between the
| ppp-session different flow types : independent
Command Description
This command allows the operator to configure a list of upstream policies in a QoS session profile. However the
number of these policy rules are hardware dependent.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles session (name) ( no up-policy (name) ) | ( up-policy (name) )
Command Parameters
Table 19.26-1 "QoS Session Upstream Policy List Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
(name) Format: policy profile name applicable
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Command Description
This command allows the operator to configure a list of downstream policies in a QoS session profile.However the
number of these policy rules are hardware dependent.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles session (name) ( no down-policy (name) ) | ( down-policy (name) )
Command Parameters
Table 19.27-1 "QoS Session Downstream Policy List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
(name) Format: policy profile name applicable
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Command Description
This command allows the operator to configure a QoS shaper profile. A QoS shaper profile contains all settings
related to a shaper. The ISAM supports single token bucket shapers. EIR is only applicable if shaper type is
singleTokenBucketGpon. CBS is applicable only if the shaper type is singleTokenBucket.
The L2+ line cards support shaping on queue.
1. GPON supports EIR and CIR. If CBS is non-zero for GPON; CLI will return an error.
2. DSL doesn't support EIR. So if user enters non-zero for EIR for DSL; CLI will return an error.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.28-1 "QoS Shaper Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.28-2 "QoS Shaper Profile Configuration Command" Command Parameters
Parameter Type Description
committed-info-rate Parameter type: <Qos::ShaperCommittedInfoRate> mandatory parameter
Format: committed information rate of a
- committed information rate of a shaper shaper
- unit: kbps
- range: [0...2147483647]
committed-burst-size Parameter type: <Qos::ShaperCommittedBurstSizeNew> mandatory parameter
Format: committed burst size of shaper
- committed burst size of shaper
- unit: byte
- range: [0,64...2147483647]
[no] excess-info-rate Parameter type: <Qos::ShaperExcessiveInfoRate> optional parameter with default
Format: value: 0
Command Description
This command allows the operator to configure a QoS Bandwidth profile. A QoS Bandwidth profile contains
upstream rate enforcement information for frames to which this profile is applied.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.29-1 "QoS Bandwidth Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.29-2 "QoS Bandwidth Profile Configuration Command" Command Parameters
Parameter Type Description
committed-info-rate Parameter type: <Qos::BwCommittedInfoRate> mandatory parameter
Format: committed information rate
- committed information rate
- unit: kbps
- range: [0...10000000]
assured-info-rate Parameter type: <Qos::BwAssuredInfoRate> mandatory parameter
Format: assured information rate
- assured information rate
- unit: kbps
- range: [0...10000000]
excessive-info-rate Parameter type: <Qos::BwExcessiveInfoRate> mandatory parameter
Format: excessive information rate
- excessive information rate
- unit: kbps
Command Description
This command allows the operator to configure a QoS Ingress profile.The IngressQoS Profile table stores the pbit
to TC mappings that can be used by a L2 Forwarder in the upstream and dowstream directions.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles ( no ingress-qos (name) ) | ( ingress-qos (name) [ no dot1-p0-tc | dot1-p0-tc
<Qos::TCMask_0> ] [ no dot1-p1-tc | dot1-p1-tc <Qos::TCMask_1> ] [ no dot1-p2-tc | dot1-p2-tc
<Qos::TCMask_2> ] [ no dot1-p3-tc | dot1-p3-tc <Qos::TCMask_3> ] [ no dot1-p4-tc | dot1-p4-tc
<Qos::TCMask_4> ] [ no dot1-p5-tc | dot1-p5-tc <Qos::TCMask_5> ] [ no dot1-p6-tc | dot1-p6-tc
<Qos::TCMask_6> ] [ no dot1-p7-tc | dot1-p7-tc <Qos::TCMask_7> ] [ [ no ] use-dei ] [ no dot1-p0-color |
dot1-p0-color <Qos::NibbleMask_0> ] [ no dot1-p1-color | dot1-p1-color <Qos::NibbleMask_1> ] [ no
dot1-p2-color | dot1-p2-color <Qos::NibbleMask_2> ] [ no dot1-p3-color | dot1-p3-color <Qos::NibbleMask_3> ] [
no dot1-p4-color | dot1-p4-color <Qos::NibbleMask_4> ] [ no dot1-p5-color | dot1-p5-color <Qos::NibbleMask_5>
] [ no dot1-p6-color | dot1-p6-color <Qos::NibbleMask_6> ] [ no dot1-p7-color | dot1-p7-color
<Qos::NibbleMask_7> ] [ no dot1-p0-pol-tc | dot1-p0-pol-tc <Qos::PolTCMask_0> ] [ no dot1-p1-pol-tc |
dot1-p1-pol-tc <Qos::PolTCMask_1> ] [ no dot1-p2-pol-tc | dot1-p2-pol-tc <Qos::PolTCMask_2> ] [ no
dot1-p3-pol-tc | dot1-p3-pol-tc <Qos::PolTCMask_3> ] [ no dot1-p4-pol-tc | dot1-p4-pol-tc <Qos::PolTCMask_4>
] [ no dot1-p5-pol-tc | dot1-p5-pol-tc <Qos::PolTCMask_5> ] [ no dot1-p6-pol-tc | dot1-p6-pol-tc
<Qos::PolTCMask_6> ] [ no dot1-p7-pol-tc | dot1-p7-pol-tc <Qos::PolTCMask_7> ] )
Command Parameters
Table 19.30-1 "QoS IngressQoS Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.30-2 "QoS IngressQoS Profile Configuration Command" Command Parameters
Parameter Type Description
[no] dot1-p0-tc Parameter type: <Qos::TCMask_0> optional parameter with default
Format: value: 15
- traffic class corresponding to pbit0 traffic class corresponding to
- range: [0...7,15] pbit0
[no] dot1-p1-tc Parameter type: <Qos::TCMask_1> optional parameter with default
Command Description
This command allows the operator to configure a QoS rate limit profile. A QoS rate limit profile contains all rate
limit values related to different protocols, or total protocol values
Total protocol ratelimit value and supported protocol ratelimit value
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles ( no rate-limit (name) ) | ( rate-limit (name) [ no total-rate | total-rate
<Qos::RateLimitTotalRate> ] [ no total-burst | total-burst <Qos::RateLimitTotalBurst> ] [ no arp-rate | arp-rate
<Qos::RateLimitProtocolRate> ] [ no arp-burst | arp-burst <Qos::RateLimitProtocolBurst> ] [ no dhcp-rate |
dhcp-rate <Qos::RateLimitProtocolRate> ] [ no dhcp-burst | dhcp-burst <Qos::RateLimitProtocolBurst> ] [ no
igmp-rate | igmp-rate <Qos::RateLimitProtocolRate> ] [ no igmp-burst | igmp-burst
<Qos::RateLimitProtocolBurst> ] [ no pppoe-rate | pppoe-rate <Qos::RateLimitProtocolRate> ] [ no pppoe-burst |
pppoe-burst <Qos::RateLimitProtocolBurst> ] [ no nd-rate | nd-rate <Qos::RateLimitProtocolRate> ] [ no nd-burst |
nd-burst <Qos::RateLimitProtocolBurst> ] [ no icmpv6-rate | icmpv6-rate <Qos::RateLimitProtocolRate> ] [ no
icmpv6-burst | icmpv6-burst <Qos::RateLimitProtocolBurst> ] [ no mld-rate | mld-rate
<Qos::RateLimitProtocolRate> ] [ no mld-burst | mld-burst <Qos::RateLimitProtocolBurst> ] [ no dhcpv6-rate |
dhcpv6-rate <Qos::RateLimitProtocolRate> ] [ no dhcpv6-burst | dhcpv6-burst <Qos::RateLimitProtocolBurst> ] [
no cfm-rate | cfm-rate <Qos::RateLimitProtocolRate> ] [ no cfm-burst | cfm-burst <Qos::RateLimitProtocolBurst> ]
)
Command Parameters
Table 19.31-1 "QoS Rate Limit Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.31-2 "QoS Rate Limit Profile Configuration Command" Command Parameters
Parameter Type Description
[no] total-rate Parameter type: <Qos::RateLimitTotalRate> optional parameter with default
Format: value: 0
- protocol rate limit total rate committed total rate limit value
- unit: pps
Command Description
This command allows the operator to configure a QoS DSCP to Pbit mapping profile. To configure the DSCP
codepoints in the DSCP to dot1p mapping, the command "configure qos profiles dscp-pbit (name) codepoint
(codepoint) (value)" is to be used.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.32-1 "QoS DSCP to Pbit Mapping Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Command Description
This command allows the operator to configure a QoS DSCP to Pbit mapping profile. To configure the DSCP
codepoints in the DSCP to dot1p mapping, the command "configure qos profiles dscp-pbit (name) codepoint
(codepoint) (value)" is to be used.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles dscp-pbit (name) codepoint (codepoint) [ dot1p-value <Qos::DscpToDot1PAlign> ]
Command Parameters
Table 19.33-1 "QoS DSCP to Pbit Mapping Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
(codepoint) Format: the value of the codepoint
- the number of the DSCP codepoint
- range: [0...63]
Table 19.33-2 "QoS DSCP to Pbit Mapping Profile Configuration Command" Command
Parameters
Parameter Type Description
dot1p-value Parameter type: <Qos::DscpToDot1PAlign> optional parameter
Format: the dot1p value to be assigned to
- the DOT1P value the dscp codepoint
- range: [0...7]
Command Description
This command allows the operator to configure a QoS CoS threshold profile. A QoS CoS threshold profile contains
all settings related to a policer threshold.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos profiles ( no cos-threshold (name) ) | ( cos-threshold (name) [ no tc0-threshold | tc0-threshold
<Qos::tcThreshold> ] [ no tc1-threshold | tc1-threshold <Qos::tcThreshold> ] [ no tc2-threshold | tc2-threshold
<Qos::tcThreshold> ] [ no tc3-threshold | tc3-threshold <Qos::tcThreshold> ] [ no tc4-threshold | tc4-threshold
<Qos::tcThreshold> ] [ no tc5-threshold | tc5-threshold <Qos::tcThreshold> ] [ no tc6-threshold | tc6-threshold
<Qos::tcThreshold> ] [ no tc7-threshold | tc7-threshold <Qos::tcThreshold> ] )
Command Parameters
Table 19.34-1 "QoS CoS Threshold Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 19.34-2 "QoS CoS Threshold Profile Configuration Command" Command Parameters
Parameter Type Description
[no] tc0-threshold Parameter type: <Qos::tcThreshold> optional parameter with default
Format: value: 0
- Percentage of the QoS Thresh tc0 threshold, unit: percent
- range: [0...100]
[no] tc1-threshold Parameter type: <Qos::tcThreshold> optional parameter with default
Format: value: 0
- Percentage of the QoS Thresh tc1 threshold, unit: percent
- range: [0...100]
[no] tc2-threshold Parameter type: <Qos::tcThreshold> optional parameter with default
Format: value: 0
- Percentage of the QoS Thresh tc2 threshold, unit: percent
- range: [0...100]
[no] tc3-threshold Parameter type: <Qos::tcThreshold> optional parameter with default
Format: value: 0
Command Description
This command allows the operator to configure various parameters related to board-level traffic load and packet
loss.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.35-1 "QoS Board-Level Queue and Performance Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: the physical number of the slot
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Table 19.35-2 "QoS Board-Level Queue and Performance Configuration Command" Command
Parameters
Parameter Type Description
[no] buffer-occ-thresh Parameter type: <Qos::PercentThresh> optional parameter with default
Format: value: 0
Command Description
This command allows the operator to configure various parameters related to subscriber interface and queue level
traffic load and packet loss.
Load per physical line is calculated by matching the total number of bytes transmitted versus the capacity of the
interface in the relevant measurement epoch. Load per queue is measured in terms of the contribution to the
interface level load of traffic passed in a certain queue.
Threshold crossing alarms can be specified for the load and packet loss parameters per line and per traffic class.
This feature can be useful to detect network anomalies by watching over packet discard or load level in
high-priority traffic classes.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos tca (index) queue <Qos::TcaQueues> [ [ no ] tca-enable ] [ no load-thresh | load-thresh
<Qos::PercentThresh> ] [ no dis-frame-th | dis-frame-th <Qos::QosQueueStatsDiscFramesTcaThreshold> ]
Command Parameters
Table 19.36-1 "QoS Queue Threshold Crossing Alarm Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: physical port or lag port of a dsl
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / link
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
Command Description
Obsolete command, replaced by configure qos interface (index).
This command allows the operator to configure QoS settings on subscriber interfaces. For each subscriber
interface the operator can apply scheduling and CAC settings.
A scheduler profile is used to configure egress scheduler settings for egress subscriber interfaces on L3 cards. A
CAC profile is used to configure CAC settings for a subscriber interface.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.37-1 "QoS DSL Link Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: physical port of a subscriber
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / interface.
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 19.37-2 "QoS DSL Link Configuration Command" Command Parameters
Parameter Type Description
[no] scheduler-profile Parameter type: <Qos::SchedulerProfName> optional parameter with default
Format: value: "name : CL_66"
name : <Qos::IgnoredQosProfileName> name of scheduler profile to be
Possible values: mapped on this subscriber
- name : enter profile name to be associated interface.
Data driven field type
Possible values are depending on the actual configuration
Command Description
Obsolete command, replaced by configure qos interface (index) queue.
This command allows the operator to configure a QoS Line Card queue. On the L3 line cards, each DSL interface
supports four downstream buffers, which can be configured independently using buffer acceptance control (BAC)
profiles.
The operator can configure downstream buffers, such that the total buffer pool is oversubscribed. However, this is
not recommended because this allows QoS un-aware packet discard. If the total downstream buffer pool is
over-subscribed, the system logs a warning message. Proceed with care, as this allows QoS un-aware packet
discard in extreme traffic conditions.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.38-1 "QoS LIM Queue Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: physical port of a subscriber
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / interface.
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
(queue) Format: queue in scope of 1 dsl link on a
- output dsl/gpon/epon port queue number line-interface-module
- range: [0...7,255]
Table 19.38-2 "QoS LIM Queue Configuration Command" Command Parameters
Parameter Type Description
queue-profile Parameter type: <Qos::QosQueueProfileName> optional parameter
Format: name of the queue profile
Command Description
Obsolete command, replaced by configure qos interface (index).
This command allows the operator to configure Shdsl links. For each Shdsl link the operator can apply scheduling
and CAC settings.
A scheduler profile is used to configure egress scheduler settings for each egress Shdsl interface. A CAC profile is
used to configure CAC settings for each Shdsl interface.
The Shdsl link table can be configured on the SMLT-H , SMLT-J and NSLT-A units.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.39-1 "QoS ShdSL Link Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: physical port of a shdsl link
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 19.39-2 "QoS ShdSL Link Configuration Command" Command Parameters
Parameter Type Description
scheduler-profile Parameter type: <Qos::QosSchedulerProfileName> optional parameter
Format: name of scheduler profile to be
( none mapped on this dsl link
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
Command Description
Obsolete command, replaced by configure qos interface (index) queue.
This command allows the operator to configure a QoS Line Card queue. On the L3 line cards, each SHDSL
interface supports four downstream buffers, which can be configured independently using buffer acceptance
control (BAC) profiles.
The operator can configure downstream buffers, such that the total buffer pool is oversubscribed. However, this is
not recommended because this allows QoS un-aware packet discard. If the total downstream buffer pool is
over-subscribed, the system logs a warning message. Proceed with care, as this allows QoS un-aware packet
discard in extreme traffic conditions.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.40-1 "QoS LIM Queue (SHDSL) Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: physical port of a shdsl link
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
(queue) Format: queue in scope of 1 dsl link on a
- output dsl/gpon/epon port queue number line-interface-module
- range: [0...7,255]
Table 19.40-2 "QoS LIM Queue (SHDSL) Configuration Command" Command Parameters
Command Description
This command allows the operator to configure QoS settings on a user-port Interface. A user-port Interface can be
a DSL-link, an Shdsl-link, an Ethernet Line, a Link Aggregation Group or a pon, ont or uni interface. For each
Interface the operator can apply scheduling and CAC and shaper settings.
A scheduler node profile is used to configure egress scheduler settings for each egress Interface. A CAC profile is
used to configure CAC settings for each Interface. A shaper profile is used to configure downstream flooding
shaper settings for each Interface.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.41-1 "QoS Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: physical port or la-group of a
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / user-port Interface
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
Command Description
This command allows the operator to configure a QoS Line Card queue. On the L3 line cards, each user-port
(DSL-Link, Shdsl-link or Ethernet Line or LA-Group) supports four downstream buffers, which can be configured
independently using buffer acceptance control (BAC) profiles.
The operator can configure downstream buffers, such that the total buffer pool is oversubscribed. Please take note
that this allows QoS un-aware packet discard under extreme traffic conditions. When the total downstream buffer
pool is over-subscribed, the system logs a warning message.
Queue profile none only for epon,queue profile must have a name for other boards.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos interface (index) queue (queue) [ priority <Qos::QosPriority> ] [ weight <Qos::QosWeight> ] [
oper-weight <Qos::QosWeight> ] [ queue-profile <Qos::QosQueueProfName> ] [ shaper-profile
<Qos::QosShaperProfileName> ]
Command Parameters
Table 19.42-1 "QoS Interface Queue Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: physical port or la-group of a
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / user-port Interface
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
Command Description
This command allows the operator to configure the upstream queues on the LIM with queue profiles
The operator can configure the upstream queue priority and upstream queue weight along with an option to enable
or disable the bandwidth sharing.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos interface (index) upstream-queue (queue) [ no priority | priority <Qos::QosPriority> ] [ no weight |
weight <Qos::QosWeight> ] [ no bandwidth-profile | bandwidth-profile <Qos::QosBandwidthProfileName> ] [ no
ext-bw | ext-bw <Qos::QosBandwidthProfileName> ] [ no bandwidth-sharing | bandwidth-sharing
<Qos::BandwidthSharing> ] [ no queue-profile | queue-profile <Qos::QosQueueProfName> ] [ no shaper-profile |
shaper-profile <Qos::QosShaperProfileName> ]
Command Parameters
Table 19.43-1 "QoS Interface Upstream Queue Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: physical port or la-group of a
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / user-port Interface
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
Command Description
This command allows the operator to configure the downstream queues on the ONT.
The operator can configure the downstream queue priority and downstream queue weight at the ONT.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos interface (index) ds-rem-queue (queue) [ no priority | priority <Qos::QosPriority> ] [ no weight |
weight <Qos::QosWeight> ]
Command Parameters
Table 19.44-1 "QoS Interface Remote Downstream Queue Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: physical port or la-group of a
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / user-port Interface
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
Command Description
This command allows the operator to configure SHub QoS traffic classes. The SHub has four defined traffic
classes. The mapping of frames with 802.1P codepoint to egress buffers determines how each traffic class is put
into egress buffers and, in a later step, how each traffic class is scheduled on the SHub egress interfaces.
This traffic class mapping table is not applicable on the units.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.45-1 "SHub QoS Traffic Class Configuration Command" Resource Parameters
Resource Identifier Type Description
(tc-priority) Format: priority value in the received
- priority value in the received frames frames
- range: [0...7]
Table 19.45-2 "SHub QoS Traffic Class Configuration Command" Command Parameters
Parameter Type Description
traffic-class Parameter type: <Qos::ShubTrafficClass> optional parameter
Format: value of traffic class,the received
- value of traffic class, the received frame is mapped to frame is mapped to
- range: [0...3]
Command Description
This command allows the operator to configure the SHub QoS queue. The SHub features several network interfaces
that can be used for network, subtending, or directly attached customer interfaces (known as "user" interfaces on
the SHub) in any combination.
Each network interface features a hierarchical scheduler with queues (0, 1) scheduled as weighted round robin
(WRR) and queues (2,3) scheduled as strict priority. Queue 3 is the highest priority.
The WRR weights, egress shaping rate, and ingress policing rate can be configured for each SHub interface. See
the section on the QoS Ingress Policing Configuration Command for more information.
The SHub can also send and receive pause frames, but it is configured such that it will never generate pause frames
as a result of congestion on an egress interface. However, the SHub can correctly honor backpressure from peer
nodes that cannot handle the traffic.
Note that all SHub port settings are the same within a link aggregate group.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.46-1 "SHub QoS Queue Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: the unique id for the port
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Command Description
This command allows the operator to map the DSCP value to the 802.1p priority.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.47-1 "SHub QoS DSCP2P Map Configuration Command" Resource Parameters
Resource Identifier Type Description
(dscp-index) Format: the dscp value
- the dscp value in the ip frame
- range: [0...63]
Table 19.47-2 "SHub QoS DSCP2P Map Configuration Command" Command Parameters
Parameter Type Description
dot1p-value Parameter type: <Qos::ShubDSCPPriority> optional parameter
Format: the 802.1p priority value mapped
- the 802.1p priority value mapped to to
- range: [0...7]
Command Description
This command allows the operator to configure various flows to be policed.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos shub ( no flow (index) ) | ( flow (index) [ no name | name <Qos::FlowString> ] [ (old-type) ] [ no
type | type <Qos::FlowType> ] )
Command Parameters
Table 19.48-1 "SHub QoS Flow Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index used to identify a flow
- unique index for the flow
- range: [1...64]
Table 19.48-2 "SHub QoS Flow Configuration Command" Command Parameters
Parameter Type Description
[no] name Parameter type: <Qos::FlowString> optional parameter with default
Format: value: """"
- string to identify the flow name of the flow
- length: 1<=x<=15
(old-type) Format: obsolete parameter replaced by
( port parameter "type"
| vlan : <Qos::VlanId> type of qos flow
| vlan-dot1p : <Qos::VlanId> : <Qos::FlowPriority>
| vlan-dscp : <Qos::VlanId> : <Qos::FlowDscp> )
Possible values:
- port : rate limit a physical port
- vlan : rate limit a VLAN on an ingress port
- vlan-dot1p : rate limit a VLAN on a 802.1p traffic class
criterion
- vlan-dscp : rate limit a vlan on a dscp traffic class criterion
Field type <Qos::VlanId>
- vlan id to detect the flow
- range: [0...4092]
Field type <Qos::VlanId>
- vlan id to detect the flow
- range: [0...4092]
Field type <Qos::FlowPriority>
Command Description
This command allows the operator to enact policing on a SHub interface. It uses previously created policer and
flow definition blocks.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos shub ( no policer (port-id) flow <Qos::PolicerFlowIndex> ) | ( policer (port-id) flow
<Qos::PolicerFlowIndex> meter <Qos::PolicerMeterIndex> )
Command Parameters
Table 19.49-1 "SHub QoS Policer Configuration Command" Resource Parameters
Resource Identifier Type Description
(port-id) Format: shub qos port index
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
flow Parameter type: <Qos::PolicerFlowIndex> index of an existing flow
Format:
- index for the flow
- range: [1...64]
Table 19.49-2 "SHub QoS Policer Configuration Command" Command Parameters
Parameter Type Description
meter Parameter type: <Qos::PolicerMeterIndex> mandatory parameter
Format: index of an existing meter
- index for the meter
- range: [1...64]
Command Output
Table 19.49-3 "SHub QoS Policer Configuration Command" Display parameters
Specific Information
name Type Description
policer-status Parameter type: <Ip::ActivateRowStatus> the status of the policer which
( active indicates whether the policer is
| not-active ) active or inactive.
Possible values: This element is only shown in
- active : active route detail mode.
- not-active : active route
Command Description
This command allows the operator to configure a SHub policer. The construct can be used subsequently on many
physical interfaces in association with SHubflows.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> configure qos shub ( no meter (index) ) | ( meter (index) [ no name | name <Qos::DisplayString> ]
max-ingress-rate <Qos::MeterIngressRate> burst-size <Qos::MeterBurstSize> )
Command Parameters
Table 19.50-1 "SHub QoS Ingress Policing on Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index used to identify a meter
- unique index for meter
- range: [1...64]
Table 19.50-2 "SHub QoS Ingress Policing on Port Configuration Command" Command
Parameters
Parameter Type Description
[no] name Parameter type: <Qos::DisplayString> optional parameter with default
Format: value: """"
- string to identify the meter name of the meter
- length: 1<=x<=15
max-ingress-rate Parameter type: <Qos::MeterIngressRate> mandatory parameter
Format: the max ingress rate applied on a
- ingress max policing rate,in steps of 64Kbps port
- range: [1...163840]
burst-size Parameter type: <Qos::MeterBurstSize> mandatory parameter
Format: max ingress burst size allowed
- ingress policer's burst tolerance
- range: [0...7]
Command Description
This command allows the operator to configure police rate and burst per protocl.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.51-1 "QoS Line Control Packets Rate Limit Configuration Command" Resource
Parameters
Resource Identifier Type Description
(protocol-id) Format: protocol id for
( arp arp,igmp,dhcpv4,dhcpv6,icmpv6,cfm,pp
| igmp
| dhcpv4
| dhcpv6
| icmpv6
| cfm
| pppox )
Possible values:
- arp : arp
- igmp : igmp
- dhcpv4 : dhcpv4
- dhcpv6 : dhcpv6
- icmpv6 : icmpv6
- cfm : cfm
- pppox : pppox
Table 19.51-2 "QoS Line Control Packets Rate Limit Configuration Command" Command
Parameters
Parameter Type Description
[no] sustained-rate Parameter type: <Qos::SustainedRate> optional parameter with default
Format: value: 15
- the police rate of inc user pkts in pps police the user incoming packets
- range: [1...64] on all pvc's for the protocol of a
Command Description
This command allows the operator to configure the P-bit based scheduling for the S+C VLAN forwarder model for
Cross Connect / Residential Bridge.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.52-2 "P-bit Based Scheduling For SC Forwarder Cross Connect/Residential Bridge
Configuration Command" Command Parameters
Parameter Type Description
[no] sc-xcon-us Parameter type: <Qos::PbitSched> optional parameter with default
Format: value: "svlanpbitbased"
( svlanpbitbased This objects configure the
| cvlanpbitbased ) behavior of pbit scheduling in
Possible values: S+C Vlan Cross Connect in
- svlanpbitbased : Upstream p-bits affecting QoS action upstream direction
applies to S-VLAN p-bits and C-VLAN p-bits. Downstream
S-VLAN p-bits are copied to User-VLAN p-bits
- cvlanpbitbased : Upstream p-bits affecting QoS action
applies to S-VLAN p-bits. Downstream C-VLAN p-bits are
copied to User-VLAN p-bits
[no] sc-xcon-dn Parameter type: <Qos::PbitSched> optional parameter with default
Format: value: "svlanpbitbased"
( svlanpbitbased This objects configure the
| cvlanpbitbased ) behavior of pbit scheduling in
Possible values: S+C Vlan Cross Connect in
- svlanpbitbased : Upstream p-bits affecting QoS action downstream direction
applies to S-VLAN p-bits and C-VLAN p-bits. Downstream
S-VLAN p-bits are copied to User-VLAN p-bits
- cvlanpbitbased : Upstream p-bits affecting QoS action
Command Description
This command allows the operator to configure the QoS handling of upstream protocols(ARP, PPPoE,
DHCPv4/v6,ND and MLD) for DSL LT's.
User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 19.53-2 "QoS handling of upstream protocols(ARP, PPPoE, DHCPv4/v6,ND and MLD) for
DSL LT's Configuration Command" Command Parameters
Parameter Type Description
[no] enable Parameter type: boolean optional parameter
Enable QoS handling of upstream
protocols
Description
This chapter gives an overview of nodes that are handled by "VLAN Configuration Commands".
Command Tree
----configure
----vlan
- [no] broadcast-frames
- priority-policy
----vmac-address-format
- host-id
----[no] id
- (vlanid)
- [no] name
- mode
- [no] sntp-proxy
- [no] priority
- [no] vmac-translation
- [no] vmac-dnstr-filter
- [no] vmac-not-in-opt61
- [no] new-broadcast
- [no] protocol-filter
- [no] pppoe-relay-tag
X [no] dhcp-opt-82
- [no] dhcp-opt82-ext
- [no] circuit-id-dhcp
- [no] remote-id-dhcp
- [no] dhcp-linerate
- [no] pppoe-linerate
- [no] dhcpv6-linerate
- [no] pppoe-l2-encaps
- [no] dhcp-l2-encaps
- [no] dhcpv6-l2-encaps
- [no] l2-encaps1
- [no] pppoer-vlanaware
- [no] dhcpr-vlanaware
- [no] circuit-id-pppoe
- [no] remote-id-pppoe
- [no] new-secure-fwd
- [no] aging-time
- [no] l2cp-transparent
- [no] dhcpv6-itf-id
- [no] dhcpv6-remote-id
- [no] dhcpv6-trst-port
- [no] enterprise-number
- [no] icmpv6-sec-fltr
- [no] in-qos-prof-name
- [no] ipv4-mcast-ctrl
- [no] ipv6-mcast-ctrl
- [no] mac-mcast-ctrl
- [no] dis-proto-rip
- [no] proto-ntp
- [no] dis-ip-antispoof
- [no] unknown-unicast
- [no] pt2ptgem-flooding
- [no] mac-movement-ctrl
- [no] cvlan4095passthru
----[no] unicast-mac
- (unicast-mac)
- vlan-id
- forward-port
----[no] vlan-port
- (port)
- unicast-mac
----[no] port-protocol
- (port)
- protocol-group
- vlan-id
- priority
----shub
- [no] dual-tag-mode
----[no] id
- (vlanid)
- [no] name
- mode
- [no] mac-move-allow
- [no] mac-learning-off
- user2-comm
----[no] egress-port
- (port)
----[no] untag-port
- (port)
----[no] unicast-mac
- (unicast-mac)
- vlan-id
- forward-port
----pbit-statistics
----[no] port
- (vlan-port)
- min-dot1p
- max-dot1p
----[no] priority-regen
- (profile-idx)
- profile-name
- [no] pbit0
- [no] pbit1
- [no] pbit2
- [no] pbit3
- [no] pbit4
- [no] pbit5
- [no] pbit6
- [no] pbit7
Command Description
This command allows the operator to specify VLAN parameters that are globally applicable to VLANs:
- broadcast-frames : applies to VLANs of type residential bridge.when configured,broadcasting of frames is
configurable on a per vlan basis, when the parameter is configured as "no broadcast-frames", downstream
broadcast is disabled globally for all vlans.
- priority-policy : applies to VLANs of type residential bridge, cross-connect and QoS-aware.Indicates if the
priority of upstream frames is selected from the vlan (pvid) or port-default.This configuration is only applicable for
untagged user traffic.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 20.2-2 "VLAN General Configuration Command" Command Parameters
Parameter Type Description
[no] broadcast-frames Parameter type: boolean optional parameter
broadcasting of frames is
configurable per vlan
priority-policy Parameter type: <Vlan::PriorityMap> optional parameter
Format: specifies how to deal with
( vlan-specific ethernet priority of the upstream
| port-default ) frames
Possible values:
- vlan-specific : the priority of the vlan
- port-default : the default priority of the port
Command Description
This command allows the user to configure the format in which a virtual MAC address is defined.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 20.3-2 "Virtual MAC Configuration Command" Command Parameters
Parameter Type Description
host-id Parameter type: <Vlan::vmacUniqueHostID> optional parameter
Format: Value of vMac unique host
- A unique host Id within an EMAN connected to the same ID.Range 1...524287 for
IP edges. Range 1...524287 for DSL/ETH vMAC range DSL/ETH vMAC range 1...65535
1...65535 for GPON vMAC. for GPON vMAC
- range: [1...524287]
Command Description
This command allows the operator to specify a VLAN and its attributes.
The VLAN numbering space is the concatenation of a Service Provider VLAN, say S-VLAN-ID, and a Customer
VLAN, say C-VLAN-ID. Remark that the S-VLAN-ID is assumed to be unique.
The VLAN-ID value "0" - which is not a valid VLAN-tag value - is used to indicate "not applicable". The value
4097 should not be used as a valid forwarding VLAN.
Following convention applies:
- S-VLAN is identified as (S-VLAN-ID, C-VLAN-ID=0)
- unstacked C-VLAN identified as (C-VLAN-ID>0)
- the S-VLAN is absent or not applicable
- C-VLAN-ID > 0. A constraint exists for VLAN 1: it is reserved as the VLAN-unaware bridge. This VLAN is
managed as any other VLAN (i.e. it can be created, modified, removed) but it must be a residential bridged VLAN.
- stacked C-VLAN is identified as (S-VLAN-ID>1, C-VLAN-ID>1)
- RIP will be enabled automatically by default during the creation of VLAN.
The following combination is not allowed:pppoe-relay-tag=configurable, while circuit-id-pppoe and
remote-id-pppoe are both disable or customer-id or physical-id.
The circuit-id-pppoe and remote-id-pppoe take effect when the pppoe-relay-tag is configurable.
The pppoe-l2-encaps take effect when the pppoe-relay-tag is true or configurable.
The circuit-id-dhcp, remote-id-dhcp and dhcp-l2-encaps take effect when the dhcp-opt-82 is true or dhcp-opt82-ext
is enable or add-or-replace.
- pppoe-l2-encaps: This controls insertion of access loop encapsulation sub-options part of PPPoE relay tag -
Refer to (R-164 in TR101) - Datalink byte: ATM or Ethernet autogenerated according to actual encapsulation -
Encaps 1 byte : configurable (see further down) - Encaps 2 byte : fixed as NA
- dhcp-l2-encaps: This controls insertion of access loop encapsulation sub-options part of DHCP option 82 - Refer
to (R-164 in TR101) - Datalink byte: ATM or Ethernet autogenerated according to actual encapsulation - Encaps 1
byte : configurable (see further down) - Encaps 2 byte : fixed as NA
- dhcpv6-l2-encaps: This controls insertion of access loop encapsulation sub-options part of DHCPv6 relay tag -
Refer to (R-164 in TR101) - Datalink byte: ATM or Ethernet autogenerated according to actual encapsulation -
Encaps 1 byte : configurable (see further down) - Encaps 2 byte : fixed as NA
- l2-encaps1: This specifies the value of access loop encapsulation sub-options value 1 for DHCPv4, DHCPv6 and
PPPoE protocol relay tags
- new-broadcast: applies to VLANs of type residential bridge.The configured value of this parameter has no
meaning when broadcast-frames is not enabled at node level, meaning globally for all VLANs
- priority: The selection of the VLAN-based priority can apply provided the priority-policy at node-level is
vlan-specific.
- vmac-translation: this configuration value has no effect in case MAC learning is disabled (mac-learn-off).
- Note that vmac-translation, vmac-dnstr-filter and vmac-not-in-opt61 parameters can be enabled only at S-VLAN
level in case of S+C-VLAN CC mode.
- ipv6-mcast-ctrl: This parameter is used in the following cases: - on the NGLT-A GPON line card, ipv6-mcast-ctrl
parameter is used to allow or disallow upstream and downstream IPv6 multicast traffic - for all other line cards, in
case no DHCPv6 protocol processing is performed on the line card (i.e. new-secure-fwd,dhcpv6-itf-id and
dhcpv6-remote-id are all disabled), the ipv6-mcast-ctrl parameter is used to control upstream and downstream
DHCPv6 multicast traffic
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 20.4-1 "VLAN Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlanid) Format: VLAN id
( <Network::UVlanIndex>
| stacked : <Network::SVlanIndex> :
<Network::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Network::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Network::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Network::CVlanIndex>
- customer vlan identity
Command Description
This command allows the operator to specify entries in the Layer 2 filtering database for a specific VLAN and
unicast MAC address.
This information is used by the bridge in determining how to propagate a received frame.
Use of this command is disencouraged because it will be obsoleted and replaced in the future by the VLAN Port
Filtering Database Configuration command.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 20.5-1 "VLAN Filtering Database Configuration Command" Resource Parameters
Resource Identifier Type Description
(unicast-mac) Format: unicast mac address
- mac address (aa:bb:cc:a1:02:03)
- length: 6
vlan-id Parameter type: <Network::StackedVlan> network vlan id
Format:
( <Network::UVlanIndex>
| stacked : <Network::SVlanIndex> :
<Network::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Network::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Network::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Network::CVlanIndex>
- customer vlan identity
- range: [0...4093]
Command Description
This command allows the operator to specify entries in the Layer 2 filtering database for a specific VLAN Port and
unicast MAC address.
This information is used by the bridge in determining how to propagate a received frame.
This command will in time obsolete and replace the VLAN Filtering Database Configuration command. Already
now, it must be used in case multiple vlan ports are configured on the same bridge port and attached to the same
I-Bridge.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
> configure vlan ( no vlan-port (port) unicast-mac <Vlan::MacAddr> ) | ( vlan-port (port) unicast-mac
<Vlan::MacAddr> )
Command Parameters
Table 20.6-1 "VLAN Port Filtering Database Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: vlan port
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> :
Command Description
For protocol-based VLANs, this command allows the operator to specify how incoming traffic on a port is
allocated to a particular VLAN and priority.
For Ethernet frames, the mapping to either the PPPoE or IPoE protocol is:
• protocol value 0x8863: PPPoE
• protocol value 0x8864: PPPoE
• protocol value 0x0800: IPoE
• protocol value 0x0806: IPoE
• protocol value 0x8035: IPoE
For RFC_1042 frames the mapping to either PPPoE or IPoE protocol is:
• protocol value 0x8863: PPPoE
• protocol value 0x8864: PPPoE
• protocol value 0x0800: IPoE
• protocol value 0x0806: IPoE
• protocol value 0x8035: IPoE
priority: The selection of the priority for upstream frames, in case of a protocol based vlan, is not dependent on the
configuration of the priority-policy configured at node level.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
> configure vlan ( no port-protocol (port) protocol-group <Vlan::GroupId> ) | ( port-protocol (port) protocol-group
<Vlan::GroupId> vlan-id <Vlan::StackedVlan> priority <Vlan::Priority> )
Command Parameters
Table 20.7-1 "VLAN Protocol-based Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. uplink port,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / atm pvc, efm port, eth port, la
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> group ...)
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
Command Description
This command allows the operator to specify the tagging mode globally applicable to SHub VLANs.
Setting means that the SHub works as a stacked-VLAN bridge in dual tagged mode.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 20.8-2 "SHub General VLAN Configuration Command" Command Parameters
Parameter Type Description
[no] dual-tag-mode Parameter type: boolean optional parameter
vlan stacking is active
Command Description
This command allows the operator to specify a VLAN and its attributes on the SHub.
Clarification regarding 'entry-status': If a failure occurs during the configuration of VLAN, please check if the
VLAN was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire
VLAN.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
> configure vlan shub ( no id (vlanid) ) | ( id (vlanid) [ no name | name <Vlan::AdminName> ] mode
<Shub::SystemMode> [ [ no ] mac-move-allow ] [ [ no ] mac-learning-off ] [ user2-comm
<Shub::UserToUserCommStatus> ] )
Command Parameters
Table 20.9-1 "SHub VLAN Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlanid) Format: vlan id
- vlan id
- range: [1...4093]
Table 20.9-2 "SHub VLAN Configuration Command" Command Parameters
Parameter Type Description
[no] name Parameter type: <Vlan::AdminName> optional parameter with default
Format: value: ""
- char string name
- length: x<=32
mode Parameter type: <Shub::SystemMode> mandatory parameter
Format: The parameter is not visible
( cross-connect during modification.
| residential-bridge mode
| layer2-terminated
| layer2-term-nwport
| v-vlan
| reserved
| voice-vlan )
Possible values:
- cross-connect : crossconnect vlan
- residential-bridge : residential bridge vlan
- layer2-terminated : layer2 terminated vlan
Command Output
Table 20.9-3 "SHub VLAN Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Vlan::WaitRowStatusVlan> the status of the VLAN instance
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
Possible values:
- valid : VLAN configuration is ok
- corrupted : VLAN configuration is not
operational(not-in-service)
- corrupted : VLAN configuration is not
operational(not-ready)
Command Description
This command allows the operator to specify the set of ports that are statically allocated as egress ports for the
specified VLAN.
egress-port: controller port (nt) is not supported in NANT-A and ECNT-C board.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 20.10-1 "SHub Static Egress Port for VLAN Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlanid) Format: vlan id
- vlan id
- range: [1...4093]
(port) Format: egress port
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Command Description
This command allows the operator to specify the egress ports that should transmit packets for this VLAN as
untagged.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 20.11-1 "SHub Static Untagged Egress Port for VLAN Configuration Command" Resource
Parameters
Resource Identifier Type Description
(vlanid) Format: vlan id
- vlan id
- range: [1...4093]
(port) Format: the untagged network port
( network : <Shub::NetworkPort>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- network : network port
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number
Command Description
This command allows the operator to specify entries in the Layer 2 filtering database for a specific VLAN and
unicast MAC address. This configuration applies to the SHub.
This information is used by the bridge in determining how to propagate a received frame.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
> configure vlan shub ( no unicast-mac (unicast-mac) vlan-id <Sys::VlanId> ) | ( unicast-mac (unicast-mac) vlan-id
<Sys::VlanId> forward-port <Shub::UcastForwardPort> )
Command Parameters
Table 20.12-1 "SHub Unicast MAC Filtering Database Configuration Command" Resource
Parameters
Resource Identifier Type Description
(unicast-mac) Format: unicast mac address
- mac address (aa:bb:cc:a1:02:03)
- length: 6
vlan-id Parameter type: <Sys::VlanId> vlan id
Format:
- vlan id
- range: [1...4093]
Table 20.12-2 "SHub Unicast MAC Filtering Database Configuration Command" Command
Parameters
Parameter Type Description
forward-port Parameter type: <Shub::UcastForwardPort> mandatory parameter
Format: forward port
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
Command Description
This command allows the operator to configure the p-bit traffic counter.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
> configure vlan pbit-statistics ( no port (vlan-port) min-dot1p <Vlan::Dot1pMin> max-dot1p <Vlan::Dot1pMax> )
| ( port (vlan-port) min-dot1p <Vlan::Dot1pMin> max-dot1p <Vlan::Dot1pMax> )
Command Parameters
Table 20.13-1 "Vlan Pbit Traffic Counter Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-port) Format: vlan port
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
Command Description
This command allows the operator to configure a custom priority regeneration profile instead of one of the 10
hard-coded profiles. The priority regeneration profile table stores the p-bit mapping rules that can be used by a L2
Forwarder in the upstream and downstream direction.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 20.14-1 "Vlan Priority Regeneration Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(profile-idx) Format: A unique profile index
- a unique index value for the priority regeneration profile
- range: [11...32]
Table 20.14-2 "Vlan Priority Regeneration Profile Configuration Command" Command
Parameters
Parameter Type Description
profile-name Parameter type: <AsamProfileName> mandatory parameter
Format: A unique profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
[no] pbit0 Parameter type: <Vlan::NibbleMaskRestricted_0> optional parameter with default
Format: value: 8
- nibble mask pbit mapping corresponding to
- range: [0...8] pbit0
[no] pbit1 Parameter type: <Vlan::NibbleMaskRestricted_1> optional parameter with default
Format: value: 8
- nibble mask pbit mapping corresponding to
- range: [0...8] pbit1
Description
This chapter gives an overview of nodes that are handled by "Bridge Configuration Commands".
Command Tree
----configure
----bridge
- [no] ageing-time
----[no] port
- (port)
- [no] pvid
- [no] default-priority
- [no] mac-learn-off
- [no] max-unicast-mac
- [no] qos-profile
- [no] prio-regen-prof
- [no] prio-regen-name
- [no] max-committed-mac
- [no] mirror-mode
- [no] mirror-vlan
- [no] pvid-tagging-flag
----[no] vlan-id
- (index)
- [no] tag
X [no] network-vlan
- [no] l2fwder-vlan
- [no] vlan-scope
- [no] qos
- [no] qos-profile
- [no] prior-best-effort
- [no] prior-background
- [no] prior-spare
- [no] prior-exc-effort
- [no] prior-ctrl-load
- [no] prior-less-100ms
- [no] prior-less-10ms
- [no] prior-nw-ctrl
- [no] in-qos-prof-name
- [no] max-up-qos-policy
- [no] max-ip-antispoof
- [no] max-unicast-mac
- [no] max-ipv6-antispf
- [no] mac-learn-ctrl
- [no] min-cvlan-id
- [no] max-cvlan-id
- [no] ds-dedicated-q
----static-user
----[no] ip-address
- (ipaddr)
----[no] ipv6-address
- (prefixandlength)
----shub
- [no] ageing-time
----port
- (network-port)
- [no] default-priority
- [no] pvid
- [no] accept-frame-type
X [no] enable-dual-tag
- [no] force-add-tag
- [no] enable-pbit-mode
----mac-learning
- [no] disable-nw-port
Command Description
This command allows the operator to specify the aging time for dynamically learned MAC addresses in the filtering
database. The setting is applicable to the entire bridge.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 21.2-2 "Bridge General Configuration Command" Command Parameters
Parameter Type Description
[no] ageing-time Parameter type: <Vlan::AgingTime> optional parameter with default
Format: value: 300
- ageing time ageing timeout for dynamic mac
- unit: sec entries
- range: [10...1000000]
Command Description
This command allows the operator to specify various parameters applicable to a specific bridge port. These
parameters determine the handling of frames on the bridge port.
Priority Regeneration Profile: these profiles are predetermined. Following profiles are available:
• Profile 1: Trusted Port
• Profile 2: Best Effort
• Profile 3: Controlled Load, all priority 3 traffic
• Profile 4: Controlled Load, all priority 4 traffic
• Profile 5: Background
• Profile 6: Best Effort, Controlled Load, Voice
• Profile 7: Best Effort, Controlled Load, Voice according 802.1d Annex G
• Profile 8: Best Effort, Voice
• Profile 9: L2 VPN with 3 traffic classes
• Profile 10: L2 VPN with 4 traffic classes
The configuration of this value should not be combined with the configuration of:
• a port default vlan, or
• a port-protocol default vlan for PPPoE, or
• a terminated PPPoE interface, or
• a port-protocol default vlan for IPoE, or
• a terminated IPoE interface.
untagged: This configuration allows the user to send untagged frames and on some types of HW also priority
tagged frames. Processing untagged / priority tagged frames requires additional configuration. Such frames will be
discarded in absence of such additional configuration. The configuration of the acceptable-Frame-Type to this
value results also in the autonomous creation by the system of an 'IGMP channel' and of an '802.1x Port'
associated to this Bridge Port. These objects are created with default values such that the corresponding function is
'disabled'. The configuration this value should be completed with the creation of:
• one or more port-vlan associations and
• a port default vlan, and/or
• a port-protocol default vlan for PPPoE, and/or
• a port-protocol default vlan for IPoE,
However, note that this value is not always strictly forced on all HW. E.g. some type of LSMs will accept and
forward single tagged frames when the VLAN-id matches a configured port-vlan association. Other type of LSMs
will always discard single tagged frame.
Note that for the multivlan feature, tagged user traffic will be sent but the "acceptable frame types" must be set to
"untagged".
mixed-untagged: This value allows the user to send single tagged frames, untagged frames, and on some types of
HW also priority tagged frames. The VLAN-id of single tagged frames will be verified against the configured
port-vlan associations. Untagged / priority tagged frames will be processed according additional configuration.
Such frames will be discarded in absence of such additional configuration. The configuration of this value should
be completed with the configuration of:
• one or more port-vlan associations, and
• a port default vlan, and/or
• a port-protocol default vlan for PPPoE, and/or
• a port-protocol default vlan for IPoE.
default-priority: The selection of the port default-priority can apply provided the priority-policy at node level is
port-default.
mac-learn-off : The configuration value has no effect in case the bridge port is used for IpoA CC and EPON
boards: the system accepts all values but no mac learning will be done.
Remark: Please note that in case the RADIUS server returns a VLAN for 802.1x authenticated ports, it is
recommended to not configure a port default VLAN ID (PVID) on that user port. In any case, the VLAN ID
returned by the RADIUS server may not equal the pre- configured PVID on the user port. In addition, the returned
VLAN ID by the RADIUS server may not be configured as the PVID on the user port after successful 802.1x
authentication.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
> configure bridge ( no port (port) ) | ( port (port) [ no pvid | pvid <Network::StackedVlan> ] [ no default-priority |
default-priority <Vlan::Priority> ] [ [ no ] mac-learn-off ] [ no max-unicast-mac | max-unicast-mac
<Vlan::MaxMac> ] [ no qos-profile | qos-profile <Qos::QosSessionProfileName> ] [ no prio-regen-prof |
prio-regen-prof <Vlan::PrioRegenProfile> ] [ no prio-regen-name | prio-regen-name
<Vlan::PrioRegenProfileName> ] [ no max-committed-mac | max-committed-mac <Vlan::ComitMaxMac> ] [ no
mirror-mode | mirror-mode <Vlan::MirrorMode> ] [ no mirror-vlan | mirror-vlan <Vlan::MirrorVlan> ] [ no
pvid-tagging-flag | pvid-tagging-flag <Vlan::PvidTaggingFlag> ] )
Command Parameters
Table 21.3-1 "Bridge Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. uplink port,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / atm pvc, efm port, eth port, la
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> group ...)
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
Command Description
This command allows the operator to associate a VLAN to a bridge port and to define VLAN attributes on this port.
The parameters that allow to configure the priority bits (prior-best-effort till prior-nw-ctrl) only apply in case of a
qos-aware VLAN.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
> configure bridge port (port) ( no vlan-id (index) ) | ( vlan-id (index) [ no tag | tag <Vlan::PortUntagStatus> ] [ no
network-vlan | network-vlan <Network::StackedVlan> ] [ no l2fwder-vlan | l2fwder-vlan <Network::StackedVlan>
] [ no vlan-scope | vlan-scope <Vlan::VlanScope> ] [ no qos | qos <Vlan::QosPolicy> ] [ no qos-profile | qos-profile
<Qos::QosSessionProfileName> ] [ [ no ] prior-best-effort ] [ [ no ] prior-background ] [ [ no ] prior-spare ] [ [ no ]
prior-exc-effort ] [ [ no ] prior-ctrl-load ] [ [ no ] prior-less-100ms ] [ [ no ] prior-less-10ms ] [ [ no ] prior-nw-ctrl ]
[ no in-qos-prof-name | in-qos-prof-name <Qos::QosIngressProfileNameForVlan> ] [ no max-up-qos-policy |
max-up-qos-policy <Vlan::MaxUpQoSPolicy> ] [ no max-ip-antispoof | max-ip-antispoof
<Vlan::MaxIpAntispoof> ] [ no max-unicast-mac | max-unicast-mac <Vlan::BridgeMaxMac> ] [ no
max-ipv6-antispf | max-ipv6-antispf <Vlan::MaxIpAntispoof> ] [ no mac-learn-ctrl | mac-learn-ctrl
<Vlan::MacLearnCtrl> ] [ no min-cvlan-id | min-cvlan-id <Vlan::MinCVlanId> ] [ no max-cvlan-id | max-cvlan-id
<Vlan::MaxCVlanId> ] [ no ds-dedicated-q | ds-dedicated-q <Vlan::DsDedicatedQueue> ] )
Command Parameters
Table 21.4-1 "Bridge Port to VLAN Association Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. uplink port,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / atm pvc, efm port, eth port, la
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> group ...)
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Command Output
Table 21.4-3 "Bridge Port to VLAN Association Configuration Command" Display parameters
Specific Information
name Type Description
prio-regen-name Parameter type: <Vlan::PrioRegenProfileName> priority regeneration profile name
( none This element is only shown in
| name : <Vlan::IgnoredVlanProfileName> ) detail mode.
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Command Description
This command allows the operator to configure the IP-address for a user interface(vlan-port) of a L2 forwarder.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
> configure bridge port (port) vlan-id (index) static-user ( no ip-address (ipaddr) ) | ( ip-address (ipaddr) )
Command Parameters
Table 21.5-1 "L2 Static User Ip Address Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. uplink port,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / atm pvc, efm port, eth port, la
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> group ...)
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Command Description
This command allows the operator to configure the IPv6-address for a user interface(vlan-port) of a L2 forwarder.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
> configure bridge port (port) vlan-id (index) static-user ( no ipv6-address (prefixandlength) ) | ( ipv6-address
(prefixandlength) )
Command Parameters
Table 21.6-1 "L2 Static User Ipv6 Address Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. uplink port,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / atm pvc, efm port, eth port, la
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> group ...)
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
Command Description
This command allows the operator to specify the aging time for dynamically learned MAC addresses in the filtering
database. The setting is applicable to the entire SHub bridge.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 21.7-2 "SHub Bridge Configuration Command" Command Parameters
Parameter Type Description
[no] ageing-time Parameter type: <Shub::AgingTime> optional parameter with default
Format: value: 300
- ageing time program ageing timeout for
- unit: sec dynamic mac entries
- range: [10...1000000]
Command Description
This command allows the operator to specify various parameters applicable to a specific bridge port on the SHub.
These parameters determine the handling of frames on the bridge port.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
> configure bridge shub port (network-port) [ no default-priority | default-priority <Shub::PortPriority> ] [ no pvid |
pvid <Vlan::VlanOamIndex> ] [ no accept-frame-type | accept-frame-type <Shub::VlanFrameTypes> ] [ [ no ]
enable-dual-tag ] [ [ no ] force-add-tag ] [ [ no ] enable-pbit-mode ]
Command Parameters
Table 21.8-1 "SHub Bridge Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(network-port) Format: the network port
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Table 21.8-2 "SHub Bridge Port Configuration Command" Command Parameters
Parameter Type Description
[no] default-priority Parameter type: <Shub::PortPriority> optional parameter with default
Format: value: "0"
- port priority default ingress user priority
- range: [0...7]
[no] pvid Parameter type: <Vlan::VlanOamIndex> optional parameter with default
Format: value: 1
- vlan id port vlan id
- range: [1...4093]
Command Description
This command allows the operator to configure the mac learning states.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 21.9-2 "Mac learning Configuration Command" Command Parameters
Parameter Type Description
[no] disable-nw-port Parameter type: boolean optional parameter
disable network port mac
learning function
Description
This chapter gives an overview of nodes that are handled by "Link Aggregation Configuration Commands".
Command Tree
----configure
----la
- [no] disable-lacp
----aggregator-port
- (network-port)
- name
- [no] link-up-down-trap
- [no] actor-sys-prio
- selection-policy
- actor-key
- [no] actor-port-prio
- [no] active-lacp
- [no] short-timeout
- [no] aggregatable
- lacp-mode
Command Description
This command allows the operator to configure the Link Aggregation on the SHub. It allows the operator to enable
or disable the Link Aggregation feature.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 22.2-2 "Link Aggregation Configuration Command" Command Parameters
Parameter Type Description
[no] disable-lacp Parameter type: boolean optional parameter
la module stops protocol
operations
Command Description
This command allows the operator to specify the Link Aggregation Group parameters. The configuration should be
performed for the primary link. Link Aggregation Group is identified by means of the primary link, also referred to
as aggregator-port. The primary link for an aggregation group is the link with the lowest SHub logical port number
within the group, provided the operational state of the link is UP. (Note: Lowest SFP faceplate number in the
aggregation group is not necessarily the lowest SHub logical port number. Some lower SFP faceplate numbers are
mapped to higher SHub logical port numbers internally.)
The configuration should be performed for the primary link. The settings configured for the primary link of the
aggregation group apply to each and every link that is a member of the Link Aggregation Group.
The link that is denoted as primary link may change during the lifetime of the aggregation group. To cope with this
phenomenon, the operator is advised to repeat the configurations described in this section for each link of the
aggregation group. Care shall be taken to configure identical settings for all links within the aggregation group.
The primary link can be learned using a show command.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 22.3-1 "Link Aggregation Group Configuration Command" Resource Parameters
Resource Identifier Type Description
(network-port) Format: interface index of network port
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
Description
This chapter gives an overview of nodes that are handled by "Multiple Spanning Tree Configuration Commands".
Command Tree
----configure
----mstp
----general
- [no] disable-stp
- [no] priority
- [no] max-age
- [no] hello-time
- [no] forward-delay
- [no] version
- [no] tx-hold-count
- [no] path-cost-type
- [no] max-hop-count
- region-name
- [no] region-version
- [no] config-id-sel
----[no] instance
- (instance)
- [no] priority
----[no] associate-vlan
- (vlan)
----port
- (port)
- [no] priority
- [no] disable-stp
- path-cost
- [no] edge-port
- [no] admin-p2p
- [no] hello-time
----port-instance
- (network-port)
- instance
- [no] priority
- [no] disable-stp
- path-cost
Command Description
This command allows the operator to configure the general MSTP parameters .The configuration of the parameters
apply for the whole bridge.This configuration applies to the SHub.
The port, instance and port-instance specific MSTP parameters are in subsequent chapters.
The bridge max-age value should be less than or equal to (2 * ((forward-delay/100)-1) and should be greater than
or equal to (2 * ((Port hello-time/100) + 1)).
The bridge hello-time is only applicable when the version is stp/rstp, in case of version mstp the port hello-time is
used.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
> configure mstp general [ [ no ] disable-stp ] [ no priority | priority <Shub::StpPriority> ] [ no max-age | max-age
<Shub::StpMaxAge> ] [ no hello-time | hello-time <Shub::StpHelloTime> ] [ no forward-delay | forward-delay
<Shub::StpFwDelay> ] [ no version | version <Shub::StpProtVersion> ] [ no tx-hold-count | tx-hold-count
<Shub::StpTxHoldCount> ] [ no path-cost-type | path-cost-type <Shub::StpPathCostType> ] [ no max-hop-count |
max-hop-count <Shub::StpMaxHopCount> ] [ region-name <Shub::StpRegionName> ] [ no region-version |
region-version <Shub::StpRegionVersion> ] [ no config-id-sel | config-id-sel <Shub::StpConfigIdSelector> ]
Command Parameters
Table 23.2-2 "SHub MSTP general configuration Command" Command Parameters
Parameter Type Description
[no] disable-stp Parameter type: boolean optional parameter
all stp protocol operations stop
[no] priority Parameter type: <Shub::StpPriority> optional parameter with default
Format: value: 32768
- stp bridge priority(n*4096) stp bridge priority(n*4096)
- range: [0...61440]
[no] max-age Parameter type: <Shub::StpMaxAge> optional parameter with default
Format: value: 2000
- stp bridge priority(n*100) stp max-age for
- unit: 10msec root-bridge(n*100)
- range: [600...4000]
[no] hello-time Parameter type: <Shub::StpHelloTime> optional parameter with default
Format: value: 200
- stp bridge hello time(n*100) stp hello-time for bridge acting as
- unit: 10msec root(n*100)
- range: [100...1000]
Command Description
This command allows the operator to configure the MSTP parameters for a specific MSTP instance. This
configuration applies to the SHub.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
> configure mstp ( no instance (instance) ) | ( instance (instance) [ no priority | priority <Shub::StpPriority> ] )
Command Parameters
Table 23.3-1 "SHub MSTP Instance configuration Command" Resource Parameters
Resource Identifier Type Description
(instance) Format: MSTP instance
- MSTP Instance
- range: [1...16]
Table 23.3-2 "SHub MSTP Instance configuration Command" Command Parameters
Parameter Type Description
[no] priority Parameter type: <Shub::StpPriority> optional parameter with default
Format: value: 32768
- stp bridge priority(n*4096) the Bridge Priority(n*4096)
- range: [0...61440]
Command Description
This command allows the operator to map/unmap VLANs to a specific MSTP instance.The VLAN can be associated
with the MSTP instance without being configured first. One or more VLANs can be associated to an instance, but
one VLAN can not be assigned to different instances.
This configuration applies to the SHub.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 23.4-1 "SHub MSTP Vlan-Instance Mapping configuration Command" Resource Parameters
Resource Identifier Type Description
(instance) Format: MSTP instance
- MSTP Instance
- range: [1...16]
(vlan) Format: vlan id to be associated with the
- vlan id mstp instance
- range: [2...4094]
Command Description
This command allows the operator to configure the port parameters for the Common Instance. This configuration
applies to the SHub.
By default mstp is enabled on the network and outband ports.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
> configure mstp port (port) [ no priority | priority <Shub::MstpPortPriority> ] [ [ no ] disable-stp ] [ path-cost
<Shub::MstpPathCost> ] [ [ no ] edge-port ] [ no admin-p2p | admin-p2p <Shub::MstpAdminP2PPort> ] [ no
hello-time | hello-time <Shub::StpHelloTime> ]
Command Parameters
Table 23.5-1 "SHub MSTP Port configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: isam network port
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::MstpNetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::MstpNetworkPort>
- Network Port on Shub
Table 23.5-2 "SHub MSTP Port configuration Command" Command Parameters
Parameter Type Description
[no] priority Parameter type: <Shub::MstpPortPriority> optional parameter with default
Format: value: 128
- mstp port priority(n*16) mstp port priority(n*16)
- range: [0...240]
[no] disable-stp Parameter type: boolean optional parameter
current Msti port state disabled
Command Description
This command allows the operator to configure the MSTP parameters for a specific port-instance configuration. In
order to be able to configure the port-instance parameters, the port must be member of the vlan-port map.This
configuration applies to the SHub.
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 23.6-1 "SHub MSTP Port-Instance configuration Command" Resource Parameters
Resource Identifier Type Description
(network-port) Format: isam network port
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::MstpNetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::MstpNetworkPort>
- Network Port on Shub
instance Parameter type: <Shub::MstpInstance> mstp instance
Format:
- MSTP Instance
- range: [1...16]
Table 23.6-2 "SHub MSTP Port-Instance configuration Command" Command Parameters
Parameter Type Description
[no] priority Parameter type: <Shub::MstpPortPriority> optional parameter with default
Description
This chapter gives an overview of nodes that are handled by "IP Configuration Commands".
Command Tree
----configure
----ip
----[no] vlan-bind
- (vlan-id)
- layer3-itf
----[no] vrf
- (index)
- name
- [no] desc
- [no] contact
- [no] my-ipaddress
- [no] default-ttl
- [no] reassem-timeout
- [no] mode
----[no] network-itf
- (vlanid)
- [no] arp-policy
- [no] unnumbered
----[no] ip-address
- (ip-address)
----user-itf
----[no] port
- (port-interface)
- [no] qos-profile
----[no] arp-proxy-stats
----X [no] bridgeport
- (port-interface)
- [no] qos-profile
----gateway-itf
----[no] ip-address
- (ip-address)
----[no] route-dest
- (dest-ip-address)
- next-hop
----shub
----[no] vrf
- (index)
- name
- (modeandcommstatus)
- [no] forward-ttl-zero
- [no] max-routes
----[no] routing-option
----[no] route-map
- (dest-ip)
- source-proto
- (export)
- dest-proto
----X preference
----X route-type
- (index)
- value
----[no] route-dest
- (dest)
- next-hop
- vlan-id
- [no] metric
----arp
- [no] max-arp-entries
----arp
X cache-timeout
X cache-pending
X cache-refresh
X cache-retry-time
X max-retry-itvl
X max-retries
----vlan
- (vlanid)
- [no] gratuitous-arp
----[no] routing-option
----preference
----route-type
- (index)
- value
Command Description
This command allows the operator to create or delete a VLAN bundle.
Deleting the last VLAN deletes the VLAN bundle.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 24.2-1 "VLAN Bundle Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: specifies the vlan ID.
- vlan id
- range: [1...4093]
Table 24.2-2 "VLAN Bundle Configuration Command" Command Parameters
Parameter Type Description
layer3-itf Parameter type: <Itf::IpoeInterface> mandatory parameter
Format: The parameter is not visible
( <Ip::Layer3ID> during modification.
| new ) specifies the layer3 interface.
Possible values:
- new : new ip interface
Field type <Ip::Layer3ID>
- the layer3 interface
Command Description
This command allows the operator to create, delete, or modify a VRF context for the data plane. VRF index 0 is
reserved and cannot be created, deleted, or modified.
Modification of my-ipaddress is not possible if PPPoE connections are established in the VRF.
Removal of the VRF is not possible when IP interfaces are attached or when a PPPoE connection is established in
the VRF.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ip ( no vrf (index) ) | ( vrf (index) name <Vrf::VrfName> [ no desc | desc <Vrf::VrfDescription> ] [ no
contact | contact <Vrf::VrfContact> ] [ no my-ipaddress | my-ipaddress <Ip::V4AddressHex> ] [ no default-ttl |
default-ttl <Vrf::DefaultTTL> ] [ no reassem-timeout | reassem-timeout <Vrf::ReAssyTimeOut> ] [ no mode |
mode <Vrf::VrfMode> ] )
Command Parameters
Table 24.3-1 "VRF Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf index
- the VRF ID which uniquely identify a VRF
- range: [1...127]
Table 24.3-2 "VRF Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <Vrf::VrfName> mandatory parameter
Format: the name
- the name which uniquely identify a VRF
- length: 1<=x<=32
[no] desc Parameter type: <Vrf::VrfDescription> optional parameter with default
Format: value: ""
- a string describing the VRF the description
- length: x<=32
[no] contact Parameter type: <Vrf::VrfContact> optional parameter with default
Format: value: ""
- the contact info for administration of VRF contact information for
- length: x<=32 administration of this VRF
[no] my-ipaddress Parameter type: <Ip::V4AddressHex> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address Ip Address of the system within
Command Description
This command allows the operator to create the IP interface on a network port.
A vrf configured in router mode can be associated with only one vlan interface. If the user tries to associate
another vlan interface with the same vrf , CLI provides an error , but deletion of the unassociated vlan is not
possible directly. Please use the admin command "admin ip no vlan-itf-delete (index) " only to remove the
unassociated vlan interface.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ip vrf (index) ( no network-itf (vlanid) ) | ( network-itf (vlanid) [ no arp-policy | arp-policy
<Vrf::ArpPolicy> ] [ [ no ] unnumbered ] )
Command Parameters
Table 24.4-1 "IP Interface Network Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf index
- the VRF ID which uniquely identify a VRF
- range: [1...127]
(vlanid) Format: vlan id
- vlan id
- range: [1...4093]
Table 24.4-2 "IP Interface Network Configuration Command" Command Parameters
Parameter Type Description
[no] arp-policy Parameter type: <Vrf::ArpPolicy> optional parameter with default
Format: value: "not-trusted"
( not-trusted system behaviour to received
| trusted ) ARP packets
Possible values:
- not-trusted : not trusted ARP packets
- trusted : trusted ARP packets
[no] unnumbered Parameter type: boolean optional parameter
unnumbered interface
Command Description
This command allows the operator to associate the IP address with the numbered interface.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ip vrf (index) network-itf (vlanid) ( no ip-address (ip-address) ) | ( ip-address (ip-address) )
Command Parameters
Table 24.5-1 "IP Interface Network Numbered Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf index
- the VRF ID which uniquely identify a VRF
- range: [1...127]
(vlanid) Format: vlan id
- vlan id
- range: [1...4093]
(ip-address) Format: inet-address
<Ip::V4Address> / <Ip::PrefixLength>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLength>
- IP address prefix length
- range: [0...30]
Command Description
This command allows the operator to configure the user port interface (rack/shelf/Lt-slot/port/vpi:vci).
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ip vrf (index) user-itf ( no port (port-interface) ) | ( port (port-interface) [ no qos-profile | qos-profile
<Vlan::QosProfileName> ] )
Command Parameters
Table 24.6-1 "IP Interface User Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf index
- the VRF ID which uniquely identify a VRF
- range: [1...127]
(port-interface) Format: identification of the port or
( atm-port : <Eqpt::RackId> / <Eqpt::ShelfId> / virtual channel
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| atm-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
Command Description
This command allows the operator to enable the ARP proxy statistic.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 24.7-1 "IP User Port ARP Proxy Statistics Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf index
- the VRF ID which uniquely identify a VRF
- range: [1...127]
(port-interface) Format: identification of the port or
( atm-port : <Eqpt::RackId> / <Eqpt::ShelfId> / virtual channel
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| atm-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
Command Description
Obsolete command, replaced by configure ip vrf (index) user-itf port.
This command allows the operator to configure the user bridge port(IPoE) interface
(rack/shelf/Lt-slot/port/vpi:vci).
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ip vrf (index) user-itf ( no bridgeport (port-interface) ) | ( bridgeport (port-interface) [ no qos-profile |
qos-profile <Qos::QosSessionProfileName> ] )
Obsolete command, replaced by configure ip vrf (index) user-itf port.
Command Parameters
Table 24.8-1 "IP Interface User Bridge Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf index
- the VRF ID which uniquely identify a VRF
- range: [1...127]
(port-interface) Format: identification of the port or
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Table 24.8-2 "IP Interface User Bridge Port Configuration Command" Command Parameters
Parameter Type Description
[no] qos-profile Parameter type: <Qos::QosSessionProfileName> optional parameter with default
Format: value: "none"
( none qos profile name
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Command Description
This command allows the operator to create a user gateway interface. When a VRF is created, an autogenerated
entry is added to the VRF IP interface table. The operator can then associate multiple IP addresses with this
interface.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 24.9-1 "IP User Gateway Interface VRF Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf index
- the VRF ID which uniquely identify a VRF
- range: [1...127]
(ip-address) Format: inet-address
<Ip::V4Address> / <Ip::PrefixLength>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLength>
- IP address prefix length
- range: [0...30]
Command Description
This command allows the operator to create or delete an indirect or direct route toward the network and a direct
route toward the user side. The next-hop address must match one of the network-side IP interfaces.
Only one default route can be created per VRF. Use the address 0.0.0.0 to specify a default route.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ip vrf (index) ( no route-dest (dest-ip-address) next-hop <Ip::IfType> ) | ( route-dest (dest-ip-address)
next-hop <Ip::IfType> )
Command Parameters
Table 24.10-1 "VRF Route Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf index
- the VRF ID which uniquely identify a VRF
- range: [1...127]
(dest-ip-address) Format: inet-address with prefix
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
next-hop Parameter type: <Ip::IfType> the next hop IP-address
Format:
( direct : user-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| <Ip::V4Address> : network : vlan : <Eqpt::VlanId>
| <Ip::V4Address> : network : any
| direct : network : <Eqpt::VlanId>
| direct : user-bridgeport : <Eqpt::RackId> / <Eqpt::ShelfId>
/ <Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| direct : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| direct : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
Command Description
This commands allows the operator to create, delete, or modify a VRF context for the control plane. VRF index 0 is
reserved and cannot be created, deleted, or modified.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ip shub ( no vrf (index) ) | ( vrf (index) [ name <Vrf::ShubVrfName> ] (modeandcommstatus) [ [ no ]
forward-ttl-zero ] [ no max-routes | max-routes <Vrf::MaxRoutes> ] )
Command Parameters
Table 24.11-1 "IP SHub VRF Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf id
- the vrf id which uniquely identify a vrf
- range: [0...127]
Table 24.11-2 "IP SHub VRF Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <Vrf::ShubVrfName> optional parameter
Format: the name
- the name which uniquely identify a vrf
- length: x<=32
(modeandcommstatus) Format: mandatory parameter
( fast-path-mode : ena-user-user-com the mode and the communication
| fast-path-mode : dis-user-user-com status for the vrf
| slow-path-mode )
Possible values:
- fast-path-mode : set fast-path mode
- slow-path-mode : set slow-path mode
Possible values:
- ena-user-user-com : set user to user comm via service-hub
- dis-user-user-com : unset user to user comm
[no] forward-ttl-zero Parameter type: boolean optional parameter
enable packet forwarding when
ttl=0
[no] max-routes Parameter type: <Vrf::MaxRoutes> optional parameter with default
Format: value: "no-limit"
( no-limit maximum number of entries in
| <Vrf::MaxRoutes> ) the routing table
Command Description
This command allows the operator to configure the route map in the IP SHub.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ip shub vrf (index) routing-option ( no route-map (dest-ip) source-proto <Ip::SourceProto> ) | (
route-map (dest-ip) source-proto <Ip::SourceProto> (export) dest-proto <Ip::DestProto> )
Command Parameters
Table 24.12-1 "IP SHub VRF Route Map Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf id
- the vrf id which uniquely identify a vrf
- range: [0...127]
(dest-ip) Format: ip address and mask of the
<Ip::V4Address> / <Ip::IpPrefixLengthInv> destination route
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::IpPrefixLengthInv>
- IP address prefix length
- range: [0...32]
source-proto Parameter type: <Ip::SourceProto> source routing protocol
Format:
( any
| static
| rip
| ospf )
Possible values:
- any : any routing protocol
- static : static routing
- rip : berkeley rip or rip2
- ospf : open shortest path first
Table 24.12-2 "IP SHub VRF Route Map Command" Command Parameters
Parameter Type Description
(export) Format: mandatory parameter
( permit route allowed for export
| deny )
Possible values:
Command Description
Obsolete command, replaced by configure ip shub routing-option preference route-type.
This command allows the operator to specify the preference for the route learned by the dynamic routing protocols.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ip shub vrf (index) routing-option preference route-type (index) [ value <Vrf::ShubProtPref> ]
Obsolete command, replaced by configure ip shub routing-option preference route-type.
Command Parameters
Table 24.13-1 "IP SHub VRF Route Preference Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf id
- the vrf id which uniquely identify a vrf
- range: [0...127]
(index) Format: the routing protocol id
( static
| rip
| ospf )
Possible values:
- static : static route
- rip : RIPv2 protocol
- ospf : open shortest path first
Table 24.13-2 "IP SHub VRF Route Preference Command" Command Parameters
Parameter Type Description
value Parameter type: <Vrf::ShubProtPref> optional parameter
Format: the preference for the route
- the preference for the route
- range: [1...254]
Command Description
This command allows the operator to create, delete, or modify a VRF context for the control plane. VRF index 0 is
reserved and cannot be created, deleted, or modified.
The IP address of the route destination must be of the type x.x.x.0/24.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ip shub vrf (index) ( no route-dest (dest) next-hop <Ip::NextHopV4Address> ) | ( route-dest (dest)
next-hop <Ip::NextHopV4Address> vlan-id <Vlan::VlanId> [ no metric | metric <Vrf::ShubRouteMetric> ] )
Command Parameters
Table 24.14-1 "IP SHub VRF Route Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf id
- the vrf id which uniquely identify a vrf
- range: [0...127]
(dest) Format: the destination ip address and
<Ip::V4Address> / <Ip::PrefixLengthFull> mask of this route
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
next-hop Parameter type: <Ip::NextHopV4Address> the next hop ip address of this
Format: route
( direct
| <Ip::V4Address> )
Possible values:
- direct : direct ip-address
Field type <Ip::V4Address>
- IPv4-address
Table 24.14-2 "IP SHub VRF Route Configuration Command" Command Parameters
Parameter Type Description
vlan-id Parameter type: <Vlan::VlanId> mandatory parameter
Format: The parameter is not visible
- vlan id during modification.
- range: [1...4093] vlan id
Command Description
This commands allows the operator to configure the arp related parameters per VRF.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 24.15-1 "IP SHub VRF ARP Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf id
- the vrf id which uniquely identify a vrf
- range: [0...127]
Table 24.15-2 "IP SHub VRF ARP Configuration Command" Command Parameters
Parameter Type Description
[no] max-arp-entries Parameter type: <Vrf::MaxArpEntries> optional parameter with default
Format: value: -1
- maximum number of arp entries maximum number of arp entries
- range: [-1...5120] learned per vrf. i.c.o -1 the
maximum value is selected
Command Description
This command allows the operator to configure the IP SHub ARP parameters.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 24.16-2 "IP SHub ARP Configuration Command" Command Parameters
Parameter Type Description
cache-timeout Parameter type: <Ip::ArpCacheTimeOut> obsolete parameter that will be
Format: ignored
- time after which the entry in cache is removed time after which the entry in
- range: [30...86400] cache is removed
cache-pending Parameter type: <Ip::ArpCachePendingTime> obsolete parameter that will be
Format: ignored
- time an unresolved entry will be held in cache time an unresolved entry will be
- range: [30...3000] held in cache
cache-refresh Parameter type: <Ip::ArpCacheRefreshTime> obsolete parameter that will be
Format: ignored
- refresh interval for next hop ARP cache entries. refresh interval for next hop ARP
- range: [30...3600] cache entries
cache-retry-time Parameter type: <Ip::ArpCacheRetryTime> obsolete parameter that will be
Format: ignored
- retry time for next hop ARP cache entries retry time for next hop ARP
- range: [1...60] cache entries
max-retry-itvl Parameter type: <Ip::ArpCacheMaxRetryTime> obsolete parameter that will be
Format: ignored
- max retry time for next hop ARP cache entries max retry time for next hop ARP
- range: [600...18000] cache entries
max-retries Parameter type: <Ip::ArpMaxRetries> obsolete parameter that will be
Format: ignored
- max number of retry attempts maximum number of retry
- range: [2...10] attempts for ARP resolution
Command Description
This command allows the operator to configure the IP SHub ARP parameters for each VLAN.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 24.17-1 "IP SHub ARP per VLAN Configuration Command " Resource Parameters
Resource Identifier Type Description
(vlanid) Format: the vlan id
- vlan id
- range: [1...4093]
Table 24.17-2 "IP SHub ARP per VLAN Configuration Command " Command Parameters
Parameter Type Description
[no] gratuitous-arp Parameter type: boolean optional parameter
process gratuitous broadcast ARP
messages
Command Description
This command allows the operator to specify the preference for the route learned by the dynamic routing protocols.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 24.18-1 "IP SHub VRF Route Preference Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the routing protocol id
( static
| rip
| ospf )
Possible values:
- static : static route
- rip : RIPv2 protocol
- ospf : open shortest path first
Table 24.18-2 "IP SHub VRF Route Preference Command" Command Parameters
Parameter Type Description
value Parameter type: <Vrf::ShubProtPref> optional parameter
Format: the preference for the route
- the preference for the route
- range: [1...254]
Description
This chapter gives an overview of nodes that are handled by "ARP-RELAY Configuration Commands".
Command Tree
----configure
----arp-relay
----[no] statistics
- (vlan-port)
Command Description
This command allows the operator to enable/disable the detailed arp-relay statistics.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 25.2-1 "Arp-Relay Statistics Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-port) Format: The vlan-port interface
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
Description
This chapter gives an overview of nodes that are handled by "IGMP Configuration Commands".
Command Tree
----configure
----igmp
----[no] channel
- (port)
- [no] perm-pkg-bitmap
- [no] max-num-group
- [no] mode
X (cac-disable)
X (ip-anti-spoof-dis)
- [no] igmp-version
- [no] forking
- [no] lt-ont-signaling
- [no] mc-pbit-value
- [no] mcast-vlan-id
- [no] mc-vlan-xlate
- [no] mcast-svc-context
- [no] max-msg-rate
----[no] fullview-packages
- (package)
----[no] preview-packages
- (package)
----package
- (index)
- [no] name
- [no] template-name
- [no] template-version
----system
- [no] src-ip-address
- [no] verify-checksum
- [no] query-interval
- [no] max-rsp-time
- [no] robustness
- [no] mem-query-int
- [no] last-memb-cnt
- [no] last-max-resp-tim
- [no] host-report-intv
- [no] start
- [no] preview-valid
- [no] cdr-validation
- [no] cdr-generation
- [no] except-cdr-rate
- [no] cdr-export
- [no] cdr-file-aging
- [no] cdr-polling
- [no] user-igmp-version
- [no] netw-igmp-version
- [no] v3-max-num-rec
- [no] forking
- [no] lt-ont-signaling
- [no] vlan-selection
- [no] disc-lwr-version
----cdr-type
- [no] periodic
- [no] period
- [no] attempt-max-pview
- [no] attempt-blackout
- [no] attempt-no-perm
----[no] vlan
- (vlan-id)
- netw-igmp-version
- [no] v3-max-num-rec
----shub
----igs-system
- [no] start-snooping
- [no] enable-snooping
- self-ip-addr-mode
- [no] self-ip-addr
X trace-selection
- [no] router-purge-intv
- [no] host-purge-intv
- [no] max-mcast-learn
- [no] glb-leave
- [no] reduced-resp-int
- [no] remove-root-int
- [no] full-flooding-off
----response-timer
- (vlan-id)
- [no] leave-rsp-timer
----[no] vlan-router-port
- (vlan-id)
- network-port
----vlan-filter
- (filter-id)
- [no] snoop-filter
- [no] igmp-version
- [no] operation-mode
- [no] self-ip-addr-mode
- [no] self-ip-addr
- [no] querier
- [no] query-int
- [no] v2-max-rsp-time
- [no] v3-max-rsp-time
- [no] v3-max-num-rec
- [no] drop-rpt-network
- [no] robustness
- [no] unsolicit-rpt-int
- [no] retry-count
----[no] vlan-enhance-perf
- (vlan-id)
- [no] pkt-fwd-state
----[no] bundle
- (bundle)
- [no] bandwidth
- [no] max-num-channel
----[no] mc-vlan-xlate
- (nwvlan)
- ponvlan
----[no] mc-pon-vlan-xlate
- (pon)
- nwvlan
- ponvlan
----[no] mcast-svc-context
- (name)
Command Description
This command allows the operator to create and configure the IGMP channel parameters.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.2-1 "IGMP Channel Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identification of the port, vlanport
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / or virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
Command Description
This command allows the operator to configure the IGMP channel permission package members.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.3-1 "IGMP Channel Permission Package Members Configuration Command" Resource
Parameters
Resource Identifier Type Description
(port) Format: identification of the port, vlanport
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / or virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
Command Description
This command allows the operator to configure the IGMP channel preview package members.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.4-1 "IGMP Channel Preview Package Members Configuration Command" Resource
Parameters
Resource Identifier Type Description
(port) Format: identification of the port, vlanport
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / or virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
Command Description
This command allows the operator to configure IGMP package bitmaps. The package is intended primarily for use
by a network/element manager, such as an AMS, to support multiple sets of packages in different regions.
A package is a group of zero or more multicast sources that share a common access permission. Grouping the
source channels into one or more packages provides flexibility for the service provider to deliver different levels of
services to the end users; for example, "Basic Package", "Middle-Tier Package", and "Premium Package".
NOTE:There is no requirement to configure the package. If the package is modified, there is no effect on the
multicast source.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.5-1 "IGMP Package Bitmaps Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the package
- index of the package
- range: [1...1024]
Table 26.5-2 "IGMP Package Bitmaps Configuration Command" Command Parameters
Parameter Type Description
[no] name Parameter type: <Igmp::igmpPackageName> optional parameter with default
Format: value: ""
- a printable string name of the package
- length: x<=32
[no] template-name Parameter type: <Igmp::igmpPackageTemplateName> optional parameter with default
Format: value: ""
- a printable string name of the service template
- length: x<=32 containing this pkg
[no] template-version Parameter type: <Igmp::igmpPackageTemplateVersion> optional parameter with default
Format: value: 0
- version of the service template containing this package version of the service template
Command Description
This command allows the operator to configure the IGMP parameters that are globally applicable to the Node.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.6-2 "IGMP System Configuration Command" Command Parameters
Parameter Type Description
[no] src-ip-address Parameter type: <Ip::V4Address> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address source ip addr which is tx in
every mcast IP datagram
[no] verify-checksum Parameter type: boolean optional parameter
verification performed on Rx
IGMP frame
[no] query-interval Parameter type: <Igmp::SystemQueryInterval> optional parameter with default
Format: value: 125
- interval at which general membership queries transmitted interval at which general
- unit: sec membership queries transmitted
- range: [2...3175]
[no] max-rsp-time Parameter type: <Igmp::SystemQueryMaxResponseTime> optional parameter with default
Format: value: 100
- max query resp time advertised in IGMPv2 queries max query response time
Command Description
This command allows the operator to configure the IGMP system Call Detail Record
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.7-2 "IGMP System CDR Type Configuration Command" Command Parameters
Parameter Type Description
[no] periodic Parameter type: boolean optional parameter
interim CDR records generated
for fullview/preview
[no] period Parameter type: <Igmp::IntermGenCDRPeriod> optional parameter with default
Format: value: 15
- intermediate CDR generation period, in multiples of 5 intermediate CDR generation
- unit: min period
- range: [15...60]
[no] attempt-max-pview Parameter type: boolean optional parameter
CDR generated when max nbr
preview exceeded is true
[no] attempt-blackout Parameter type: boolean optional parameter
CDR generated allowed when
blackout period is active
[no] attempt-no-perm Parameter type: boolean optional parameter
CDR generated to join a mcast
with no access rights
Command Description
This command allows the operator to configure the IGMP parameters on a per Vlan basis.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.8-1 "IGMP Vlan System Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: index of the system vlan
- vlan index
- range: [1...4093]
Table 26.8-2 "IGMP Vlan System Configuration Command" Command Parameters
Parameter Type Description
netw-igmp-version Parameter type: <Igmp::VlanV3ProcessStatus> mandatory parameter
Format: IGMP version of the protocol
(2
|3)
Possible values:
- 2 : IGMP version2
- 3 : IGMP version3
[no] v3-max-num-rec Parameter type: <Igmp::V3MaxNumRecordReport> optional parameter with default
Format: value: 3
- max num of group records in one IGMPv3 report (2 exp N) max num of group records in one
- range: [0...10] IGMPv3 report (2 exp N)
Command Description
This command allows the operator to configure the IGS system-related parameters.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.9-2 "SHub IGMP IGS System Configuration Command" Command Parameters
Parameter Type Description
[no] start-snooping Parameter type: boolean optional parameter
start the snooping module
[no] enable-snooping Parameter type: boolean optional parameter
enable snooping in the system
self-ip-addr-mode Parameter type: <Igmp::SelfIpAddressMode> optional parameter
Format: sets the mode through which IP
( configure address can be got
| from-ip )
Possible values:
- configure : query by configure
- from-ip : query by ip
[no] self-ip-addr Parameter type: <Ip::V4Address> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address The parameter is not visible
during creation.
source address while sending
IGMP query
trace-selection Parameter type: <SignedInteger> obsolete parameter that will be
Format: ignored
- a signed integer specifies what will be traced
Command Description
This command allows the operator to configure the SHub response timer for each VLAN.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.10-1 "SHub IGMP Response Timer Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: VlanId for the leave response
- vlan id timer
- range: [1...4093]
Table 26.10-2 "SHub IGMP Response Timer Configuration Command" Command Parameters
Parameter Type Description
[no] leave-rsp-timer Parameter type: <Igmp::LeaveResponse> optional parameter with default
Format: value: 1
- time intvl(secs) before sending leave message to router interval to wait for query
- range: [0...10] response from host
Command Description
This command allows the operator to configure the reachable router port.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.11-1 "SHub IGMP Router Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: the id of a vlan for which a
- vlan id network port is reachable
- range: [1...4093]
network-port Parameter type: <Shub::NetworkPort> the network port that is reachable
Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Command Description
This command allows the operator to configure the VLAN filter status to enable or disable IGMP snooping on that
specific VLAN.
Guidelines to configure "self-ip-addr" and "self-ip-addr-mode" (optional parameters in this command) :
• configure self-ip-addr : The configuration of "self-ip-addr" is dependent on the value of the
"self-ip-addr-mode". When the self-ip-addr-mode has been set to "conf-ip-addr", it is allowed to configure the
"self-ip-addr". In all other cases, the configuration of the "self-ip-addr" will be rejected.
• configure self-ip-addr-mode as "inherit-ip-intf" or "inherit-system" : The configuration of the ip-address at
interface shub ip level or system level is a precondition when setting the options "inherit-ip-intf" or
"inherit-system". The configuration of an inherit option will be rejected if the related precondition is not
fullfilled.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.12-1 "SHub IGMP VLAN Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(filter-id) Format: Vlan Id for which IGMP features
- vlan id for igmp filter is to be disabled
- range: [1...4093]
Table 26.12-2 "SHub IGMP VLAN Filter Configuration Command" Command Parameters
Parameter Type Description
[no] snoop-filter Parameter type: boolean optional parameter
enable the snoop filter
Command Description
This command allows the operator to configure a specific to the Enhanced Performance IGMP snooping
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.13-1 "Shub IGMP Vlan enhanced performance Configuration Command" Resource
Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
Table 26.13-2 "Shub IGMP Vlan enhanced performance Configuration Command" Command
Parameters
Parameter Type Description
[no] pkt-fwd-state Parameter type: <Igmp::PktFwdState> optional parameter with default
Format: value: "disabled"
( enabled enable/disable,colord report msg
| disabled ) to be forwded in upstrm
Possible values:
- enabled : colored the report messages will be forward in
the upstream
- disabled : colored the report messages will not be
forwarded in the upstream
Command Description
This command allows the operator to configure igmp CAC BUNDLE.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> configure igmp shub ( no bundle (bundle) ) | ( bundle (bundle) [ no bandwidth | bandwidth
<Igmp::BundleBandWidth> ] [ no max-num-channel | max-num-channel <Igmp::BundleMaxChannel> ] )
Command Parameters
Table 26.14-1 "Shub IGMP CAC BUNDLE TABLE Configuration Command" Resource
Parameters
Resource Identifier Type Description
(bundle) Format: name of this bundle
- the name of the bundle
- length: x<=32
Table 26.14-2 "Shub IGMP CAC BUNDLE TABLE Configuration Command" Command
Parameters
Parameter Type Description
[no] bandwidth Parameter type: <Igmp::BundleBandWidth> optional parameter with default
Format: value: 0
- max bandwidth for this bundle max bandwidth for this bundle
- unit: kbps
- range: [0...2147483647]
[no] max-num-channel Parameter type: <Igmp::BundleMaxChannel> optional parameter with default
Format: value: 0
- max allowed channels for this bundle max allowed channels for this
- range: [0...1024] bundle
Command Description
This command allows the operator configure source-pon vlan translation.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.15-1 "IGMP Multicast Vlan Translation Command" Resource Parameters
Resource Identifier Type Description
(nwvlan) Format: identification of the network-side
- the multicast vlan id virtual lan
- range: [2...4093]
Table 26.15-2 "IGMP Multicast Vlan Translation Command" Command Parameters
Parameter Type Description
ponvlan Parameter type: <Igmp::mcPonVlanId> mandatory parameter
Format: identification of the pon-side
- vlan index virtual lan
- range: [1...4093]
Command Description
This command allows the operator configure source-pon vlan translation on pon port.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> configure igmp ( no mc-pon-vlan-xlate (pon) nwvlan <Igmp::mcSrcVlanId> ) | ( mc-pon-vlan-xlate (pon) nwvlan
<Igmp::mcSrcVlanId> ponvlan <Igmp::mcPonVlanId> )
Command Parameters
Table 26.16-1 "IGMP Multicast Pon Vlan Translation Command" Resource Parameters
Resource Identifier Type Description
(pon) Format: identification of the pon interface
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier
nwvlan Parameter type: <Igmp::mcSrcVlanId> identification of the network-side
Format: virtual lan
- the multicast vlan id
- range: [2...4093]
Table 26.16-2 "IGMP Multicast Pon Vlan Translation Command" Command Parameters
Parameter Type Description
ponvlan Parameter type: <Igmp::mcPonVlanId> mandatory parameter
Format: identification of the pon-side
- vlan index virtual lan
- range: [1...4093]
Command Description
This command allows the operator to configure multicast service context
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.17-1 "Igmp Multicast Service Context Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: A unique profile name for the
- a profile name service context
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Description
This chapter gives an overview of nodes that are handled by "Multicast Configuration Commands".
Command Tree
----configure
----mcast
----general
- [no] fast-change
- [no] pkg-memb-bitmap
- [no] max-bitrate
- [no] mean-bit-rate
----[no] package-member
- (package)
----capacity
- [no] max-num-group
- [no] max-num-uncfg
- [no] cfg-res-time
- [no] uncfg-res-time
----X [no] channel
- (grp-ip-addr)
- src-ip-addr
- [no] dis-fast-change
- [no] pkg-mem-bitmap
- [no] name
- [no] guaranteed-serv
- [no] peak-bit-rate
- vlan-id
- [no] service-name
- [no] preview-duration
- [no] preview-number
- [no] preview-blackout
----[no] packagemember
- (package)
----[no] chn
- (grp-ip-addr)
- src-ip-addr
- vlan-id
- [no] end-ip-addr
- [no] mcast-svc-context
- [no] dis-fast-change
- [no] pkg-mem-bitmap
- [no] name
- [no] guaranteed-serv
- [no] peak-bit-rate
- [no] service-name
- [no] preview-duration
- [no] preview-number
- [no] preview-blackout
----[no] packagemember
- (package)
----monitor
----[no] src
- (grp-ip-addr)
- src-ip-addr
- [no] loss-duration
- [no] loss-thresh-alert
----[no] chn
- (grp-ip-addr)
- src-ip-addr
- vlan-id
- [no] loss-duration
- [no] loss-thresh-alert
----static
----[no] branch
- (grp-ip-addr)
- src-ip-addr
- port
----shub
X active-streams
- [no] max-bw
- [no] max-no-rate-based
----[no] mcast-addr
- (mcast-addr)
- vlan-id
----[no] egress-port
- (port)
----[no] src
- (src)
- vlan-id
- ip-addr
- [no] eth-sus-bit-rate
- [no] guaranteed-serv
- [no] bundle
Command Description
This command allows the operator to configure general multicast parameters.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 27.2-2 "Multicast General Group Configuration Command" Command Parameters
Parameter Type Description
[no] fast-change Parameter type: boolean optional parameter
enable fast channel change
[no] pkg-memb-bitmap Parameter type: <Igmp::PkgMemBitMap> optional parameter with default
Format: value: "ff : ff : ff : ff : ff : ff : ff : ff
- a binary string : ff : ff : ff : ff : ff : ff : ff : ff : ff :
- length: 128 ff : ff : ff : ff : ff : ff : ff : ff : ff : ff
: ff : ff : ff : ff : ff : ff : ff : ff : ff :
ff : ff : ff : ff : ff : ff : ff : ff : ff : ff
: ff : ff : ff : ff : ff : ff : ff : ff : ff :
ff : ff : ff : ff : ff : ff : ff : ff : ff : ff
: ff : ff : ff : ff : ff : ff : ff : ff : ff :
ff : ff : ff : ff : ff : ff : ff : ff : ff : ff
: ff : ff : ff : ff : ff : ff : ff : ff : ff :
ff : ff : ff : ff : ff : ff : ff : ff : ff : ff
: ff : ff : ff : ff : ff : ff : ff : ff : ff :
ff : ff : ff : ff : ff : ff : ff : ff : ff : ff
: ff : ff : ff : ff : ff : ff"
package(s) a class D address
belongs
[no] max-bitrate Parameter type: <Igmp::GeneralMcastMaxBitRate> optional parameter with default
Format: value: 2500
- reasonable max bitrate in ATM level for upstream reasonable downstream max
- unit: kbps bitrate in ATM level
- range: [0...100000]
Command Description
This command allows the operator to configure the IGMP general multicast package members.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 27.3-1 "General Multicast Package Members Configuration Command" Resource
Parameters
Resource Identifier Type Description
(package) Format: package member
- the package number
- range: [1...1024]
Command Description
This command allows the operator to configure the multicast capacity parameters.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 27.4-2 "Multicast Capacity Configuration Command" Command Parameters
Parameter Type Description
[no] max-num-group Parameter type: <Igmp::McastCapacityMaxNumGroup> optional parameter with default
Format: value: 1024
- no of groups the system can support in enough bandwidth max number of groups the system
- range: [0...2048] (per LT) supports in enough
bandwidth
[no] max-num-uncfg Parameter type: <Igmp::McastCapacityMaxNumUnCfg> optional parameter with default
Format: value: 64
- no of uncfg grps,system can support in enough bandwidth max number of uncfg groups the
- range: [0...1024] system (per LT) supports in
enough bandwidth
[no] cfg-res-time Parameter type: optional parameter with default
<Igmp::multicastCapacityCfgSourceReserveTime> value: 125
Format: time to reserve the unused
- time to reserve guaranteed configured groups
- unit: sec
- range: [0...2147483647]
[no] uncfg-res-time Parameter type: optional parameter with default
<Igmp::multicastCapacityUnCfgSourceReserveTime> value: 0
Format: time to reserve the unused
- time to reserve unconfigured groups
- unit: sec
- range: [0...2147483647]
Command Description
Obsolete command, replaced by configure mcast chn.
This command allows the operator to configure the multicast channel.
Note:Mcast channel can not be deleted when VlanSelection is enabled.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> configure mcast ( no channel (grp-ip-addr) src-ip-addr <Ip::V4Address> ) | ( channel (grp-ip-addr) src-ip-addr
<Ip::V4Address> [ [ no ] dis-fast-change ] [ no pkg-mem-bitmap | pkg-mem-bitmap <Igmp::PkgMemBitMap> ] [
no name | name <Igmp::multicastSrcName> ] [ [ no ] guaranteed-serv ] [ no peak-bit-rate | peak-bit-rate
<Igmp::McastSrcEtherPeakBitRate> ] vlan-id <Igmp::McastSrcVLANID> [ no service-name | service-name
<Igmp::multicastSrcServiceName> ] [ no preview-duration | preview-duration
<Igmp::multicastSrcMaxPreDuration> ] [ no preview-number | preview-number
<Igmp::multicastSrcMaxPreNumber> ] [ no preview-blackout | preview-blackout
<Igmp::multicastSrcPreBlackout> ] )
Obsolete command, replaced by configure mcast chn.
Command Parameters
Table 27.5-1 "Multicast Channel Configuration Command" Resource Parameters
Resource Identifier Type Description
(grp-ip-addr) Format: ip address identifying the
- multicast-address (range: 224.0.0.3....239.255.255.255) multicast group
src-ip-addr Parameter type: <Ip::V4Address> ip address of the multicast server
Format: originating the multicast
- IPv4-address channel,value 0.0.0.0 means
ASM(any-src-ip-addr),range:0.0.0.0....22
Table 27.5-2 "Multicast Channel Configuration Command" Command Parameters
Parameter Type Description
[no] dis-fast-change Parameter type: boolean optional parameter
disable fast channel change
[no] pkg-mem-bitmap Parameter type: <Igmp::PkgMemBitMap> optional parameter with default
Format: value: "01 : 00 : 00 : 00 : 00 : 00
- a binary string : 00 : 00 : 00 : 00 : 00 : 00 : 00 :
- length: 128 00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
Command Description
This command allows the operator to configure the multicast channel package members.
A multicast channel can be member of maximum 20 packages or be member of all (1024) packages, any value in
between will be rejected.
Using this command packages will be added or removed from/to the list of packages of which the multicast channel
is currently a member.
If the multicast channel is member of all packages care must be taken when removing packages, meaning that the
command will only be accepted if after execution the multicast channel will be member of 20 packages or less.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 27.6-1 "Multicast Channel Package Members Configuration Command" Resource
Parameters
Resource Identifier Type Description
(grp-ip-addr) Format: ip address identifying the
- multicast-address (range: 224.0.0.3....239.255.255.255) multicast group
src-ip-addr Parameter type: <Ip::V4Address> ip address of the multicast server
Format: originating the multicast
- IPv4-address channel,value 0.0.0.0 means
ASM(any-src-ip-addr),range:0.0.0.0....22
(package) Format: package member
- the package number
- range: [1...1024]
Command Description
This command allows the operator to configure the multicast channel.
Note:Mcast channel can not be deleted when VlanSelection is enabled.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> configure mcast ( no chn (grp-ip-addr) src-ip-addr <Ip::V4Address> vlan-id <Igmp::McastChannelVlan> ) | ( chn
(grp-ip-addr) src-ip-addr <Ip::V4Address> vlan-id <Igmp::McastChannelVlan> [ no end-ip-addr | end-ip-addr
<Ip::V4Address> ] [ no mcast-svc-context | mcast-svc-context <Igmp::McastSvcCtxtName> ] [ [ no ]
dis-fast-change ] [ no pkg-mem-bitmap | pkg-mem-bitmap <Igmp::PkgMemBitMap> ] [ no name | name
<Igmp::multicastSrcName> ] [ [ no ] guaranteed-serv ] [ no peak-bit-rate | peak-bit-rate
<Igmp::McastSrcEtherPeakBitRate> ] [ no service-name | service-name <Igmp::multicastSrcServiceName> ] [ no
preview-duration | preview-duration <Igmp::multicastSrcMaxPreDuration> ] [ no preview-number |
preview-number <Igmp::multicastSrcMaxPreNumber> ] [ no preview-blackout | preview-blackout
<Igmp::multicastSrcPreBlackout> ] )
Command Parameters
Table 27.7-1 "Multicast Channel Configuration Command" Resource Parameters
Resource Identifier Type Description
(grp-ip-addr) Format: ip address identifying the
- multicast-address (range: 224.0.0.3....239.255.255.255) multicast group
src-ip-addr Parameter type: <Ip::V4Address> ip address of the multicast server
Format: originating the multicast
- IPv4-address channel,value 0.0.0.0 means
ASM(any-src-ip-addr),range:0.0.0.0....22
vlan-id Parameter type: <Igmp::McastChannelVlan> vlanid of the multicast channel
Format: which is configured in it
- vlan id for multicast
- range: [1...4093]
Table 27.7-2 "Multicast Channel Configuration Command" Command Parameters
Parameter Type Description
[no] end-ip-addr Parameter type: <Ip::V4Address> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address The parameter is not visible
during modification.
end ip address of the range of
multicast addresses starting from
Command Description
This command allows the operator to configure the multicast channel package members.
A multicast channel can be member of maximum 20 packages or be member of all (1024) packages, any value in
between will be rejected.
Using this command packages will be added or removed from/to the list of packages of which the multicast channel
is currently a member.
If the multicast channel is member of all packages care must be taken when removing packages, meaning that the
command will only be accepted if after execution the multicast channel will be member of 20 packages or less.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 27.8-1 "Multicast Channel Package Members Configuration Command" Resource
Parameters
Resource Identifier Type Description
(grp-ip-addr) Format: ip address identifying the
- multicast-address (range: 224.0.0.3....239.255.255.255) multicast group
src-ip-addr Parameter type: <Ip::V4Address> ip address of the multicast server
Format: originating the multicast
- IPv4-address channel,value 0.0.0.0 means
ASM(any-src-ip-addr),range:0.0.0.0....22
vlan-id Parameter type: <Igmp::McastChannelVlan> vlanid of the multicast channel
Format: which is configured in it
- vlan id for multicast
- range: [1...4093]
(package) Format: package member
- the package number
- range: [1...1024]
Command Description
This command allows the operator to configure on demand monitoring for a specified multicast stream.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> configure mcast monitor ( no src (grp-ip-addr) src-ip-addr <Ip::V4Address> ) | ( src (grp-ip-addr) src-ip-addr
<Ip::V4Address> [ no loss-duration | loss-duration <Igmp::LossDuration> ] [ no loss-thresh-alert | loss-thresh-alert
<Igmp::LossThreshold> ] )
Command Parameters
Table 27.9-1 "Multicast Monitoring Source Configuration Command" Resource Parameters
Resource Identifier Type Description
(grp-ip-addr) Format: mcast src address in network-byte
- multicast-address (range: 224.0.0.3....239.255.255.255, order(big-endian)
except for 224.0.0.22)
src-ip-addr Parameter type: <Ip::V4Address> Unicast IP address in case SSM
Format: multicast channel, value 0.0.0.0
- IPv4-address means ASM(any-src-ip-addr)
Table 27.9-2 "Multicast Monitoring Source Configuration Command" Command Parameters
Parameter Type Description
[no] loss-duration Parameter type: <Igmp::LossDuration> optional parameter with default
Format: value: 15
- duration set the duration to count packets
- unit: sec
- range: [5...2147483647]
[no] loss-thresh-alert Parameter type: <Igmp::LossThreshold> optional parameter with default
Format: value: 0
- the threshold for loss of traffic alert, 0 - disable set loss of traffic threshold, alert
- range: [0...4294967295] generated if packet count is less
or equal to the threshold.
Command Description
This command allows the operator to configure on demand monitoring for a specified multicast stream.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> configure mcast monitor ( no chn (grp-ip-addr) src-ip-addr <Ip::V4Address> vlan-id <Igmp::McastMonitorVlan>
) | ( chn (grp-ip-addr) src-ip-addr <Ip::V4Address> vlan-id <Igmp::McastMonitorVlan> [ no loss-duration |
loss-duration <Igmp::LossDuration> ] [ no loss-thresh-alert | loss-thresh-alert <Igmp::LossThreshold> ] )
Command Parameters
Table 27.10-1 "Multicast Monitoring Channel Configuration Command" Resource Parameters
Resource Identifier Type Description
(grp-ip-addr) Format: mcast src address in network-byte
- multicast-address (range: 224.0.0.3....239.255.255.255, order(big-endian)
except for 224.0.0.22)
src-ip-addr Parameter type: <Ip::V4Address> Unicast IP address in case SSM
Format: multicast channel, value 0.0.0.0
- IPv4-address means ASM(any-src-ip-addr)
vlan-id Parameter type: <Igmp::McastMonitorVlan> vlanid of the multicast channel.
Format: Value 0 means any VLAN ID
- vlan id for multicast
- range: [0...4093]
Table 27.10-2 "Multicast Monitoring Channel Configuration Command" Command Parameters
Parameter Type Description
[no] loss-duration Parameter type: <Igmp::LossDuration> optional parameter with default
Format: value: 15
- duration set the duration to count packets
- unit: sec
- range: [5...2147483647]
[no] loss-thresh-alert Parameter type: <Igmp::LossThreshold> optional parameter with default
Format: value: 0
- the threshold for loss of traffic alert, 0 - disable set loss of traffic threshold, alert
- range: [0...4294967295] generated if packet count is less
or equal to the threshold.
Command Description
This command allow the operator to configure the static multicast branch. When at least one static multicast
branch is created, the corresponding static multicast root is created.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> configure mcast static ( no branch (grp-ip-addr) src-ip-addr <Ip::V4Address> port <Itf::VlanPort> ) | ( branch
(grp-ip-addr) src-ip-addr <Ip::V4Address> port <Itf::VlanPort> )
Command Parameters
Table 27.11-1 "Multicast Static Branch Configuration Command" Resource Parameters
Resource Identifier Type Description
(grp-ip-addr) Format: ip address identifying the
- multicast-address (range: 224.0.0.3....239.255.255.255) multicast group
src-ip-addr Parameter type: <Ip::V4Address> ip address of the multicast server
Format: originating the multicast channel,
- IPv4-address value 0.0.0.0 means
ASM(any-src-ip-addr),range:0.0.0.0....22
port Parameter type: <Itf::VlanPort> identification of the vlanport
Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
Command Description
This command allows the operator to configure the system-wide uplink CAC parameters.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 27.12-2 "SHub IGMP CAC Multicast System Configuration Command" Command
Parameters
Parameter Type Description
active-streams Parameter type: <Igmp::MaxMcastLearn> obsolete parameter that will be
Format: ignored
- maximum number of simultaneous active multicast streams maximum number of
- range: [0...1024] simultaneous active multicast
streams
[no] max-bw Parameter type: <Igmp::SystemMaxbandwidth> optional parameter with default
Format: value: 0
- max bandwidth for the system maximum bandwidth for the
- unit: kbps system
- range: [0...2147483647]
[no] max-no-rate-based Parameter type: <Igmp::SystemMaxNoRateBased> optional parameter with default
Format: value: 0
- max number for non configured entry max no for non config entry,only
- range: [0...1024] for dynamic mc stream
Command Description
This command allows the operator to specify entries in the IP multicast table for a specific VLAN and multicast IP
address. This configuration applies to the SHub.
The bridge uses this information to determine how to propagate a received frame.
The configuration is used to prohibit flooding of unknown multicast traffic on the specific VLAN and multicast IP
address.
The IP multicast table can hold up to 1000 entries.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> configure mcast shub ( no mcast-addr (mcast-addr) vlan-id <Vlan::VlanId> ) | ( mcast-addr (mcast-addr) vlan-id
<Vlan::VlanId> )
Command Parameters
Table 27.13-1 "SHub Static Multicast Streams Configuration Command" Resource Parameters
Resource Identifier Type Description
(mcast-addr) Format: multicast ip address
- multicast-address (range: 224.0.0.3....239.255.255.255)
vlan-id Parameter type: <Vlan::VlanId> vlan id
Format:
- vlan id
- range: [1...4093]
Command Description
This command allows the operator to specify the ports to which the traffic related to the specified multicast IP
address is to be forwarded.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> configure mcast shub mcast-addr (mcast-addr)vlan-id <Vlan::VlanId> ( no egress-port (port) ) | ( egress-port
(port) )
Command Parameters
Table 27.14-1 "SHub Static Multicast Egress Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(mcast-addr) Format: multicast ip address
- multicast-address (range: 224.0.0.3....239.255.255.255)
vlan-id Parameter type: <Vlan::VlanId> vlan id
Format:
- vlan id
- range: [1...4093]
(port) Format: egress port
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| unassigned-link : <Shub::NoExtLink> )
Possible values:
- lt : line board
- network : network port
- nt : active nt slot
- unassigned-link : unassigned external link
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Command Description
This command allows the operator to configure the CAC Multicast Source.
User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> configure mcast shub ( no src (src) vlan-id <Igmp::McastSrcVLANID> ip-addr <Ip::V4Address> ) | ( src (src)
vlan-id <Igmp::McastSrcVLANID> ip-addr <Ip::V4Address> [ no eth-sus-bit-rate | eth-sus-bit-rate
<Igmp::McastSrcEtherSustainBitRate> ] [ [ no ] guaranteed-serv ] [ no bundle | bundle
<Igmp::IgnoredBundleName> ] )
Command Parameters
Table 27.15-1 "SHub IGMP CAC Multicast Sources Configuration Command" Resource
Parameters
Resource Identifier Type Description
(src) Format: mcast src address in network-byte
- multicast-address (range: 224.0.0.3....239.255.255.255) order(big-endian)
vlan-id Parameter type: <Igmp::McastSrcVLANID> vlan for this multicast source
Format:
- VLAN for this multicast source
- range: [1...4093]
ip-addr Parameter type: <Ip::V4Address> ip address of the multicast server
Format: in network-byte order
- IPv4-address (big-endian)
Table 27.15-2 "SHub IGMP CAC Multicast Sources Configuration Command" Command
Parameters
Parameter Type Description
[no] eth-sus-bit-rate Parameter type: <Igmp::McastSrcEtherSustainBitRate> optional parameter with default
Format: value: 2125
- sustainable bit rate for transmit/downstream traffic sustainable bit rate for
- range: [0...100000] transmit/downstream traffic
[no] guaranteed-serv Parameter type: boolean optional parameter
enable guaranteed service
[no] bundle Parameter type: <Igmp::IgnoredBundleName> optional parameter with default
Format: value: "none"
( none bundle name of this source
Description
This chapter gives an overview of nodes that are handled by "PPPoX-Relay Configuration Commands".
Command Tree
----configure
----pppox-relay
----cross-connect
----global-session
- [no] pado-timeout
- [no] pads-timeout
- [no] max-pad-attempts
- [no] trans-max-age
- [no] cc-max-age
----[no] engine
- (vlan-id)
- [no] mac-addr-conc
- [no] dslf-iwf-tag
- [no] max-payload-tag
- [no] name
- [no] lock
- [no] service-name
----[no] monitor
----tca
- [no] enable
- [no] tran-ageout-15min
- [no] sess-ageout-15min
- [no] tran-ageout-1day
- [no] sess-ageout-1day
----[no] client-port
- (port)
- vlan-id
- default-priority
- [no] max-cc
- [no] qos-profile
----[no] monitor
Command Description
This command allows the operator to specify the system-wide configuration parameters applicable to all PPP
sessions.
User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 28.2-2 "PPPoX Cross-connect Global Configuration Command" Command Parameters
Parameter Type Description
[no] pado-timeout Parameter type: <PPPoX::PadTimeOut> optional parameter with default
Format: value: 3
- timeout for PAD-O PAD-S messages timeout for PAD-O message
- unit: sec
- range: [1...60]
[no] pads-timeout Parameter type: <PPPoX::PadTimeOut> optional parameter with default
Format: value: 3
- timeout for PAD-O PAD-S messages timeout for PAD-S message
- unit: sec
- range: [1...60]
[no] max-pad-attempts Parameter type: <PPPoX::PadRRetrials> optional parameter with default
Format: value: 10
- maximum number of PAD-R messages maximum number of PAD-R
- range: [1...16] messages
[no] trans-max-age Parameter type: <PPPoX::TransactionMaxAge> optional parameter with default
Format: value: 300
- maximum age of PPP transaction maximum age of PPP transaction
- unit: sec
- range: [1...300]
[no] cc-max-age Parameter type: <PPPoX::CcMaxAge> optional parameter with default
Format: value: 300
Command Description
This command allows the operator to configure the PPP cross-connect engine. The PPP cross-connect engine is
identified by a VLAN ID. The name is the name used to identify the PPP cross-connect engine. The lock command
locks or unlocks the PPP control plane. For example, if the control plane is unlocked, no new PPP
cross-connections can be established, but the existing connections remain until they are released by the PPP server
or client.
User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 28.3-1 "PPPoX Cross-connect Engine Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan identity
( <Network::UVlanIndex>
| stacked : <Network::SVlanIndex> :
<Network::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Network::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Network::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Network::CVlanIndex>
- customer vlan identity
- range: [0...4093]
Table 28.3-2 "PPPoX Cross-connect Engine Configuration Command" Command Parameters
Parameter Type Description
[no] mac-addr-conc Parameter type: boolean optional parameter
Command Description
This command allows the operator to configure the exception event counters for the PPP cross-connect engine.
User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 28.4-1 "PPPoX Cross-connect Engine Monitoring Configuration Command" Resource
Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan identity
( <Network::UVlanIndex>
| stacked : <Network::SVlanIndex> :
<Network::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Network::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Network::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Network::CVlanIndex>
- customer vlan identity
- range: [0...4093]
Command Description
This command allows the operator to configure the Threshold Crossing Alert (TCA) thresholds. The configuration
is specific per PPP CC Engine.
User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 28.5-1 "PPPCC Engine TCA Threshold Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan identity
( <Network::UVlanIndex>
| stacked : <Network::SVlanIndex> :
<Network::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Network::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Network::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Network::CVlanIndex>
- customer vlan identity
- range: [0...4093]
Table 28.5-2 "PPPCC Engine TCA Threshold Configuration Command" Command Parameters
Parameter Type Description
[no] enable Parameter type: boolean optional parameter
enable the reporting of TCA's for
this pppcc engine
Command Description
This command allows the operator to specify the PPP cross-connect client port. When creating a client port on a
vlan port, only a Cvlan may be used.
User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 28.6-1 "PPPoX Cross-connect Client Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: client port identification
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
Command Description
This command allows the operator to configure the exception event counters for the PPP cross-connect client port.
User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 28.7-1 "PPPoX Cross-connect Client Port Monitoring Configuration Command" Resource
Parameters
Resource Identifier Type Description
(port) Format: client port identification
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> :
<Eqpt::UnstackedVlan>
Description
This chapter gives an overview of nodes that are handled by "PPPoE Configuration Commands".
Command Tree
----configure
----pppoe-client
----[no] ppp-profile
- (name)
- [no] ipversion
- [no] authproto
- [no] mru
----[no] interface
- (ifindex)
- client-id
- profile-name
- username
- password
- [no] mac
- [no] pbit
Command Description
This command allows the operator to configure PPP profile parameters.
User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 29.2-1 "PPPoE Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the profile
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 29.2-2 "PPPoE Profile Configuration Command" Command Parameters
Parameter Type Description
[no] ipversion Parameter type: <PPPoE::pppProfileIpMode> optional parameter with default
Format: value: "ipv4"
( none specifying ip version during NCP
| ipv4 phase
| dual
| ipv6 )
Possible values:
- none : without NCP phase
- ipv4 : only specify ipv4 connection
- dual : specify both ipv4 and ipv6 connection
- ipv6 : only specify ipv6 connection
[no] authproto Parameter type: <PPPoE::pppProfileAuthenType> optional parameter with default
Format: value: "auto"
( auto the type of PPP authentication
| pap used
| chap )
Possible values:
- auto : auto selected by ONU
- pap : only PAP negotiation
Command Description
This command allows the operator to configure PPPoE client interface parameters.
User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.
Command Syntax
The command has the following syntax:
> configure pppoe-client ( no interface (ifindex) client-id <PPPoE::ClientId> ) | ( interface (ifindex) client-id
<PPPoE::ClientId> profile-name <PPPoE::PppProfileName> username <PPPoE::UserName> password
<PPPoE::Password> [ no mac | mac <PPPoE::MacAddress> ] [ no pbit | pbit <PPPoE::PbitValue> ] )
Command Parameters
Table 29.3-1 "PPPoE Client Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(ifindex) Format: interface index of the PPPoE
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> / client port
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
Description
This chapter gives an overview of nodes that are handled by "DHCP Relay Configuration Commands".
Command Tree
----configure
----dhcp-relay
----[no] port-stats
- (vlan-port)
----agent
- (vrfid)
- bcast-vlan
- [no] option-82
- [no] circuit-id
- [no] remote-id
- [no] client-hw-address
- [no] dhcp-linerate
----shub
- [no] relaying
----X [no] server
- (index)
- ip-addr
- server-name
----X agent
- (index)
- [no] enable-relaying
- [no] secs-threshold
- [no] hops-threshold
X [no] context-lifetime
- [no] agent-ip-addr
----instance
- (vrf-id)
- [no] relaying
- [no] secs-threshold
- [no] hops-threshold
- [no] agent-ip-addr
----[no] server
- (ip-addr)
- server-name
----[no] agent
- (ip-addr)
- [no] relaying
- name
- [no] secs-threshold
- [no] hops-threshold
----[no] server
- (ip-addr)
- name
----[no] interface
- (vlan-id)
- agent
----[no] v6-port-stats
- (vlan-port)
Command Description
This command allows the operator to configure the DHCP relay user port statistics.
User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 30.2-1 "DHCP Relay User Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-port) Format: Identification of the ip user
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / interface or vlan port
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
vrfid
The vrfid is a unique value for each VRF assigned by the management.
bcast-vlan
The bcast-vlan is an index that represents a VLAN that is used for forwarding upstream broadcast DHCP packets
when the DHCP relay agent is disabled.The default value for the bcast-vlan is zero and is created whenever an
instances of VRF is formed.The operator cannot set a value of zero as the instance creation or deletion is depended
on the VRF instance created or deleted.
option-82
The operator can enable or disable option 82 information insertion in the upstream broadcast DHCP packets.
Command Description
This command allows the operator to configure the DHCP relay agent for each VRF interface.
User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.
Command Syntax
The command has the following syntax:
> configure dhcp-relay agent (vrfid) [ bcast-vlan <Dhcp::VlanId> ] [ [ no ] option-82 ] [ no circuit-id | circuit-id
<Dhcp::CircuitId> ] [ no remote-id | remote-id <Dhcp::RemoteId> ] [ no client-hw-address | client-hw-address
<Dhcp::ChaddrMode> ] [ no dhcp-linerate | dhcp-linerate <Dhcp::Dhcp-linerate> ]
Command Parameters
Table 30.3-1 "DHCP Relay Agent Configuration Command" Resource Parameters
Resource Identifier Type Description
(vrfid) Format: vrf index
- the VRF ID which uniquely identify a VRF
- range: [1...127]
Table 30.3-2 "DHCP Relay Agent Configuration Command" Command Parameters
Parameter Type Description
bcast-vlan Parameter type: <Dhcp::VlanId> optional parameter
Format: vlan used to forward upstream
(0 bcast DHCP packets
Command Description
This command allows the operator to configure the DHCP SHub parameters.
User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 30.4-2 "DHCP Relay SHub Configuration Command" Command Parameters
Parameter Type Description
[no] relaying Parameter type: boolean optional parameter
enable relay agent
Command Description
Obsolete command, replaced by configure dhcp-relay shub instance <vrf-id>server.
This command allows the operator to configure the list of DHCP relay servers for a particular VRF.
User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.
Command Syntax
The command has the following syntax:
> configure dhcp-relay shub ( no server (index) ip-addr <Ip::V4Address> ) | ( server (index) ip-addr
<Ip::V4Address> server-name <Dhcp::RelayServerName> )
Obsolete command, replaced by configure dhcp-relay shub instance <vrf-id>server.
Command Parameters
Table 30.5-1 "DHCP Relay SHub Server Configuration Command per VRF " Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf id
- the vrf id which uniquely identify a vrf
- range: [0...127]
ip-addr Parameter type: <Ip::V4Address> IP address of the DHCP server
Format:
- IPv4-address
Table 30.5-2 "DHCP Relay SHub Server Configuration Command per VRF " Command
Parameters
Parameter Type Description
server-name Parameter type: <Dhcp::RelayServerName> mandatory parameter
Format: The name of the Relay Server
- a printable string
- length: x<=32
Command Description
Obsolete command, replaced by configure dhcp-relay shub instance <vrf-id>.
This command allows the operator to configure the DHCP relay agent to a particular VRF.
User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 30.6-1 "DHCP Relay SHub Agent Configuration Command per VRF" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf id
- the vrf id which uniquely identify a vrf
- range: [0...127]
Table 30.6-2 "DHCP Relay SHub Agent Configuration Command per VRF" Command Parameters
Parameter Type Description
[no] enable-relaying Parameter type: boolean optional parameter
enable relaying for this vrf
[no] secs-threshold Parameter type: <Dhcp::SecsThreshold> optional parameter with default
Format: value: 0
- seconds threshold the time within a request must be
- unit: second answered
- range: [0...5]
[no] hops-threshold Parameter type: <Dhcp::HopThreshold> optional parameter with default
Format: value: 4
- relay hops threshold max nbr of hops the request may
- range: [0...16] go through
[no] context-lifetime Parameter type: <Dhcp::ContextLife> obsolete parameter that will be
Format: ignored
- application context life-time for this vrf availability of application context
- unit: seconds
Command Description
This command allows the operator to configure the DHCP relay parameters for a particular VRF.
User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 30.7-1 "DHCP Relay SHub Configuration Command per VRF" Resource Parameters
Resource Identifier Type Description
(vrf-id) Format: the vrf id
- the vrf id which uniquely identify a vrf
- range: [0...127]
Table 30.7-2 "DHCP Relay SHub Configuration Command per VRF" Command Parameters
Parameter Type Description
[no] relaying Parameter type: boolean optional parameter
enable relay agent
[no] secs-threshold Parameter type: <Dhcp::SecsThreshold> optional parameter with default
Format: value: 0
- seconds threshold the time within a request must be
- unit: second answered
- range: [0...5]
[no] hops-threshold Parameter type: <Dhcp::HopThreshold> optional parameter with default
Format: value: 4
- relay hops threshold max nbr of hops the request may
- range: [0...16] go through
[no] agent-ip-addr Parameter type: <Ip::V4Address> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address agent IP address
Command Description
This command allows the operator to configure the list of DHCP relay servers for a particular VRF.
User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.
Command Syntax
The command has the following syntax:
> configure dhcp-relay shub instance (vrf-id) ( no server (ip-addr) ) | ( server (ip-addr) server-name
<Dhcp::RelayServerName> )
Command Parameters
Table 30.8-1 "DHCP Relay SHub Server Configuration Command per VRF " Resource Parameters
Resource Identifier Type Description
(vrf-id) Format: the vrf id
- the vrf id which uniquely identify a vrf
- range: [0...127]
(ip-addr) Format: IP address of the DHCP server
- IPv4-address
Table 30.8-2 "DHCP Relay SHub Server Configuration Command per VRF " Command
Parameters
Parameter Type Description
server-name Parameter type: <Dhcp::RelayServerName> mandatory parameter
Format: The name of the Relay Server
- a printable string
- length: x<=32
Command Description
This command allows the operator to configure multiple DHCP relay agent instances for a particular VRF.
User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.
Command Syntax
The command has the following syntax:
> configure dhcp-relay shub instance (vrf-id) ( no agent (ip-addr) ) | ( agent (ip-addr) [ [ no ] relaying ] name
<Dhcp::RelayAgentName> [ no secs-threshold | secs-threshold <Dhcp::SecsThreshold> ] [ no hops-threshold |
hops-threshold <Dhcp::HopThreshold> ] )
Command Parameters
Table 30.9-1 "DHCP Relay SHub Agent Instances Configuration Command per VRF " Resource
Parameters
Resource Identifier Type Description
(vrf-id) Format: the vrf id
- the vrf id which uniquely identify a vrf
- range: [0...127]
(ip-addr) Format: IP address given to this interface
- IPv4-address
Table 30.9-2 "DHCP Relay SHub Agent Instances Configuration Command per VRF " Command
Parameters
Parameter Type Description
[no] relaying Parameter type: boolean optional parameter
enable relay agent
name Parameter type: <Dhcp::RelayAgentName> mandatory parameter
Format: the dhcp relay agent name
- a printable string
- length: x<=32
[no] secs-threshold Parameter type: <Dhcp::SecsThreshold> optional parameter with default
Format: value: 0
- seconds threshold the time within a request must be
- unit: second answered
- range: [0...5]
[no] hops-threshold Parameter type: <Dhcp::HopThreshold> optional parameter with default
Format: value: 4
- relay hops threshold max nbr of hops the request may
Command Description
This command allows the operator to configure the list of DHCP relay servers for a particular VRF and a
particular DHCP relay Agent Instance.
User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.
Command Syntax
The command has the following syntax:
> configure dhcp-relay shub instance (vrf-id) agent (ip-addr) ( no server (ip-addr) ) | ( server (ip-addr) name
<Dhcp::RelayServerName> )
Command Parameters
Table 30.10-1 "DHCP Relay SHub Server Configuration Command per VRF and Agent instance"
Resource Parameters
Resource Identifier Type Description
(vrf-id) Format: the vrf id
- the vrf id which uniquely identify a vrf
- range: [0...127]
(ip-addr) Format: IP address given to this interface
- IPv4-address
(ip-addr) Format: the servers ip-address
- IPv4-address
Table 30.10-2 "DHCP Relay SHub Server Configuration Command per VRF and Agent instance"
Command Parameters
Parameter Type Description
name Parameter type: <Dhcp::RelayServerName> mandatory parameter
Format: the name of the Relay Server
- a printable string
- length: x<=32
Command Description
This command allows the operator to associate a particular relay-agent instance for an IP interface.
User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.
Command Syntax
The command has the following syntax:
> configure dhcp-relay shub ( no interface (vlan-id) ) | ( interface (vlan-id) agent <Ip::V4Address> )
Command Parameters
Table 30.11-1 "DHCP Relay SHub Agent Interface Association Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: the vlan index
- vlan id
- range: [1...4093]
Table 30.11-2 "DHCP Relay SHub Agent Interface Association Command" Command Parameters
Parameter Type Description
agent Parameter type: <Ip::V4Address> mandatory parameter
Format: the associated ip address
- IPv4-address
Command Description
This command allows the operator to configure the DHCP v6 relay user port statistics.
User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 30.12-1 "DHCP v6 Relay User Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-port) Format: identification of vlan port
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
Description
This chapter gives an overview of nodes that are handled by "OSPF Configuration Commands".
Command Tree
----configure
----[no] ospf
- [no] enable
- [no] router-id
- [no] as-border-router
- [no] enable-opaque-lsa
- [no] overflow-state-it
- [no] dis-rfc1583-comp
- [no] abr-type
X [no] passive-interface
----[no] area
- (area-id)
----[no] interface
- (ip-addr)
- [no] disable
- [no] router-priority
- [no] passive
- [no] itf-type
- [no] authentication
----timers
- [no] transit-delay
- [no] retransmit-itvl
- [no] hello-interval
- [no] dead-interval
- [no] poll-interval
----[no] md5-key
- (index)
- key
- [no] accept-starts
- [no] generate-starts
----metric
- [no] value
----[no] aggregate-addr
- (dest-ip)
- [no] omit-advertise
----[no] extern-aggr-addr
- (dest-ip)
- [no] advertise
----[no] stub-area
- (area-id)
- [no] metric-type
- [no] metric
- [no] summary
----[no] interface
- (ip-addr)
- [no] disable
- [no] router-priority
- [no] passive
- [no] itf-type
- [no] authentication
----timers
- [no] transit-delay
- [no] retransmit-itvl
- [no] hello-interval
- [no] dead-interval
- [no] poll-interval
----[no] md5-key
- (index)
- key
- [no] accept-starts
- [no] generate-starts
----metric
- [no] value
----[no] aggregate-addr
- (dest-ip)
- [no] omit-advertise
----[no] nssa-area
- (area-id)
- [no] summary
- [no] translation
- [no] trans-itvl
- [no] asbr-rtr-trans
- [no] metric-type
----[no] interface
- (ip-addr)
- [no] disable
- [no] router-priority
- [no] passive
- [no] itf-type
- [no] authentication
----timers
- [no] transit-delay
- [no] retransmit-itvl
- [no] hello-interval
- [no] dead-interval
- [no] poll-interval
----[no] md5-key
- (index)
- key
- [no] accept-starts
- [no] generate-starts
----metric
- [no] value
----[no] aggregate-addr
- (dest-ip)
- lsa-type
- [no] omit-advertise
----[no] extern-aggr-addr
- (dest-ip)
- [no] advertise
----redistribution
- [no] enable
- [no] local
- [no] static
- [no] rip
----[no] route-destination
- (dest-ip)
- [no] metric-type
- [no] metric
Command Description
This command allows the operator to configure the OSPF parameters and attributes.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 31.2-2 "OSPF Parameters Configuration Command" Command Parameters
Parameter Type Description
[no] enable Parameter type: boolean optional parameter
enables OSPF on the SHub
[no] router-id Parameter type: <Ip::V4Address> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address uniquely identifying the Shub in
the autonomous system
[no] as-border-router Parameter type: boolean optional parameter
shub configured as a autonomous
system border router
[no] enable-opaque-lsa Parameter type: boolean optional parameter
enable opaque-capable for router
[no] overflow-state-it Parameter type: <Ospf::OvrflowIntrvl> optional parameter with default
Format: value: 120
- interval the router is in overflow state time the router attempts to leave
- unit: sec the overflow state
- range: [0...2147483647]
[no] dis-rfc1583-comp Parameter type: boolean optional parameter
LSA advertisements compatible
with RFC 1583
[no] abr-type Parameter type: <Ospf::AbrType> optional parameter with default
Format: value: "standard"
( standard type of area border router
| cisco
| ibm )
Possible values:
- standard : standard abr
- cisco : cisco abr
Command Description
This command displays information about the configured parameters and cumulative statistics for the router's
attached areas.
The area identifier is a 32-bit represented in dotted decimal notation.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 31.3-1 "OSPF Area Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
Command Description
This command allows the operator to configure an OSPF interface.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf area (area-id) ( no interface (ip-addr) ) | ( interface (ip-addr) [ [ no ] disable ] [ no router-priority |
router-priority <Ospf::Priority> ] [ [ no ] passive ] [ no itf-type | itf-type <Ospf::ITFType> ] [ no authentication |
authentication <Ospf::AuthType> ] )
Command Parameters
Table 31.4-1 "OSPF Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(ip-addr) Format: ip address identifying the
- IPv4-address interface
Table 31.4-2 "OSPF Interface Configuration Command" Command Parameters
Parameter Type Description
[no] disable Parameter type: boolean optional parameter
disable interface
[no] router-priority Parameter type: <Ospf::Priority> optional parameter with default
Format: value: 1
- priority used in router election algorithm priority used in router election
- range: [0...255] algorithm
[no] passive Parameter type: boolean optional parameter
sets the itf as passive and
overwrites the parameter at
instance level; by default will set
to 'non-passive'
[no] itf-type Parameter type: <Ospf::ITFType> optional parameter with default
Format: value: "broadcast"
( broadcast ospf interface type
| nbma
| point-point
| point-multipoint )
Possible values:
- broadcast : broadcast lans like ethernet
- nbma : non broadcast multiple access
Command Description
This command allows the operator to configure the OSPF interface timers.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf area (area-id) interface (ip-addr) timers [ no transit-delay | transit-delay <Ospf::TransDelay> ] [ no
retransmit-itvl | retransmit-itvl <Ospf::RetransIntvl> ] [ no hello-interval | hello-interval <Ospf::HelloIntvl> ] [ no
dead-interval | dead-interval <Ospf::DeadIntvl> ] [ no poll-interval | poll-interval <Ospf::PollIntvl> ]
Command Parameters
Table 31.5-1 "OSPF Interface Timers Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(ip-addr) Format: ip address identifying the
- IPv4-address interface
Table 31.5-2 "OSPF Interface Timers Configuration Command" Command Parameters
Parameter Type Description
[no] transit-delay Parameter type: <Ospf::TransDelay> optional parameter with default
Format: value: 1
- time to transmit link state packets time to transmit link update
- unit: sec packets
- range: [0...3600]
[no] retransmit-itvl Parameter type: <Ospf::RetransIntvl> optional parameter with default
Format: value: 5
- interval between LSA retransmission interval between LSA
- unit: sec retransmission
- range: [0...3600]
[no] hello-interval Parameter type: <Ospf::HelloIntvl> optional parameter with default
Format: value: 10
- interval between sending hello packets interval between sending hello
- unit: sec packets
- range: [1...65535]
[no] dead-interval Parameter type: <Ospf::DeadIntvl> optional parameter with default
Format: value: 40
Command Description
This command allows the operator to configure an MD5 key for an OSPF interface.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf area (area-id) interface (ip-addr) ( no md5-key (index) ) | ( md5-key (index) key
<Ospf::AuthTypeMd5> [ no accept-starts | accept-starts <Ospf::MD5startDelay> ] [ no generate-starts |
generate-starts <Ospf::MD5startDelay> ] )
Command Parameters
Table 31.6-1 "OSPF Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(ip-addr) Format: ip address identifying the
- IPv4-address interface
(index) Format: the number of the md5 key
- the number of the MD5 key
- range: [1...255]
Table 31.6-2 "OSPF Interface MD5 Key Configuration Command" Command Parameters
Parameter Type Description
key Parameter type: <Ospf::AuthTypeMd5> mandatory parameter
Format: the md5 key
( prompt
| plain : <Ospf::Md5Key> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Ospf::Md5Key>
- authentication key
- length: x<=16
[no] accept-starts Parameter type: <Ospf::MD5startDelay> optional parameter with default
Format: value: "now"
( now when the key must be used to
| <Sys::Time> ) accept
Command Output
Table 31.6-3 "OSPF Interface MD5 Key Configuration Command" Display parameters
Specific Information
name Type Description
accept-expires Parameter type: <Ospf::MD5expiryDelay> delay before the key expires for
( now accepting
| never This element is only shown in
| <Ospf::MD5expiryDelay> ) detail mode.
Possible values:
- now : the key will expire now
- never : the key will never expire
Field type <Ospf::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]
generate-expires Parameter type: <Ospf::MD5expiryDelay> delay before the key expires for
( now generating
| never This element is only shown in
| <Ospf::MD5expiryDelay> ) detail mode.
Possible values:
- now : the key will expire now
- never : the key will never expire
Field type <Ospf::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]
Command Description
This command allows the operator to configure the metric on an OSPF interface.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf area (area-id) interface (ip-addr) metric [ no value | value <Ospf::Metric> ]
Command Parameters
Table 31.7-1 "OSPF Interface Metric Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(ip-addr) Format: ip address identifying the
- IPv4-address interface
Table 31.7-2 "OSPF Interface Metric Configuration Command" Command Parameters
Parameter Type Description
[no] value Parameter type: <Ospf::Metric> optional parameter with default
Format: value: "10"
- metric dependent on TOS the value for the metric
- range: [1...65535]
Command Description
This command allows the operator to configure an OSPF aggregate.
Inter-area route summarization is done on ABRs and it applies to routes from within the AS. It does not apply to
external routes injected into OSPF via redistribution. In order to take advantage of summarization, network
numbers in areas should be assigned in a contiguous way to be able to lump these addresses into one range.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf area (area-id) ( no aggregate-addr (dest-ip) ) | ( aggregate-addr (dest-ip) [ [ no ] omit-advertise ] )
Command Parameters
Table 31.8-1 "OSPF Aggregate Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(dest-ip) Format: ip address and mask of the
<Ip::V4Address> / <Ip::PrefixLengthFull> destination route
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Table 31.8-2 "OSPF Aggregate Configuration Command" Command Parameters
Parameter Type Description
[no] omit-advertise Parameter type: boolean optional parameter
do not advertise the aggregate
information of the subnet
Command Description
This command allows the operator to configure an OSPF aggregate from external autonomous system.
External route summarization is specific to external routes that are injected into OSPF via redistribution. Also,
make sure that external ranges that are being summarized are contiguous. Summarization overlapping ranges from
two different routers could cause packets to be sent to the wrong destination.
The "advertise" parameter in the command indicates what type of aggregation will be done :
• advertise : Type5 external LSAs falling into the specified range are aggregated and advertised.
• disable : Type5 external LSAs falling into the specified range are blocked.
• allow-all : Type5 external LSAs falling into the specified range are aggregated and advertised. Type7 external
Aggregation is done for all attached NSSA areas.
• deny-all : Type5 external LSAs falling into the specified range are blocked. No aggregation is done for Type7
external LSAs.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf area (area-id) ( no extern-aggr-addr (dest-ip) ) | ( extern-aggr-addr (dest-ip) [ no advertise |
advertise <Ospf::ExtAggregateEffect> ] )
Command Parameters
Table 31.9-1 "OSPF External Aggregate Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(dest-ip) Format: ip address and mask of the
<Ip::V4Address> / <Ip::PrefixLengthFull> destination route
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Table 31.9-2 "OSPF External Aggregate Configuration Command" Command Parameters
Parameter Type Description
[no] advertise Parameter type: <Ospf::ExtAggregateEffect> optional parameter with default
Command Description
This command allows the operator to configure the OSPF stub area.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf ( no stub-area (area-id) ) | ( stub-area (area-id) [ no metric-type | metric-type <Ospf::MetricType>
] [ no metric | metric <Ospf::StubMetric> ] [ [ no ] summary ] )
Command Parameters
Table 31.10-1 "OSPF Stub Area Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
Table 31.10-2 "OSPF Stub Area Configuration Command" Command Parameters
Parameter Type Description
[no] metric-type Parameter type: <Ospf::MetricType> optional parameter with default
Format: value: "ospf"
( ospf type of metric advertised as a
| comparable-metric default route
| non-comparable )
Possible values:
- ospf : ospf metric
- comparable-metric : comparable cost
- non-comparable : non comparable
[no] metric Parameter type: <Ospf::StubMetric> optional parameter with default
Format: value: 10
- metric value metric value
- range: [0...16777215]
[no] summary Parameter type: boolean optional parameter
controls the import of summary
LSAs into stub areas
Command Description
This command allows the operator to configure an OSPF interface.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) ( no interface (ip-addr) ) | ( interface (ip-addr) [ [ no ] disable ] [ no
router-priority | router-priority <Ospf::Priority> ] [ [ no ] passive ] [ no itf-type | itf-type <Ospf::ITFType> ] [ no
authentication | authentication <Ospf::AuthType> ] )
Command Parameters
Table 31.11-1 "OSPF Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(ip-addr) Format: ip address identifying the
- IPv4-address interface
Table 31.11-2 "OSPF Interface Configuration Command" Command Parameters
Parameter Type Description
[no] disable Parameter type: boolean optional parameter
disable interface
[no] router-priority Parameter type: <Ospf::Priority> optional parameter with default
Format: value: 1
- priority used in router election algorithm priority used in router election
- range: [0...255] algorithm
[no] passive Parameter type: boolean optional parameter
sets the itf as passive and
overwrites the parameter at
instance level; by default will set
to 'non-passive'
[no] itf-type Parameter type: <Ospf::ITFType> optional parameter with default
Format: value: "broadcast"
( broadcast ospf interface type
| nbma
| point-point
| point-multipoint )
Possible values:
- broadcast : broadcast lans like ethernet
- nbma : non broadcast multiple access
Command Description
This command allows the operator to configure the OSPF interface timers.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) interface (ip-addr) timers [ no transit-delay | transit-delay <Ospf::TransDelay> ]
[ no retransmit-itvl | retransmit-itvl <Ospf::RetransIntvl> ] [ no hello-interval | hello-interval <Ospf::HelloIntvl> ] [
no dead-interval | dead-interval <Ospf::DeadIntvl> ] [ no poll-interval | poll-interval <Ospf::PollIntvl> ]
Command Parameters
Table 31.12-1 "OSPF Interface Timers Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(ip-addr) Format: ip address identifying the
- IPv4-address interface
Table 31.12-2 "OSPF Interface Timers Configuration Command" Command Parameters
Parameter Type Description
[no] transit-delay Parameter type: <Ospf::TransDelay> optional parameter with default
Format: value: 1
- time to transmit link state packets time to transmit link update
- unit: sec packets
- range: [0...3600]
[no] retransmit-itvl Parameter type: <Ospf::RetransIntvl> optional parameter with default
Format: value: 5
- interval between LSA retransmission interval between LSA
- unit: sec retransmission
- range: [0...3600]
[no] hello-interval Parameter type: <Ospf::HelloIntvl> optional parameter with default
Format: value: 10
- interval between sending hello packets interval between sending hello
- unit: sec packets
- range: [1...65535]
[no] dead-interval Parameter type: <Ospf::DeadIntvl> optional parameter with default
Format: value: 40
Command Description
This command allows the operator to configure an MD5 key for an OSPF interface.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) interface (ip-addr) ( no md5-key (index) ) | ( md5-key (index) key
<Ospf::AuthTypeMd5> [ no accept-starts | accept-starts <Ospf::MD5startDelay> ] [ no generate-starts |
generate-starts <Ospf::MD5startDelay> ] )
Command Parameters
Table 31.13-1 "OSPF Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(ip-addr) Format: ip address identifying the
- IPv4-address interface
(index) Format: the number of the md5 key
- the number of the MD5 key
- range: [1...255]
Table 31.13-2 "OSPF Interface MD5 Key Configuration Command" Command Parameters
Parameter Type Description
key Parameter type: <Ospf::AuthTypeMd5> mandatory parameter
Format: the md5 key
( prompt
| plain : <Ospf::Md5Key> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Ospf::Md5Key>
- authentication key
- length: x<=16
[no] accept-starts Parameter type: <Ospf::MD5startDelay> optional parameter with default
Format: value: "now"
( now when the key must be used to
| <Sys::Time> ) accept
Command Output
Table 31.13-3 "OSPF Interface MD5 Key Configuration Command" Display parameters
Specific Information
name Type Description
accept-expires Parameter type: <Ospf::MD5expiryDelay> delay before the key expires for
( now accepting
| never This element is only shown in
| <Ospf::MD5expiryDelay> ) detail mode.
Possible values:
- now : the key will expire now
- never : the key will never expire
Field type <Ospf::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]
generate-expires Parameter type: <Ospf::MD5expiryDelay> delay before the key expires for
( now generating
| never This element is only shown in
| <Ospf::MD5expiryDelay> ) detail mode.
Possible values:
- now : the key will expire now
- never : the key will never expire
Field type <Ospf::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]
Command Description
This command allows the operator to configure the metric on an OSPF interface.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) interface (ip-addr) metric [ no value | value <Ospf::Metric> ]
Command Parameters
Table 31.14-1 "OSPF Interface Metric Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(ip-addr) Format: ip address identifying the
- IPv4-address interface
Table 31.14-2 "OSPF Interface Metric Configuration Command" Command Parameters
Parameter Type Description
[no] value Parameter type: <Ospf::Metric> optional parameter with default
Format: value: "10"
- metric dependent on TOS the value for the metric
- range: [1...65535]
Command Description
This command allows the operator to configure an OSPF stub aggregate.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 31.15-1 "OSPF Stub Aggregate Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(dest-ip) Format: ip address and mask of the
<Ip::V4Address> / <Ip::PrefixLengthFull> destination route
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Table 31.15-2 "OSPF Stub Aggregate Configuration Command" Command Parameters
Parameter Type Description
[no] omit-advertise Parameter type: boolean optional parameter
do not advertise the aggregate
information of the subnet
Command Description
This command allows the operator to configure the OSPF NSSA area.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf ( no nssa-area (area-id) ) | ( nssa-area (area-id) [ [ no ] summary ] [ no translation | translation
<Ospf::Trnsltn> ] [ no trans-itvl | trans-itvl <Ospf::TrnltnIntvl> ] [ [ no ] asbr-rtr-trans ] [ no metric-type |
metric-type <Ospf::MetricType> ] )
Command Parameters
Table 31.16-1 "OSPF NSSA Area Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
Table 31.16-2 "OSPF NSSA Area Configuration Command" Command Parameters
Parameter Type Description
[no] summary Parameter type: boolean optional parameter
controls the import of summary
LSAs into stub areas
[no] translation Parameter type: <Ospf::Trnsltn> optional parameter with default
Format: value: "candidate"
( always NSSA routers ability to translate
| candidate ) Type-7 to Type-5 LSAs
Possible values:
- always : always
- candidate : candidate
[no] trans-itvl Parameter type: <Ospf::TrnltnIntvl> optional parameter with default
Format: value: 40
- time trsltr finds its service is not reqd time trsltr finds its service is not
- unit: sec reqd
- range: [0...65535]
[no] asbr-rtr-trans Parameter type: boolean optional parameter
p-bit setting for the type-7 LSA
generated by ASBR
[no] metric-type Parameter type: <Ospf::MetricType> optional parameter with default
Format: value: "ospf"
( ospf type of metric advertised as a
| comparable-metric default route
Command Description
This command allows the operator to configure an OSPF interface.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) ( no interface (ip-addr) ) | ( interface (ip-addr) [ [ no ] disable ] [ no
router-priority | router-priority <Ospf::Priority> ] [ [ no ] passive ] [ no itf-type | itf-type <Ospf::ITFType> ] [ no
authentication | authentication <Ospf::AuthType> ] )
Command Parameters
Table 31.17-1 "OSPF Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(ip-addr) Format: ip address identifying the
- IPv4-address interface
Table 31.17-2 "OSPF Interface Configuration Command" Command Parameters
Parameter Type Description
[no] disable Parameter type: boolean optional parameter
disable interface
[no] router-priority Parameter type: <Ospf::Priority> optional parameter with default
Format: value: 1
- priority used in router election algorithm priority used in router election
- range: [0...255] algorithm
[no] passive Parameter type: boolean optional parameter
sets the itf as passive and
overwrites the parameter at
instance level; by default will set
to 'non-passive'
[no] itf-type Parameter type: <Ospf::ITFType> optional parameter with default
Format: value: "broadcast"
( broadcast ospf interface type
| nbma
| point-point
| point-multipoint )
Possible values:
- broadcast : broadcast lans like ethernet
- nbma : non broadcast multiple access
Command Description
This command allows the operator to configure the OSPF interface timers.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) interface (ip-addr) timers [ no transit-delay | transit-delay <Ospf::TransDelay>
] [ no retransmit-itvl | retransmit-itvl <Ospf::RetransIntvl> ] [ no hello-interval | hello-interval <Ospf::HelloIntvl> ]
[ no dead-interval | dead-interval <Ospf::DeadIntvl> ] [ no poll-interval | poll-interval <Ospf::PollIntvl> ]
Command Parameters
Table 31.18-1 "OSPF Interface Timers Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(ip-addr) Format: ip address identifying the
- IPv4-address interface
Table 31.18-2 "OSPF Interface Timers Configuration Command" Command Parameters
Parameter Type Description
[no] transit-delay Parameter type: <Ospf::TransDelay> optional parameter with default
Format: value: 1
- time to transmit link state packets time to transmit link update
- unit: sec packets
- range: [0...3600]
[no] retransmit-itvl Parameter type: <Ospf::RetransIntvl> optional parameter with default
Format: value: 5
- interval between LSA retransmission interval between LSA
- unit: sec retransmission
- range: [0...3600]
[no] hello-interval Parameter type: <Ospf::HelloIntvl> optional parameter with default
Format: value: 10
- interval between sending hello packets interval between sending hello
- unit: sec packets
- range: [1...65535]
[no] dead-interval Parameter type: <Ospf::DeadIntvl> optional parameter with default
Format: value: 40
Command Description
This command allows the operator to configure an MD5 key for an OSPF interface.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) interface (ip-addr) ( no md5-key (index) ) | ( md5-key (index) key
<Ospf::AuthTypeMd5> [ no accept-starts | accept-starts <Ospf::MD5startDelay> ] [ no generate-starts |
generate-starts <Ospf::MD5startDelay> ] )
Command Parameters
Table 31.19-1 "OSPF Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(ip-addr) Format: ip address identifying the
- IPv4-address interface
(index) Format: the number of the md5 key
- the number of the MD5 key
- range: [1...255]
Table 31.19-2 "OSPF Interface MD5 Key Configuration Command" Command Parameters
Parameter Type Description
key Parameter type: <Ospf::AuthTypeMd5> mandatory parameter
Format: the md5 key
( prompt
| plain : <Ospf::Md5Key> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Ospf::Md5Key>
- authentication key
- length: x<=16
[no] accept-starts Parameter type: <Ospf::MD5startDelay> optional parameter with default
Format: value: "now"
( now when the key must be used to
| <Sys::Time> ) accept
Command Output
Table 31.19-3 "OSPF Interface MD5 Key Configuration Command" Display parameters
Specific Information
name Type Description
accept-expires Parameter type: <Ospf::MD5expiryDelay> delay before the key expires for
( now accepting
| never This element is only shown in
| <Ospf::MD5expiryDelay> ) detail mode.
Possible values:
- now : the key will expire now
- never : the key will never expire
Field type <Ospf::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]
generate-expires Parameter type: <Ospf::MD5expiryDelay> delay before the key expires for
( now generating
| never This element is only shown in
| <Ospf::MD5expiryDelay> ) detail mode.
Possible values:
- now : the key will expire now
- never : the key will never expire
Field type <Ospf::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]
Command Description
This command allows the operator to configure the metric on an OSPF interface.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) interface (ip-addr) metric [ no value | value <Ospf::Metric> ]
Command Parameters
Table 31.20-1 "OSPF Interface Metric Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(ip-addr) Format: ip address identifying the
- IPv4-address interface
Table 31.20-2 "OSPF Interface Metric Configuration Command" Command Parameters
Parameter Type Description
[no] value Parameter type: <Ospf::Metric> optional parameter with default
Format: value: "10"
- metric dependent on TOS the value for the metric
- range: [1...65535]
Command Description
This command allows the operator to configure an OSPF nssa external link aggregate at the ABR.
The type7 LSAs are aggregated into one Type5 LSAs at the ABR. This ABR us referred as NSSA translator.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) ( no aggregate-addr (dest-ip) lsa-type <Ospf::LSAType> ) | ( aggregate-addr
(dest-ip) lsa-type <Ospf::LSAType> [ [ no ] omit-advertise ] )
Command Parameters
Table 31.21-1 "OSPF NSSA Aggregate Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(dest-ip) Format: ip address and mask of the
<Ip::V4Address> / <Ip::PrefixLengthFull> destination route
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
lsa-type Parameter type: <Ospf::LSAType> type of address aggregate
Format:
( summary
| nssa-external )
Possible values:
- summary : type-3, summary link
- nssa-external : type-7, nssa external link
Table 31.21-2 "OSPF NSSA Aggregate Configuration Command" Command Parameters
Parameter Type Description
[no] omit-advertise Parameter type: boolean optional parameter
do not advertise the aggregate
information of the subnet
Command Description
This command allows the operator to configure an OSPF aggregate from external autonomous system.
External route summarization is specific to external routes that are injected into OSPF via redistribution. Also,
make sure that external ranges that are being summarized are contiguous. Summarization overlapping ranges from
two different routers could cause packets to be sent to the wrong destination.
The "advertise" parameter in the command indicates what type of aggregation will be done :
• advertise : Type5 external LSAs falling into the specified range are aggregated and advertised.
• disable : Type5 external LSAs falling into the specified range are blocked.
• allow-all : Type5 external LSAs falling into the specified range are aggregated and advertised. Type7 external
Aggregation is done for all attached NSSA areas.
• deny-all : Type5 external LSAs falling into the specified range are blocked. No aggregation is done for Type7
external LSAs.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) ( no extern-aggr-addr (dest-ip) ) | ( extern-aggr-addr (dest-ip) [ no advertise |
advertise <Ospf::ExtAggregateEffect> ] )
Command Parameters
Table 31.22-1 "OSPF External Aggregate Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
(dest-ip) Format: ip address and mask of the
<Ip::V4Address> / <Ip::PrefixLengthFull> destination route
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Table 31.22-2 "OSPF External Aggregate Configuration Command" Command Parameters
Parameter Type Description
[no] advertise Parameter type: <Ospf::ExtAggregateEffect> optional parameter with default
Command Description
This command allows the operator to configure the redistribution of the OSPF.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 31.23-2 "OSPF Redistribution Configuration Command" Command Parameters
Parameter Type Description
[no] enable Parameter type: boolean optional parameter
enable OSPF route redistribution
[no] local Parameter type: boolean optional parameter
import local routes to OSPF
[no] static Parameter type: boolean optional parameter
import static routes to OSPF
[no] rip Parameter type: boolean optional parameter
import rip routes to OSPF
Command Description
This command allows the operator to configure the redistribution of OSPF route parameters.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 31.24-1 "OSPF Redistribution Route Configuration Command" Resource Parameters
Resource Identifier Type Description
(dest-ip) Format: ip address and mask of the
<Ip::V4Address> / <Ip::PrefixLengthFull> destination route
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Table 31.24-2 "OSPF Redistribution Route Configuration Command" Command Parameters
Parameter Type Description
[no] metric-type Parameter type: <Ospf::RouteMetricType> optional parameter with default
Format: value: "as-ext-type2"
( as-ext-type1 metric type applied to the router
| as-ext-type2 )
Possible values:
- as-ext-type1 : asexttype1 metric type
- as-ext-type2 : asexttype2 metric type
[no] metric Parameter type: <Ospf::RouteMetric> optional parameter with default
Format: value: 10
- metric value for route before its advrtsd metric value applied to the router
- range: [1...16777215]
Description
This chapter gives an overview of nodes that are handled by "RIP Configuration Commands".
Command Tree
----configure
----[no] rip
X [no] max-peer
----redistribution
- [no] enable
- [no] default-metric
- [no] local
- [no] static
- [no] ospf
----[no] interface
- (ip-addr)
- [no] authentication
- default-metric
- [no] send
- [no] receive
- [no] split-horizon
- [no] egr-routemap-act
- [no] igr-routemap-act
----timers
- [no] update-timer
- [no] route-age-out
- [no] junk-collection
----[no] md5-key
- (index)
- key
- starts
- expires
----[no] route-map
- (map-index)
- direction
- ip-addr
- [no] action
- [no] prefix-match
----[no] aggregation
- (ip-addr)
----X [no] route-map
- (vlan-id)
- sub-index
- ip-addr
- [no] direction
- [no] deny
Command Description
This command allows the operator to specify global parameters for the RIP protocol.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 32.2-2 "RIP Common Configuration Command" Command Parameters
Parameter Type Description
[no] max-peer Parameter type: <Rip::Rip2Peer> obsolete parameter that will be
Format: ignored
- max nbr of peers max nbr of peer conversing with
- range: [1...25] RIP2 simultaneously
Command Description
This command allows the operator to configure RIP redistribution.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 32.3-2 "RIP Redistribution Configuration Command" Command Parameters
Parameter Type Description
[no] enable Parameter type: boolean optional parameter
enable RIP route redistribution
[no] default-metric Parameter type: <Rip::RouteMetric> optional parameter with default
Format: value: 3
- metric default metric used for the
- range: [1...16] imported routes
[no] local Parameter type: boolean optional parameter
import local routes to RIP
[no] static Parameter type: boolean optional parameter
import static routes to RIP
[no] ospf Parameter type: boolean optional parameter
import ospf routes to RIP
Command Description
This command allows the user to configure RIP interface parameters.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure rip ( no interface (ip-addr) ) | ( interface (ip-addr) [ no authentication | authentication <Rip::AuthType>
] default-metric <Rip::DefMetric> [ no send | send <Rip::ConfSend> ] [ no receive | receive <Rip::ConfRcv> ] [ no
split-horizon | split-horizon <Rip::SpltHorizon> ] [ no egr-routemap-act | egr-routemap-act
<Rip::EgrRouteMapAction> ] [ no igr-routemap-act | igr-routemap-act <Rip::IngrRouteMapAction> ] )
Command Parameters
Table 32.4-1 "RIP Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: interface IP address
- IPv4-address
Table 32.4-2 "RIP Interface Configuration Command" Command Parameters
Parameter Type Description
[no] authentication Parameter type: <Rip::AuthType> optional parameter with default
Format: value: "none"
( none authentication method
| md5
| plain : prompt
| plain : plain : <Rip::Key> )
Possible values:
- none : no authentication
- plain : simple password
- md5 : md5 authentication
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Rip::Key>
- authentication key
- length: 1<=x<=16
default-metric Parameter type: <Rip::DefMetric> mandatory parameter
Format: metric used for default route in
- default metric RIP updates
- range: [0...15]
[no] send Parameter type: <Rip::ConfSend> optional parameter with default
Command Description
This command allows the user to configure RIP interface timers.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure rip interface (ip-addr) timers [ no update-timer | update-timer <Rip::UpdateTmr> ] [ no route-age-out |
route-age-out <Rip::RouteAgeTmr> ] [ no junk-collection | junk-collection <Rip::GrbTmr> ]
Command Parameters
Table 32.5-1 "RIP Interface Timers Configuration Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: interface IP address
- IPv4-address
Table 32.5-2 "RIP Interface Timers Configuration Command" Command Parameters
Parameter Type Description
[no] update-timer Parameter type: <Rip::UpdateTmr> optional parameter with default
Format: value: 30
- update timer interval between RIP updates in
- unit: secs secs
- range: [10...3600]
[no] route-age-out Parameter type: <Rip::RouteAgeTmr> optional parameter with default
Format: value: 180
- route age timer time for unrefreshed route to be
- unit: secs put in garbage in secs
- range: [30...500]
[no] junk-collection Parameter type: <Rip::GrbTmr> optional parameter with default
Format: value: 120
- garbage collection timer lifetime of route in garbage bin in
- unit: secs secs
- range: [120...180]
Command Description
This command allows the operator to configure a MD5 key for a RIP interface.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure rip interface (ip-addr) ( no md5-key (index) ) | ( md5-key (index) key <Rip::AuthTypeMD5> starts
<Rip::MD5startDelay> expires <Rip::MD5expiryDelay> )
Command Parameters
Table 32.6-1 "RIP Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: interface IP address
- IPv4-address
(index) Format: the number of the md5 key
- the number of the MD5 key
- range: [0...255]
Table 32.6-2 "RIP Interface MD5 Key Configuration Command" Command Parameters
Parameter Type Description
key Parameter type: <Rip::AuthTypeMD5> mandatory parameter
Format: the md5 key
( prompt
| plain : <Rip::Key> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Rip::Key>
- authentication key
- length: 1<=x<=16
starts Parameter type: <Rip::MD5startDelay> mandatory parameter
Format: when the key must be used
( now
| <Sys::Time> )
Possible values:
- now : the key will be used from now on
Field type <Sys::Time>
Command Description
This command allows the user to define an ingress or egress route map for routes redistributed from or to RIP over
an Interface.
If the action value is permit then it means:
1.If a received route matches the criteria of this route map filter, it will be occupied
2.If a route that is about to be published matches the criteria of the route map filter, it will be advertised
If the action value is deny then it means:
1. If a received route matches the criteria of the route map filter it will be discarded
2. If the route that is about to be published matches the criteria of the route map filter , it will not be advertised
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 32.7-1 "RIP Interface Route Map Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: interface IP address
- IPv4-address
(map-index) Format: identifies the route map index
- identifies the route map index
- range: [1...400]
direction Parameter type: <Rip::NewRouteMapDirection> identifies the direction
Format:
( egress
| ingress )
Possible values:
- egress : filter applied to advertised routes
- ingress : filter applied to received routes
Table 32.7-2 "RIP Interface Route Map Command" Command Parameters
Parameter Type Description
ip-addr Parameter type: <Ip::AddressAndIpMaskFull> mandatory parameter
Format: The parameter is not visible
Command Description
This command allows the user to add or delete a route aggregation.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 32.8-1 "RIP Route Aggregation Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: aggregated IP address and
<Ip::V4Address> / <Ip::PrefixLengthFull> subnetmask
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Command Description
Obsolete command, replaced by configure rip interface (ip-addr) route-map.
This command allows the user to define a route map.
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> configure rip ( no route-map (vlan-id) sub-index <Rip::SubIndex> ) | ( route-map (vlan-id) sub-index
<Rip::SubIndex> ip-addr <Ip::AddressAndIpMaskFull> [ no direction | direction <Rip::RouteMapDirection> ] [ [
no ] deny ] )
Obsolete command, replaced by configure rip interface (ip-addr) route-map.
Command Parameters
Table 32.9-1 "RIP Route Map Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: interface IP address
- vlan id
- range: [1...4093]
sub-index Parameter type: <Rip::SubIndex> identifies the rule for each
Format: ip-address
- identifies the rule for each ip-address
- range: [1...128]
Table 32.9-2 "RIP Route Map Command" Command Parameters
Parameter Type Description
ip-addr Parameter type: <Ip::AddressAndIpMaskFull> mandatory parameter
Format: The parameter is not visible
<Ip::V4Address> / <Ip::PrefixLengthFull> during modification.
Field type <Ip::V4Address> IP address of subnet that can be
- IPv4-address allowed/disallowed
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] direction Parameter type: <Rip::RouteMapDirection> optional parameter with default
Format: value: "transmit"
transmit The parameter is not visible
Possible values: during modification.
- transmit : route map in transmitting direction Direction in which the RIP routes
are advertised.
Description
This chapter gives an overview of nodes that are handled by "Cluster Management Configure Commands".
Command Tree
----configure
----cluster
----system
- [no] name
- role
----neighbour
- [no] discov-mode-off
- [no] interval
- [no] hold-time
----collection
- [no] collect-sys-off
- [no] hop-delay
- [no] port-delay
- [no] scope
- [no] interval
- [no] manual
----[no] port
- (port)
- [no] discov-port-off
- [no] collect-port-off
Command Description
This command allows the operator to configure the parameters of an NE on the system level
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 33.2-2 "Cluster System Configuration Command" Command Parameters
Parameter Type Description
[no] name Parameter type: <Cluster::ClusterName> optional parameter with default
Format: value: ""
- the cluster name the cluster name
- length: x<=255
role Parameter type: <Cluster::ClusterRole> optional parameter
Format: the cluster role
( command
| member
| backup
| candidate )
Possible values:
- command : act as a command node
- member : act as a member node
- backup : act as a backup node
- candidate : act as a candidate node
Command Description
This command allows the operator to configure the neighbor discovery on system level
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 33.3-2 "Cluster Neighbor Discovery Configuration Command" Command Parameters
Parameter Type Description
[no] discov-mode-off Parameter type: boolean optional parameter
neighbour discovery in the NE is
disabled
[no] interval Parameter type: <Cluster::DiscoveryInterval> optional parameter with default
Format: value: 60
- the neighbour discovery interval the neighbour discovery interval
- range: [1...2147483647]
[no] hold-time Parameter type: <Cluster::DiscoveryHoldTime> optional parameter with default
Format: value: 180
- the neighbour discovery hold time the neighbour discovery hold
- range: [1...255] time
Command Description
This command allows the operator to configure the topology collection on system level
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 33.4-2 "Cluster Topology Collection Configuration Command" Command Parameters
Parameter Type Description
[no] collect-sys-off Parameter type: boolean optional parameter
topology collection in the NE is
disabled
[no] hop-delay Parameter type: <Cluster::CollectionHopDelay> optional parameter with default
Format: value: 200
- time of the collection hop delay the topology collection hop delay
- range: [1...65535]
[no] port-delay Parameter type: <Cluster::CollectionPortDelay> optional parameter with default
Format: value: 20
- time of the collection port delay the topology collection port delay
- range: [1...65535]
[no] scope Parameter type: <Cluster::CollectionScope> optional parameter with default
Format: value: 3
- the collection scope of the cluster the topology collection scope
- range: [1...10]
[no] interval Parameter type: <Cluster::CollectionInterval> optional parameter with default
Format: value: 0
- the topology collection interval the topology collection interval
- range: [0...2147483647]
[no] manual Parameter type: boolean optional parameter
the manual topology collection in
the NE is enabled
Command Description
This command allows the operator to configure the parameter on the port level
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 33.5-1 "Cluster Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: index of a port
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Table 33.5-2 "Cluster Port Configuration Command" Command Parameters
Parameter Type Description
[no] discov-port-off Parameter type: boolean optional parameter
neighbour discovery in the port is
disabled
[no] collect-port-off Parameter type: boolean optional parameter
topology collection in the NE is
disabled
Description
This chapter gives an overview of nodes that are handled by "XDSL Bonding Configuration Commands".
Command Tree
----configure
----xdsl-bonding
- group-assembly-time
----[no] group-profile
- (index)
- name
- (scope)
- version
- [no] min-bitrate-up
- [no] min-bitrate-down
- [no] plan-bitrate-up
- [no] plan-bitrate-down
- [no] max-bitrate-up
- [no] max-bitrate-down
- [no] max-delay-down
- [no] max-delay-up
- [no] imp-noise-prot-dn
- [no] imp-noise-prot-up
- [no] delay-opt-mode-ds
- [no] grp-assembly-time
- [no] active
----[no] group-rtx-profile
- (index)
- name
- version
- [no] rtx-mode-dn
- [no] rtx-mode-up
- [no] min-exp-thrpt-dn
- [no] min-exp-thrpt-up
- [no] plan-exp-thrpt-dn
- [no] plan-exp-thrpt-up
- [no] max-exp-thrpt-dn
- [no] max-exp-thrpt-up
- [no] max-net-rate-dn
- [no] max-net-rate-up
- [no] min-delay-dn
- [no] min-delay-up
- [no] max-delay-dn
- [no] max-delay-up
- [no] min-inp-shine-dn
- [no] min-inp-shine-up
- [no] min-inp-rein-dn
- [no] min-inp-rein-up
- [no] int-arr-time-dn
- [no] int-arr-time-up
- [no] shine-ratio-dn
- [no] shine-ratio-up
- [no] leftr-thresh-dn
- [no] leftr-thresh-up
- [no] active
----group
- (bonding-group-idx)
- [no] group-profile
- [no] group-rtx-profile
X [no] admin-up
- [no] up
----[no] link
- (bonding-link-id)
----board
- (board-index)
----vect-fallback
- [no] group-profile
- [no] group-rtx-profile
Command Description
This node provides the provisioning of the bonding group assembly timeout. Default value is zero ('0', represents
an infinite time ), and will have as consequence that the bonding group will not come up till all lines in this bonding
group are up. This parameter may be overruled by the grp-assembly-time parameter on bonding group-profile
level.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 34.2-2 "XDSL Bonding Assembly Timer Configuration Command" Command Parameters
Parameter Type Description
group-assembly-time Parameter type: <Xdsl::SignedIntegerSEC> optional parameter
Format: Max waiting period for group to
- second become operational
- unit: sec
- range: [0...65535]
Command Description
This command allows to manage the xDSL bonding group profile. A profile can be created in one step with all the
necessary parameters and making it active. It can also be created in several steps by specifying a few parameters in
each step and make the profile active in the last step.
DESCRIPTION FOR THE COMMAND PARAMETER-SCOPE:The combination scope+profile must be
unique.Typically local-profile must be used especially when configuring via CLI.Use of network-profile is
depreciated.The network-profile was foreseen to allow management agents to define network-wide unique
profiles,independent of what local profiles may have been created.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure xdsl-bonding ( no group-profile (index) ) | ( group-profile (index) name <AsamProfileName> (scope)
version <SignedInteger> [ no min-bitrate-up | min-bitrate-up <Xdsl::BondingBitRate> ] [ no min-bitrate-down |
min-bitrate-down <Xdsl::BondingBitRate> ] [ no plan-bitrate-up | plan-bitrate-up <Xdsl::BondingBitRate> ] [ no
plan-bitrate-down | plan-bitrate-down <Xdsl::BondingBitRate> ] [ no max-bitrate-up | max-bitrate-up
<Xdsl::BondingBitRate> ] [ no max-bitrate-down | max-bitrate-down <Xdsl::BondingBitRate> ] [ no
max-delay-down | max-delay-down <Xdsl::InterleavingDelay> ] [ no max-delay-up | max-delay-up
<Xdsl::InterleavingDelay> ] [ no imp-noise-prot-dn | imp-noise-prot-dn <Xdsl::ImpNoiseProtection> ] [ no
imp-noise-prot-up | imp-noise-prot-up <Xdsl::ImpNoiseProtection> ] [ no delay-opt-mode-ds | delay-opt-mode-ds
<Xdsl::BondingGroupDelayOptimMode> ] [ no grp-assembly-time | grp-assembly-time
<Xdsl::BondingGroupProfileAssemblyTimer> ] [ [ no ] active ] )
Command Parameters
Table 34.3-1 "xDSL Bonding Group Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile
- bonding group profile index
- range: [1...100]
Table 34.3-2 "xDSL Bonding Group Profile Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <AsamProfileName> mandatory parameter
Format: name of the profile
- a profile name
- range: [a-zA-Z0-9-_.]
Command Description
This command allows the operator to configure the bonding group RTX profile which can be used to configure the
modem for each contributing physical line of the bonding group
RTX downstream/upstream parameters will have effect on lines supporting RTX, only when the retransmission
feature in downstream/upstream is not "forbidden"
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 34.4-1 "xDSL Bonding Group Rtx Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile
- a profile index value
- range: [1...128]
Table 34.4-2 "xDSL Bonding Group Rtx Profile Configuration Command" Command Parameters
Command Description
This command allows to configure a bonding group, which consists of assigning a predefined bonding group
profile and optional assigning a group rtx-profile.
Configuring bonding group will fail when a service is already configured on the secondary DSL line of the bonding
group
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 34.5-1 "xDSL Bonding Configuration Command" Resource Parameters
Resource Identifier Type Description
(bonding-group-idx) Format: a unique interface index
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 34.5-2 "xDSL Bonding Configuration Command" Command Parameters
Parameter Type Description
[no] group-profile Parameter type: <Xdsl::GroupProfileIndexWithRemove> optional parameter with default
Format: value: "none"
( none a valid profile index for the
| <Xdsl::GroupProfileIndexWithRemove> interface
| name : <PrintableString> )
Possible values:
- none : no profile to associate
- name : profile name
Field type <Xdsl::GroupProfileIndexWithRemove>
Command Output
Table 34.5-3 "xDSL Bonding Configuration Command" Display parameters
Specific Information
name Type Description
group-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the group profile
- ignored printable string This element is only shown in
detail mode.
group-rtx-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the bonding group rtx
- ignored printable string profile
This element is only shown in
detail mode.
Command Description
This node provides the provisoning of the bonding group, which consists of adding/removing links to/from the
bonding group.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 34.6-1 "xDSL Bonding Configuration Command" Resource Parameters
Resource Identifier Type Description
(bonding-group-idx) Format: a unique interface index
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
(bonding-link-id) Format: a bonding link interface index
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Command Description
This command allows the operator to configure xdsl bonding parameters related with a specific board.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 34.7-1 "xDSL Bonding Board Configuration Command" Resource Parameters
Resource Identifier Type Description
(board-index) Format: board index
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Command Description
This command allows the operator to configure per board the profile selection in case the bonding group enters the
vectoring fallback mode.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 34.8-1 "xDSL Bonding Board Vectoring Fallback Configuration Command" Resource
Parameters
Resource Identifier Type Description
(board-index) Format: board index
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Table 34.8-2 "xDSL Bonding Board Vectoring Fallback Configuration Command" Command
Parameters
Parameter Type Description
[no] group-profile Parameter type: <Xdsl::VectFbGroupProfileIndex> optional parameter with default
Format: value: "group-level"
( group-level a valid profile index for the
| <Xdsl::VectFbGroupProfilePointer> interface
| name : <PrintableString> )
Possible values:
- group-level : use the original group profile in fallback
mode
- name : profile name
Field type <Xdsl::VectFbGroupProfilePointer>
Command Output
Table 34.8-3 "xDSL Bonding Board Vectoring Fallback Configuration Command" Display
parameters
Specific Information
name Type Description
group-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the group profile
- ignored printable string This element is only shown in
detail mode.
group-rtx-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the bonding group rtx
- ignored printable string profile
This element is only shown in
detail mode.
Description
This chapter gives an overview of nodes that are handled by "CPE Remote Configuration Commands".
Command Tree
----configure
----cpe-management
- [no] proxy-mode
X vlan-id
----[no] manager
- (address)
----X [no] session
- (dslport)
- connection
----shub
----[no] vlan-id
- (vlan-id)
Command Description
This command allows to configure CPE Remote Management System;
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 35.2-2 "CPE Remote Management System Configuration Commands" Command Parameters
Parameter Type Description
[no] proxy-mode Parameter type: <CpeProxy::SystemMode> optional parameter with default
Format: value: "none"
( snmp set the CPE Proxy mode
| none )
Possible values:
- snmp : this mode is relaying SNMP messages
- none : disables the cpeproxy
vlan-id Parameter type: <CpeProxy::VlanIndex> obsolete parameter that will be
Format: ignored
- cpe ipproxy vlan number configure the svlan number.
- range: [0...4093]
Command Description
This command allows to configure a CPE manager.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 35.3-1 "CPE Manager Configuration Command " Resource Parameters
Resource Identifier Type Description
(address) Format: the address of a CPE manager
<CpeProxy::IPaddress> : <CpeProxy::PortNumber>
Field type <CpeProxy::IPaddress>
- IP address of CPE Management Station
Field type <CpeProxy::PortNumber>
- cpe management station udp port number
- range: [1...65535]
Command Description
Obsolete command.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 35.4-1 "CPE IPProxy Session Configuration Command " Resource Parameters
Resource Identifier Type Description
(dslport) Format: identification of port to which the
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / CPE is connected
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 35.4-2 "CPE IPProxy Session Configuration Command " Command Parameters
Parameter Type Description
connection Parameter type: mandatory parameter
<CpeProxy::cpeIpProxySessionProtocolPort> protocol port for ipproxy session.
Format:
- cpe ipproxy port number
- range: [0,13410...13457]
Command Description
This command allows to configure a cpe management shub vlan.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 35.5-1 "CPE IPProxy Shub Vlan Configuration Command " Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: configure the cpe management
- cpe ipproxy shub vlan number shub vlan number
- range: [1...4093]
Description
This chapter gives an overview of nodes that are handled by "SHDSL Configuration Commands".
Command Tree
----configure
----shdsl
----span
- (if-index)
- [no] active
- [no] admin-up
- [no] repeaters
- [no] op-mode
- [no] spectral-profile
- [no] wire-mode
- [no] mgmt-by-stu-r
- [no] regi-set
- [no] min-line-rate
- [no] max-line-rate
- [no] margin-down-worst
- [no] margin-down-curr
- [no] margin-up-worst
- [no] margin-up-curr
- [no] probe
- [no] tc-pam-sele
- [no] efm-hs-sele
- [no] bonding-rate-mode
- [no] min-rate-link1
- [no] max-rate-link1
- [no] min-rate-link2
- [no] max-rate-link2
- [no] min-rate-link3
- [no] max-rate-link3
- [no] min-rate-link4
- [no] max-rate-link4
- [no] tc-pam-link1
- [no] tc-pam-link2
- [no] tc-pam-link3
- [no] tc-pam-link4
- [no] ctc
----unit
- (if-index)
- unit-id
- [no] loop-attenuation
- [no] snr-margin
- [no] loopback-timeout
----segment
- (if-index)
- unit-id
- side
- [no] loopback
- [no] pbo-mode
Command Description
This command allows the operator to manage the SHDSL span profile.
The lines, which you can configure, are calculated via the next formula: m*n + 1
o where m is the number of pairs per modem
o where n is from 0 till 24/m - 1
Mixing of different "wire mode" on the same LT is possible as long as the lines are not occupied yet.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 36.2-1 "SHDSL Span Configuration Command" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
Command Description
This command allows the operator to manage the SHDSL unit profile in one SHDSL span.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 36.3-1 "SHDSL Unit Configuration Command" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
unit-id Parameter type: <Shdsl::UnitId> unit identifier in an SHDSL span
Format:
( stu-c
| stu-r
| sru-1
| sru-2
| sru-3
| sru-4
| sru-5
| sru-6
| sru-7
| sru-8 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
- sru-1 : the SHDSL unit is SRU-1
Command Description
This command allows the operator to manage the SHDSL segment points on either sides of an SHDSL unit.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> configure shdsl segment (if-index) unit-id <Shdsl::UnitId> side <Shdsl::SegmentSide> [ no loopback | loopback
<Shdsl::SegmentTermLoopbackConf> ] [ no pbo-mode | pbo-mode <Shdsl::SegmentTermPowerBackoff> ]
Command Parameters
Table 36.4-1 "SHDSL Segment Configuration Command" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
unit-id Parameter type: <Shdsl::UnitId> unit identifier in an SHDSL span
Format:
( stu-c
| stu-r
| sru-1
| sru-2
| sru-3
| sru-4
| sru-5
| sru-6
| sru-7
| sru-8 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
- sru-1 : the SHDSL unit is SRU-1
- sru-2 : the SHDSL unit is SRU-2
Description
This chapter gives an overview of nodes that are handled by "IMA Configuration Commands".
Command Tree
----configure
----ima
----group
- (if-index)
- [no] activate
- [no] admin-up
- [no] min-tx-links
- [no] min-rx-links
- near-end-ima-id
----[no] link
- (link-if-index)
- grp-index
Command Description
This command allows the operator to manage the IMA group profile.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 37.2-1 "IMA Group Configuration Commands" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 37.2-2 "IMA Group Configuration Commands" Command Parameters
Parameter Type Description
[no] activate Parameter type: boolean optional parameter
[no] admin-up Parameter type: boolean optional parameter
admin status is up
[no] min-tx-links Parameter type: <Ima::GroupMinNumTxLinks> optional parameter with default
Format: value: 1
- a mininum number of transmit links required to be active the mininum number of transmit
- range: [1...8] links
[no] min-rx-links Parameter type: <Ima::GroupMinNumRxLinks> optional parameter with default
Format: value: 1
- a mininum number of receive links required to be active the mininum number of receive
- range: [1...32] links
near-end-ima-id Parameter type: <Ima::GroupTxImaId> optional parameter
Format: the imd id used by the near-end
Command Description
This command allows the operator to manage the IMA link profile.
User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 37.3-1 "IMA Link Configuration Commands" Resource Parameters
Resource Identifier Type Description
(link-if-index) Format: interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 37.3-2 "IMA Link Configuration Commands" Command Parameters
Parameter Type Description
grp-index Parameter type: <Itf::ImaLine> mandatory parameter
Format: logical interface number assigned
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / to this IMA grp Link
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Description
This chapter gives an overview of nodes that are handled by "Voice Configuration Commands".
Command Tree
----configure
----voice
----sip
----[no] server
- (name)
- [no] admin-status
- address
- [no] port
- [no] server-role
- [no] priority
- [no] weight
- [no] site
- [no] transproto
- [no] dnsname-type
- admin-domain-name
----lineid-syn-prof
- (name)
- [no] syntax-pattern
- [no] pots-syntax
----[no] user-agent
- (name)
- [no] ip-addr-policy
- [no] ip-config-mode
- [no] signal-gateway-ip
- signal-vlan-id
- [no] signal-dscp
- [no] signal-pbits
- [no] signal-link-mtu
- [no] rtp-gateway-ip
- rtp-vlan-id
- [no] rtp-dscp
- [no] rtp-pbits
- [no] rtp-link-mtu
- [no] dhcp-optreq-list
- [no] admin-status
- [no] provider-name
----[no] vsp
- (name)
- domain-name
- [no] admin-status
- [no] tinfo
- [no] ta4
- [no] ttir1
- [no] t-acm-delta
- [no] access-held-time
- [no] awaiting-time
- [no] digit-send-mode
- [no] overlap-484-act
- [no] dmpm-intdgt-expid
- [no] dial-start-timer
- [no] dial-long-timer
- [no] dial-short-timer
- [no] uri-type
- [no] rfc2833-pl-type
- [no] rfc2833-process
- [no] min-data-jitter
- [no] init-data-jitter
- [no] max-data-jitter
- [no] release-mode
- [no] dyn-pt-nego-type
- [no] vbd-g711a-pl-type
- [no] vbd-g711u-pl-type
- [no] vbd-mode
- [no] warmline-dl-timer
- [no] timer-b
- [no] timer-f
- [no] timer-t1
- [no] timer-t2
- [no] reg-sub
- [no] sub-period
- [no] sub-head-start
- [no] t38-same-udp
- [no] dhcp-option82
----user-agent-ap
- (ua-name)
- slot-id
- signal-ip
- rtp-ip
- [no] dhcp-fqdn
- [no] dhcp-customer-id
- [no] admin-status
----[no] dialplan
- (name)
- [no] pre-activated
- [no] static-prefix
- [no] static-suffix
- [no] digitmap-mode
- [no] provider-name
----[no] digitmap
- (name)
- type
- rule
- [no] access-type
----[no] termination
- (if-index)
- [no] directory-number
- [no] user-name
- [no] display-name
- [no] uri
- [no] direct-uri
- [no] line-feed
- [no] md5-realm
- [no] md5-password
- [no] admin-status
- [no] clip-mode
- [no] anti-tapping
- [no] impedance
- [no] rx-gain
- [no] tx-gain
- [no] warmline-service
- [no] linesig-remanswer
- [no] line-id
- [no] force-hold
- [no] callwait-service
- [no] callhold-service
- [no] callconf-service
- [no] calltras-service
- [no] testaccessstate
- [no] busyoverwrite
- [no] accessontimeout
- [no] provider-name
----tca
- [no] enable
- [no] high-jbfl
- [no] low-jbfl
----register
- (provider-name)
- [no] register-uri
- [no] register-intv
- [no] reg-retry-intv
- [no] reg-prev-ava-intv
- [no] reg-head-start
- [no] reg-start-min
----[no] transport
- (trans-protocol)
- provider-name
- [no] admin-status
- [no] port-rcv
- [no] tcp-idle-time
- [no] max-out-udp-size
----redundancy
- (admin-domain-name)
- [no] support-redun
- [no] dns-purge-timer
- [no] dns-ini-retr-int
- [no] dns-max-retr-nbr
- [no] fg-monitor-method
- [no] fg-monitor-int
- [no] bg-monitor-method
- [no] bg-monitor-int
- [no] stable-obs-period
- [no] fo-hystersis
- [no] del-upd-threshold
- [no] auto-server-fo
- [no] auto-server-fb
- [no] auto-sos-fo
- [no] auto-sos-fb
- [no] rtry-after-thrsh
- [no] options-max-fwd
- [no] dns-redun-mode
----system
----session-timer
X [no] enable
- [no] status
- [no] min-se-time
- [no] se-time
- [no] admin-status
----[no] dnsserver
- (name)
- [no] admin-status
- address
- [no] priority
- [no] site
- admin-domain-name
- [no] port
----[no] dhcp-authent-para
- (ua-name)
- secret-id
- [no] key
- [no] action-type
----redundancy-cmd
- (domain-name)
- [no] start-time
- [no] end-time
- fail-x-type
----statistics
----stats-config
- [no] per-line
- [no] per-board
- [no] per-system
- [no] per-call
- [no] out-any-rsp
- [no] out-180-rsp
- [no] out-200-rsp
- [no] in-any-rsp
- [no] in-180-rsp
----cluster
- (cluster-id)
----ip
- [no] ivps-ip
- [no] netmask
- [no] router-ip
- vlan-id
- [no] ip-mode
- [no] dhcpoption60
- [no] private-ip
- [no] private-netmask
- [no] private-vlan-id
----[no] equipment
- (equip-id)
- asam-id
- ip-address
- [no] next-hop
----[no] board
- (board-id)
- planned-type
- lanx-port
----[no] termination
- (port-id)
- [no] type
- [no] isdn-codec
- [no] switch-type
- [no] activate-type
- termination-id
- media-gateway-id
- [no] admin-status
- [no] line-feed
- [no] rx-gain
- [no] tx-gain
- [no] impedance
- [no] rtp-dscp
- [no] rtp-pbits
- [no] clip-mode
- [no] metering-type
- [no] directory-number
- [no] voice-service
----tca
- [no] tca-enable
- [no] rtp-pktloss-thres
- [no] rtp-jitter-thres
- [no] rtp-delay-thres
----[no] media-gateway
- (media-gateway-id)
- [no] name
- [no] ip-mode
- [no] dhcpoption60
- [no] ip-address
- [no] netmask
- [no] udp-port
- [no] router-ip
- vlan-id
- [no] mgc-type
- prim-mgc-ip
- [no] mgc-id
- [no] prim-mgc-udp
- [no] sec-mgc-ip
- [no] sec-mgc-udp
- [no] tert-mgc-ip
- [no] tert-mgc-udp
- [no] quat-mgc-ip
- [no] quat-mgc-udp
- [no] esa-mgc-service
- [no] mg-mid-type
- [no] mg-domain-name
- [no] svcreason-format
- [no] mg-profile-name
- [no] admin-status
- [no] termid-type
- [no] pstn-term-format
- isdn-term-format
- isdn-suffix1
- isdn-suffix2
- [no] max-transhandling
- [no] max-network-delay
- [no] max-retrans
- [no] red-bat-delay
- [no] release-delay
- [no] release-type
- [no] wt-rls-delay
- [no] active-heartbeat
- [no] passive-heartbeat
- [no] retrans
- [no] max-waiting-delay
- [no] prov-rpl-time
- [no] signal-dscp
- [no] signal-pbits
- [no] rtp-dscp
- [no] rtp-pbits
- [no] event-req-id
- [no] stml-stdsg-evt
- [no] al-of-evt
- [no] al-on-evt
- [no] al-of-strict-evt
- [no] al-on-strict-evt
- [no] mg-overload-evt
- [no] mg-dummy-evt
- [no] rfc2833-pl-type
- [no] rfc2833-process
- [no] dial-start-timer
- [no] dial-long-timer
- [no] dial-short-timer
- [no] min-data-jitter
- [no] init-data-jitter
- [no] max-data-jitter
- [no] ephe-term-prefix
- [no] ephe-term-min
- [no] ephe-term-max
----[no] signal-gateway
- (signal-gateway-id)
- prim-asp-ip
- prim-sctp-port
- [no] sec-asp-ip
- [no] sec-sctp-port
- [no] tert-asp-ip
- [no] tert-sctp-port
- [no] quat-asp-ip
- [no] quat-sctp-port
- ip-address
- sgi-user-label
- sgi-mgi
- [no] admin-status
Command Description
This command allows the operator to manage the Voice Sip Server profile.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
> configure voice sip ( no server (name) ) | ( server (name) [ no admin-status | admin-status
<Sip::ServerAdminStatus> ] address <Sip::ServerAddr> [ no port | port <Sip::ServerPort> ] [ no server-role |
server-role <Sip::ServerRole> ] [ no priority | priority <Sip::ServerPriority> ] [ no weight | weight
<Sip::ServerWeight> ] [ no site | site <Sip::ServerSite> ] [ no transproto | transproto <Sip::ServerTransproto> ] [ no
dnsname-type | dnsname-type <Sip::DnsDomNameType> ] admin-domain-name <Sip::AdminDomName> )
Command Parameters
Table 38.2-1 "Voice Sip Server Configuration Commands" Resource Parameters
Resource Identifier Type Description
(name) Format: uniquely identify of this voice
- uniquely identifies this voice server server
- length: x<=32
Table 38.2-2 "Voice Sip Server Configuration Commands" Command Parameters
Parameter Type Description
[no] admin-status Parameter type: <Sip::ServerAdminStatus> optional parameter with default
Format: value: "down"
( up administrative status of this sip
| down ) server
Possible values:
- up : unlock the sip server
- down : lock the sip server
address Parameter type: <Sip::ServerAddr> mandatory parameter
Format: The address(ipv4 or DNS or
( ipv4 : <Ip::V4Address> FQDN) of this SIP server
| dns : <Sip::ServerAddr> )
Possible values:
- ipv4 : the address type of the server is ipv4
- dns : the address type of the server is DNS
Field type <Ip::V4Address>
- IPv4-address
Field type <Sip::ServerAddr>
- name of the SipServer that can be resolved to an IP address
via a DNS Server
Command Description
This command allows the operator to manage the Voice Sip LineId Syntax profile. This command can help operator
to get different types of sip termination contact-user-info: physicallineid or terminationuriordn. If the syntax is
'physicalLineId', then the system will construct a value according the syntax as specified in the next parameters
(depending of the type of line being pots or isdn). In case the value is 'terminationuriordn', then the value will be
taken from the corresponding parameter of the SipTermination object (chapter 38.9): the uri will be taken firstly if
it is valid, otherwise the dn can be taken. The keywords apply to the profile syntax include: "Access_Node_ID",
"Rack", "Frame", "Slot", "ShSlt", "Port","ShPrt", "Channel". The sip termination contact-user-info can be learned
using the show command: show voice sip termination.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 38.3-1 "Voice Sip LineId Syntax Profile Configuration Commands" Resource Parameters
Resource Identifier Type Description
(name) Format: uniquely identify of this lineid
- the lineid syntax profile name, can only be profile1 syntax profile, can only be
- length: x<=32 profile1
Table 38.3-2 "Voice Sip LineId Syntax Profile Configuration Commands" Command Parameters
Parameter Type Description
[no] syntax-pattern Parameter type: <SIP::LineIdSyntaxPattern> optional parameter with default
Format: value: "terminationuriordn"
( rpregisterdialog pattern of the sip LineID Syntax
| rpregister
| physicallineid
| terminationuriordn )
Possible values:
- rpregisterdialog : random per register and dialog
- rpregister : random per register
- physicallineid : physical line id
- terminationuriordn : termination uri
[no] pots-syntax Parameter type: <SIP::PotsSyntax> optional parameter with default
Command Description
This command allows the operator to manage the Voice Sip user agent profile.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
> configure voice sip ( no user-agent (name) ) | ( user-agent (name) [ no ip-addr-policy | ip-addr-policy
<Sip::IpAddrPolicy> ] [ no ip-config-mode | ip-config-mode <Sip::IpConfigMode> ] [ no signal-gateway-ip |
signal-gateway-ip <Sip::UserAgentIpAddr> ] signal-vlan-id <Sip::UserAgentVlanId> [ no signal-dscp | signal-dscp
<Sip::UserAgentSignalDscp> ] [ no signal-pbits | signal-pbits <Sip::UserAgentSignalPbits> ] [ no signal-link-mtu |
signal-link-mtu <Sip::UserAgentLinkMTU> ] [ no rtp-gateway-ip | rtp-gateway-ip <Sip::UserAgentIpAddr> ] [
rtp-vlan-id <Sip::UserAgentVlanId> ] [ no rtp-dscp | rtp-dscp <Sip::UserAgentRtpDscp> ] [ no rtp-pbits | rtp-pbits
<Sip::UserAgentRtpPbits> ] [ no rtp-link-mtu | rtp-link-mtu <Sip::UserAgentLinkMTU> ] [ no dhcp-optreq-list |
dhcp-optreq-list <Sip::UserAgentDHCPOptionReqList> ] [ no admin-status | admin-status
<Sip::UserAgentAdminStatus> ] [ no provider-name | provider-name <Sip::UserAgentProviderName> ] )
Command Parameters
Table 38.4-1 "Voice Sip User Agent Configuration Commands" Resource Parameters
Resource Identifier Type Description
(name) Format: uniquely identify of this user
- uniquely identifies the User Agent agent
- length: 1<=x<=32
Table 38.4-2 "Voice Sip User Agent Configuration Commands" Command Parameters
Parameter Type Description
[no] ip-addr-policy Parameter type: <Sip::IpAddrPolicy> optional parameter with default
Format: value: "distributed"
( distributed The ip address policy of the sip
| centralized ) user agent
Possible values:
- distributed : the ip address policy of the user agent
operation is to use an IP address per Voice LT, not
applicable for NGVR and ANSI MDU
- centralized : the ip address policy of the user agent
operation is to use a single IP address for the ISAM Voice,
NGVR and ANSI MDU
[no] ip-config-mode Parameter type: <Sip::IpConfigMode> optional parameter with default
Command Description
This command allows the operator to configure the Voice Service Provider.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
> configure voice sip ( no vsp (name) ) | ( vsp (name) domain-name <Sip::VspDomainName> [ no admin-status |
admin-status <Sip::VspAdminStatus> ] [ no tinfo | tinfo <Sip::VspTinfo> ] [ no ta4 | ta4 <Sip::VspTa4> ] [ no ttir1
| ttir1 <Sip::VspTtir1> ] [ no t-acm-delta | t-acm-delta <Sip::VspTAcmDelta> ] [ no access-held-time |
access-held-time <Sip::VSPAccessHeldTimer> ] [ no awaiting-time | awaiting-time <Sip::VSPAwaitingTimer> ] [
no digit-send-mode | digit-send-mode <Sip::VSPDigitSendingMode> ] [ no overlap-484-act | overlap-484-act
<Sip::VSPOverlap484Action> ] [ no dmpm-intdgt-expid | dmpm-intdgt-expid <Sip::VSPDMPMIntDgtExpid> ] [
no dial-start-timer | dial-start-timer <Sip::VSPDialStartTimer> ] [ no dial-long-timer | dial-long-timer
<Sip::VSPDialLongTimer> ] [ no dial-short-timer | dial-short-timer <Sip::VSPDialShortTimer> ] [ no uri-type |
uri-type <Sip::VSPURIType> ] [ no rfc2833-pl-type | rfc2833-pl-type <Sip::VSPRfc2833PayloadType> ] [ no
rfc2833-process | rfc2833-process <Sip::VSPRfc2833Process> ] [ no min-data-jitter | min-data-jitter
<Sip::VSPDataJitter> ] [ no init-data-jitter | init-data-jitter <Sip::VSPDataJitter> ] [ no max-data-jitter |
max-data-jitter <Sip::VSPDataJitter> ] [ no release-mode | release-mode <Sip::VSPReleaseMode> ] [ no
dyn-pt-nego-type | dyn-pt-nego-type <Sip::VSPDynamicPTNegoType> ] [ no vbd-g711a-pl-type |
vbd-g711a-pl-type <Sip::VSPVbdG711APayloadType> ] [ no vbd-g711u-pl-type | vbd-g711u-pl-type
<Sip::VSPVbdG711UPayloadType> ] [ no vbd-mode | vbd-mode <Sip::VSPVbdMode> ] [ no warmline-dl-timer |
warmline-dl-timer <Sip::VSPWarmlineDelayTimer> ] [ no timer-b | timer-b <Sip::CommonCfgTimerB> ] [ no
timer-f | timer-f <Sip::CommonCfgTimerF> ] [ no timer-t1 | timer-t1 <Sip::CommonCfgTimerT1> ] [ no timer-t2 |
timer-t2 <Sip::CommonCfgTimerT2> ] [ no reg-sub | reg-sub <Sip::VSPRegSubscribe> ] [ no sub-period |
sub-period <Sip::VSPSubscribePeriod> ] [ no sub-head-start | sub-head-start <Sip::VSPSubscribeHeadStart> ] [ no
t38-same-udp | t38-same-udp <Sip::VSPT38withSameUDP> ] [ no dhcp-option82 | dhcp-option82
<Sip::DHCPOption82> ] )
Command Parameters
Table 38.5-1 "Sip Voice Service Provider Configuration Commands" Resource Parameters
Resource Identifier Type Description
(name) Format: uniquely identify of this sip voice
- uniquely identify of this SIP voice service provider service provider
- length: x<=32
Table 38.5-2 "Sip Voice Service Provider Configuration Commands" Command Parameters
Command Description
This command allows the operator to configure the Voice Sip User Agent Access Point. This command depends on
the Voice Sip UserAgent Configuration command. When a SIP User Agent is created/deleted, the user agent access
point(s) will be created/deleted automatically according to the SIP UA ip-address-policy. The user agent access
point(s) can be learned using the show command: show voice sip user-agent-ap.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
> configure voice sip user-agent-ap (ua-name) slot-id <SIP::SlotIndex> [ signal-ip <SIP::IpAddressAndMask> ] [
rtp-ip <SIP::IpAddressAndMask> ] [ no dhcp-fqdn | dhcp-fqdn <Sip::UaApDHCPFQDN> ] [ no dhcp-customer-id
| dhcp-customer-id <Sip::UaApDHCPCustomerID> ] [ no admin-status | admin-status <Sip::UaApAdminStatus> ]
Command Parameters
Table 38.6-1 "Voice Sip User Agent Access Point Configuration Command" Resource Parameters
Resource Identifier Type Description
(ua-name) Format: uniquely identify of the user
- uniquely identifies the User Agent agent
- length: 1<=x<=32
slot-id Parameter type: <SIP::SlotIndex> slot id associated with this user
Format: agent access point
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt
| nt
| ntio
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt : nt-slot
- nt : nt-slot
- ntio : ntio-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Command Description
This command allows the operator to manage the Voice Sip dial plan profile.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
> configure voice sip ( no dialplan (name) ) | ( dialplan (name) [ no pre-activated | pre-activated
<Sip::DialPlanPreActivated> ] [ no static-prefix | static-prefix <Sip::DialPlanStaticPrefix> ] [ no static-suffix |
static-suffix <Sip::DialPlanStaticSuffix> ] [ no digitmap-mode | digitmap-mode <Sip::DialPlanDigitMapMode> ] [
no provider-name | provider-name <Sip::DialPlanProviderName> ] )
Command Parameters
Table 38.7-1 "Voice Sip Dial Plan Configuration Commands" Resource Parameters
Resource Identifier Type Description
(name) Format: unique identity of a voice sip dial
- uniquely identifies the dial plan plan
- length: 1<=x<=32
Table 38.7-2 "Voice Sip Dial Plan Configuration Commands" Command Parameters
Parameter Type Description
[no] pre-activated Parameter type: <Sip::DialPlanPreActivated> optional parameter with default
Format: value: "off"
( on identify the status for sip dial
| off ) plan prefix
Possible values:
- on : Prefix activated of dial plan is on
- off : Prefix activated of dial plan is off
[no] static-prefix Parameter type: <Sip::DialPlanStaticPrefix> optional parameter with default
Format: value: ""
- static prefix added to all valid DNs identify static prefix(area code)
- length: x<=32 added to valid DNs
[no] static-suffix Parameter type: <Sip::DialPlanStaticSuffix> optional parameter with default
Format: value: ""
- static suffix added to all valid DNs identify static suffix(area code)
- length: x<=32 added all valid DNs
[no] digitmap-mode Parameter type: <Sip::DialPlanDigitMapMode> optional parameter with default
Format: value: "maximum"
( maximum identify the digit match mode for
| minimum ) dial plan
Possible values:
Command Description
This command allows the operator to manage the Voice Sip dialplan digitmap profile.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 38.8-1 "Voice Sip Dial Plan Digitmap Configuration Commands" Resource Parameters
Resource Identifier Type Description
(name) Format: identify voice application dial
- uniquely identifies the dial plan plan within the scope
- length: 1<=x<=32
type Parameter type: <Sip::DialPlanDigitmapType> identify the type of sip dial plan
Format: digitmap
regular
Possible values:
- regular : digitmap type
rule Parameter type: <Sip::DialPlanDigitmapValue> identify the value of sip dial plan
Format: digitmap
- identity the value of digitmap
- length: 1<=x<=100
Table 38.8-2 "Voice Sip Dial Plan Digitmap Configuration Commands" Command Parameters
Parameter Type Description
[no] access-type Parameter type: <Sip::DialPlanDigitmapAccessType> optional parameter with default
Format: value: "allowed"
allowed The parameter is not visible
Possible values: during creation.
- allowed : the digitmap can be used The access type of digitmap
Command Description
This command allows the operator to manage the Voice Sip termination profile.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 38.9-1 "Voice Sip Termination Configuration Commands" Resource Parameters
Resource Identifier Type Description
(if-index) Format: The unique internal identifier of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the termination port
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Command Description
This command allows the operator to enable/disable tca or configure the high/low threshold for jitter buffer fill
level of the sip termination.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
> configure voice sip termination (if-index) tca [ [ no ] enable ] [ no high-jbfl | high-jbfl <Sip::JBFL> ] [ no
low-jbfl | low-jbfl <Sip::JBFL> ]
Command Parameters
Table 38.10-1 "Voice Sip Termination TCA Threshold Configuration Command" Resource
Parameters
Resource Identifier Type Description
(if-index) Format: The unique internal identifier of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the termination port
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 38.10-2 "Voice Sip Termination TCA Threshold Configuration Command" Command
Parameters
Parameter Type Description
[no] enable Parameter type: boolean optional parameter
Enable the reporting of tca for sip
termination
[no] high-jbfl Parameter type: <Sip::JBFL> optional parameter with default
Format: value: 90
- average of jitter buffer fill level percentage for the the high threshould for jitter
termination buffer fill level. it can not be
- unit: percentage smaller than low-jbfl. 100 mean
Command Description
This command allows the operator to configure the SIP Voice Register parameters .
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
> configure voice sip register (provider-name) [ no register-uri | register-uri <Sip::RegisterUri> ] [ no register-intv |
register-intv <Sip::RegisterIntv> ] [ no reg-retry-intv | reg-retry-intv <Sip::RegisterRetryIntv> ] [ no
reg-prev-ava-intv | reg-prev-ava-intv <Sip::RegisterPrevAvaIntv> ] [ no reg-head-start | reg-head-start
<Sip::RegisterHeadStart> ] [ no reg-start-min | reg-start-min <Sip::RegisterStartMin> ]
Command Parameters
Table 38.11-1 "Sip Voice Register Configuration Commands" Resource Parameters
Resource Identifier Type Description
(provider-name) Format: uniquely identify register
- provider name provider name
- length: x<=32
Table 38.11-2 "Sip Voice Register Configuration Commands" Command Parameters
Parameter Type Description
[no] register-uri Parameter type: <Sip::RegisterUri> optional parameter with default
Format: value: ""
- The registration URI to be used by all SIP terminations that The registration URI to be used
have a service agreement with this SIP Voice Service by all SIP terminations that have
provider a service agreement with this SIP
- length: x<=80 Voice Service provider.
[no] register-intv Parameter type: <Sip::RegisterIntv> optional parameter with default
Format: value: 3600
- The registration expiration time that UA will propose in The registration expiration time
the Expires header of a REGISTER request, unless the value that UA will propose in the
is 0. If the value is set to 0 the UA shall not refresh a Expires header of a REGISTER
registration even if the server specifies an expiration request, unless the value is 0. If
interval. Accept value greater than or equal to 60 the value is set to 0 the UA shall
[0|(60..86400)] not refresh a registration even if
- unit: second the server specifies an expiration
- range: [0...86400] interval.
[no] reg-retry-intv Parameter type: <Sip::RegisterRetryIntv> optional parameter with default
Format: value: 60
- The interval between successive registration retries after a The interval between successive
failed registration. The value of 0 shall disable registration registration retries after a failed
Command Description
This command allows the operator to manage the Voice Sip Transport params.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 38.12-1 "Voice Sip Transport Configuration Commands" Resource Parameters
Resource Identifier Type Description
(trans-protocol) Format: Terminations will use this
( udp transport for establishing the calls
| tcp
| udp_tcp )
Possible values:
- udp : transport protocol is udp
- tcp : transport protocol is support tcp
- udp_tcp : transport protocol is udp and tcp
provider-name Parameter type: <Sip::TransportProviderName> uniquely identify transport
Format: provider name
- uniquely identifies the transport provider name
- length: x<=32
Table 38.12-2 "Voice Sip Transport Configuration Commands" Command Parameters
Parameter Type Description
[no] admin-status Parameter type: <Sip::TransportAdminStatus> optional parameter with default
Format: value: "down"
( up change administrative status
| down )
Possible values:
- up : unlock the dns server
- down : lock the dns server
Command Description
This command allows the operator to manage the Voice Sip Redundancy table.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 38.13-1 "Voice Sip Redundancy Table Configuration Commands" Resource Parameters
Resource Identifier Type Description
(admin-domain-name) Format: The administrative domain name
- uniquely name of this element of the (farm of) SIP First hop(s)
- length: x<=32
Table 38.13-2 "Voice Sip Redundancy Table Configuration Commands" Command Parameters
Parameter Type Description
[no] support-redun Parameter type: <Sip::NetwRedunSupported> optional parameter with default
Format: value: "disable"
( enable This object allows the
| disable ) administrator to define whether
Possible values: the Voice Service Provider
- enable : support Redundancy network supports redundancy or
- disable : doesn't supprot Redundancy not.
Command Description
this command allows the operator to manage the voice sip session timer profile. The timer is used to consult with
remote, and at last, if session timer was enabled, the refresh timer will be started by IPTK. The SIP Session Timer
feature adds the capability to periodically refresh SIP sessions by sending repeated INVITE requests. The repeated
INVITE requests, or re-INVITEs, are sent during an active call leg to allow user agents (UA) or SIP proxies to
determine the status of a SIP session. Without this keep alive mechanism, proxies that remember incoming and
outgoing requests (stateful proxies) may continue to retain call state needlessly. If a UA fails to send a BYE
message at the end of a session or if the BYE message is lost because of network problems, a stateful proxy does
not know that the session has ended. The re-INVITES ensure that active sessions stay active and completed sessions
are terminated.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
> configure voice sip system session-timer [ [ no ] enable ] [ no status | status <Sip::SessionTimerAdminState> ] [
no min-se-time | min-se-time <Sip::SessionTimerMinSE> ] [ no se-time | se-time
<Sip::SessionTimerSessionExpire> ] [ no admin-status | admin-status <Sip::SysObjectsAdminStatus> ]
Command Parameters
Table 38.14-2 "Voice Sip System Session Timer Configuration Commands" Command Parameters
Parameter Type Description
[no] enable Parameter type: boolean obsolete parameter replaced by
parameter "status"
Prefix activated of session timer
is enable
[no] status Parameter type: <Sip::SessionTimerAdminState> optional parameter with default
Format: value: "disable"
( enable To configure the SIP Session
| disable Timer feature capability. If it's
| enable-uas ) disable, shall not request session
Possible values: expiration in initial INVITE
- enable : Prefix activated of session timer is enable requests and 200 OK responses If
- disable : Prefix activated of session timer is disable it's enable, shall request session
- enable-uas : Prefix activated of session timer is expiration in initial INVITE
enableAsUas requests and 200 OK responses,
and in both cases, if an incoming
initial INVITE request contains a
Command Description
This command allows the operator to manage the Voice Sip DNS Server profile.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
> configure voice sip ( no dnsserver (name) ) | ( dnsserver (name) [ no admin-status | admin-status
<Sip::sipDNSServerAdminStatus> ] address <Sip::sipDNSServerAddr> [ no priority | priority
<Sip::sipDNSServerPriority> ] [ no site | site <Sip::sipDNSServerSite> ] admin-domain-name
<Sip::AdminDomName> [ no port | port <Sip::sipDNSServerPort> ] )
Command Parameters
Table 38.15-1 "Voice Sip DNS Server Configuration Commands" Resource Parameters
Resource Identifier Type Description
(name) Format: uniquely identify of this sip DNS
- uniquely identifies this voice dns server server
- length: 1<=x<=32
Table 38.15-2 "Voice Sip DNS Server Configuration Commands" Command Parameters
Parameter Type Description
[no] admin-status Parameter type: <Sip::sipDNSServerAdminStatus> optional parameter with default
Format: value: "down"
( up administrative status of this DNS
| down ) server
Possible values:
- up : unlock the dns server
- down : lock the dns server
address Parameter type: <Sip::sipDNSServerAddr> mandatory parameter
Format: The address(ipv4) of this DNS
ipv4 : <Ip::V4Address> server
Possible values:
- ipv4 : the address type of the server is ipv4
Field type <Ip::V4Address>
- IPv4-address
[no] priority Parameter type: <Sip::sipDNSServerPriority> optional parameter with default
Format: value: 100
- the SIP dns server priority, lower value with higher priority The priority of sip DNS
Command Description
This command allows the operator to manage the Voice Sip DHCP authentication params.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 38.16-1 "Voice Sip DHCP Authentication Params Configuration Commands" Resource
Parameters
Resource Identifier Type Description
(ua-name) Format: uniquely identify of the user
- uniquely identifies the User Agent agent
- length: 1<=x<=32
secret-id Parameter type: <Sip::DHCPAuthentParaSecretId> A unique identifier of the DHCP
Format: message authentication parameter
- Unique identifier of the DHCP message authentication record
parameter record
- range: [1...4294967295]
Table 38.16-2 "Voice Sip DHCP Authentication Params Configuration Commands" Command
Parameters
Parameter Type Description
[no] key Parameter type: <Sip::DHCPAuthentParaKey> optional parameter with default
Format: value: ""
- DHCP secret key used for DHCP message authentication. DHCP secret key used for DHCP
Every letter in key must be in '0'~'9', 'a'~'f', 'A'~'F' and the message authentication. Every
string length must be even. letter in key must be in '0'~'9',
- length: x<=32 'a'~'f', 'A'~'F' and the string length
must be even.
[no] action-type Parameter type: <Sip::DHCPAuthentParaActionType> optional parameter with default
Format: value: "normal-send-req"
( normal-req-key the action type for the configured
| force-discover DHCP secret keys
Command Description
This command allows the operator to change the Failover/Failback type or mode.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 38.17-1 "Voice Sip Restoration Failover/Failback Type/Mode Configuration Commands"
Resource Parameters
Resource Identifier Type Description
(domain-name) Format: uniquely identify of admin
- uniquely identifies the transport provider name domain name
- length: x<=32
Table 38.17-2 "Voice Sip Restoration Failover/Failback Type/Mode Configuration Commands"
Command Parameters
Parameter Type Description
[no] start-time Parameter type: <Sip::FailXStartTime> optional parameter with default
Format: value: 0
- The absolute time when the manually triggered GEO The absolute time when the
Fail-Over / Fail-Back needs to start. The unit is in seconds. manually triggered GEO
- unit: second Fail-Over / Fail-Back needs to
- range: [0...4294967295] start. The unit is in seconds.
[no] end-time Parameter type: <Sip::FailXEndTime> optional parameter with default
Format: value: 0
- The absolute time when the manually triggered graceful The absolute time when the
GEO Fail-Over / Fail-Back needs to be completed. The unit manually triggered graceful GEO
is in seconds. Fail-Over / Fail-Back needs to be
- unit: second completed. The unit is in
- range: [0...4294967295] seconds.
fail-x-type Parameter type: <Sip::FailXType> optional parameter
Format: Fail X type, failover or failback.
( geo-fail-over
| geo-fail-back )
Command Description
Set statistics configuration.
User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.
Command Syntax
The command has the following syntax:
> configure voice sip statistics stats-config [ [ no ] per-line ] [ [ no ] per-board ] [ [ no ] per-system ] [ [ no ] per-call
] [ [ no ] out-any-rsp ] [ [ no ] out-180-rsp ] [ [ no ] out-200-rsp ] [ [ no ] in-any-rsp ] [ [ no ] in-180-rsp ]
Command Parameters
Table 38.18-2 "Voice Statistics Configure Command" Command Parameters
Parameter Type Description
[no] per-line Parameter type: boolean optional parameter
enable per line statistics function
[no] per-board Parameter type: boolean optional parameter
enable per board statistics
function
[no] per-system Parameter type: boolean optional parameter
enable per system statistics
function
[no] per-call Parameter type: boolean optional parameter
enable per call statistics function
[no] out-any-rsp Parameter type: boolean optional parameter
enable Arbitrary Response Mode
for out-going call answered
[no] out-180-rsp Parameter type: boolean optional parameter
enable 180 Response Mode for
out-going call answered
[no] out-200-rsp Parameter type: boolean optional parameter
enable 200 Response Mode for
out-going call answered
[no] in-any-rsp Parameter type: boolean optional parameter
enable Arbitrary Response Mode
for in-coming call answered
[no] in-180-rsp Parameter type: boolean optional parameter
enable 180 Response Mode for
in-coming call answered
Command Description
This command allows the operator to manage the Voice Cluster.
User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 38.19-1 "Voice Cluster Configuration Commands" Resource Parameters
Resource Identifier Type Description
(cluster-id) Format: uniquely identify of this xvps
- the xvps cluster id cluster
- range: [1...8]
Command Description
This command allows the operator to manage the Voice Megaco xvps ip.
User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.
Command Syntax
The command has the following syntax:
> configure voice cluster (cluster-id) ip [ no ivps-ip | ivps-ip <Ip::V4Address> ] [ no netmask | netmask
<Ip::V4Address> ] [ no router-ip | router-ip <Ip::V4Address> ] [ vlan-id <MEGACO::ivpsXLESVLAN> ] [ no
ip-mode | ip-mode <MEGACO::voiceIPConfigMode> ] [ no dhcpoption60 | dhcpoption60
<MEGACO::voiceIPDhcpv4Option60> ] [ no private-ip | private-ip <Ip::V4Address> ] [ no private-netmask |
private-netmask <Ip::V4Address> ] [ no private-vlan-id | private-vlan-id <MEGACO::ivpsPrivateVLAN> ]
Command Parameters
Table 38.20-1 "Voice Megaco IP Configuration Commands" Resource Parameters
Resource Identifier Type Description
(cluster-id) Format: uniquely identify of this xvps
- the xvps cluster id cluster
- range: [1...8]
Table 38.20-2 "Voice Megaco IP Configuration Commands" Command Parameters
Parameter Type Description
[no] ivps-ip Parameter type: <Ip::V4Address> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address xles ip address of this xvps
cluster.When operator configure
Ip parameters first time ,operator
should provide ivps-ip,netmask
and vlan-id at the same time.
[no] netmask Parameter type: <Ip::V4Address> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address xles ip subnet mask address of
this xvps cluster.When operator
configure Ip parameters first time
,operator should provide
ivps-ip,netmask and vlan-id at the
same time.
[no] router-ip Parameter type: <Ip::V4Address> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address the next hop ip address of this
Command Description
This command allows the operator to manage the Voice equipment.One ivps can manage at most 256
equipments,so the id of equipment is from 1 to 256.
If you want to configure a board or a termination ,you must configure a equipment first.
User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.
Command Syntax
The command has the following syntax:
> configure voice cluster (cluster-id) ( no equipment (equip-id) ) | ( equipment (equip-id) asam-id
<MEGACO::accessEquipmentAsamId> ip-address <Ip::V4Address> [ no next-hop | next-hop <Ip::V4Address> ] )
Command Parameters
Table 38.21-1 "Voice Megaco Equipment Configuration Commands" Resource Parameters
Resource Identifier Type Description
(cluster-id) Format: uniquely identify of this xvps
- the xvps cluster id cluster
- range: [1...8]
(equip-id) Format: uniquely identify of this
- id of equipment equipment
- range: [1...32]
Table 38.21-2 "Voice Megaco Equipment Configuration Commands" Command Parameters
Parameter Type Description
asam-id Parameter type: <MEGACO::accessEquipmentAsamId> mandatory parameter
Format: asam identify of this ne
- the equipment asam id of ne
- range: [a-zA-Z0-9-_./]
- length: x<=64
ip-address Parameter type: <Ip::V4Address> mandatory parameter
Format: The parameter is not visible
- IPv4-address during modification.
the voice ip address of this
isam-v ne, it should be
configured to be same as ivps-ip
for 7363/7367 in manual mode.
Command Description
This command allows the operator to manage the Voice board.Before you confiure a board,you must configure a
equipment first.
User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.
Command Syntax
The command has the following syntax:
> configure voice cluster (cluster-id) equipment (equip-id) ( no board (board-id) ) | ( board (board-id) planned-type
<Equipm::BoardFuncType> lanx-port <MEGACO::accessBoardLanxPort> )
Command Parameters
Table 38.22-1 "Voice Megaco Equipment Board Configuration Commands" Resource Parameters
Resource Identifier Type Description
(cluster-id) Format: uniquely identify of this xvps
- the xvps cluster id cluster
- range: [1...8]
(equip-id) Format: uniquely identify of this
- id of equipment equipment
- range: [1...32]
(board-id) Format: uniquely identify of this board.
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> the CLI slot numbering method is
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> ) based on logical concept.for XD
Field type <Eqpt::RackId> shelf, CLI logic slot-id(1 to 16) is
- the rack number mapped to physical slot-id from 4
Field type <Eqpt::ShelfId> to 19. for FD shelf, CLI logic
- the shelf number slot-id(1 to 16) is mapped to
Field type <Eqpt::NewSlotId> physical slot-id from 1 to 8 and
- the LT slot number 12 to 19. In extend-lt mode, the
slot-id range shall be 1 to 18.For
XD shelf, CLI logic slot-id(17 to
18) is mapped to physical slot-id
from 2 to 3. for FD shelf, CLI
logic slot-id(17 to 18) is mapped
to physical slot-id from 10 to 11
Table 38.22-2 "Voice Megaco Equipment Board Configuration Commands" Command Parameters
Command Description
This command allows the operator to manage the Voice termination.Before you configure a termination ,you must
configure a equipment first.
User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.
Command Syntax
The command has the following syntax:
> configure voice cluster (cluster-id) equipment (equip-id) ( no termination (port-id) ) | ( termination (port-id) [ no
type | type <MEGACO::accTerminationUserPortType> ] [ no isdn-codec | isdn-codec
<MEGACO::IsdnCodecType> ] [ no switch-type | switch-type <MEGACO::accTerminationPacketSwitchType> ] [
no activate-type | activate-type <MEGACO::accTerminationL1ActivateType> ] [ termination-id
<MEGACO::accessTerminationId> ] media-gateway-id <MEGACO::MediaGatewayId> [ no admin-status |
admin-status <MEGACO::accTerminationAdminStatus> ] [ no line-feed | line-feed
<MEGACO::accTerminationLineCharact> ] [ no rx-gain | rx-gain <MEGACO::accTerminationRxGain> ] [ no
tx-gain | tx-gain <MEGACO::accTerminationTxGain> ] [ no impedance | impedance
<MEGACO::accTerminationImpedance> ] [ no rtp-dscp | rtp-dscp <MEGACO::accTerminationVoiceDscp> ] [ no
rtp-pbits | rtp-pbits <MEGACO::accTerminationVoiceDot1P> ] [ no clip-mode | clip-mode
<MEGACO::accTerminationETSIClipDataMode> ] [ no metering-type | metering-type
<MEGACO::accTerminationMeteringPulseType> ] [ no directory-number | directory-number
<MEGACO::accTerminationDirectoryNumber> ] [ no voice-service | voice-service
<MEGACO::accTermVoiceServAtMgc> ] )
Command Parameters
Table 38.23-1 "Voice Megaco Equipment Termination Configuration Commands" Resource
Parameters
Resource Identifier Type Description
(cluster-id) Format: uniquely identify of this xvps
- the xvps cluster id cluster
- range: [1...8]
(equip-id) Format: uniquely identify of this
- id of equipment equipment
- range: [1...32]
(port-id) Format: unique identifier of this
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> / termination port
<Eqpt::MegacoPortId>
Field type <Eqpt::RackId>
Command Description
This command allows the operator to enable/disable tca or configure the threshold for rtp packetloss, jitter and
delay of the Voice termination.
User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.
Command Syntax
The command has the following syntax:
> configure voice cluster (cluster-id) equipment (equip-id) termination (port-id) tca [ no tca-enable | tca-enable
<MEGACO::accTerminationTCAEnable> ] [ no rtp-pktloss-thres | rtp-pktloss-thres
<MEGACO::accTerminationRtpPacketLossTCAThreshold> ] [ no rtp-jitter-thres | rtp-jitter-thres
<MEGACO::accTerminationRtpJitterTCAThreshold> ] [ no rtp-delay-thres | rtp-delay-thres
<MEGACO::accTerminationRtpDelayTCAThreshold> ]
Command Parameters
Table 38.24-1 "Voice Megaco Termination Configuration Commands" Resource Parameters
Resource Identifier Type Description
(cluster-id) Format: uniquely identify of this xvps
- the xvps cluster id cluster
- range: [1...8]
(equip-id) Format: uniquely identify of this
- id of equipment equipment
- range: [1...32]
(port-id) Format: unique identifier of this
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> / termination port
<Eqpt::MegacoPortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::NewSlotId>
- the LT slot number
Field type <Eqpt::MegacoPortId>
- the port number of Megaco
Table 38.24-2 "Voice Megaco Termination Configuration Commands" Command Parameters
Command Description
This command allows the operator to manage the Voice Megaco media gateway.
- pstn-term-format: the termination id format pattern of pstn user.
If termid-type is hierarchy, It should be a string constructed according to the following rule:
[prefix][['Dslam_Id'][deli1]][['rack'][formater][deli2]]'shelf'[formater][deli3]'slot'[formater][deli4]'port'[formater]
and thereinto:
'Dslam_Id' is key to indicate whether the Dslam id should be filled into hierarchy termination id. It is optional.
'rack' is key to indicate whether the rack id should be filled into hierarchy termination id. It is optional.
'shelf' is key to indicate the shelf id. It is mandatory.
'slot' is key to indicate the slot id. It is mandatory.
'port' is key to indicate the port id. It is mandatory.
Each key should present only once and the order of the keys should keep as in the rule.
deli can be zero or several characters, be note that the char must be valid for MEGACO termination id.
formater is a format string to indicate how ISAMV should format the id right before it. It must be
constructed by zero or at most five digits. The number of digits indicate the minimum width of the id
in the termination id, so if the width of the id is less than number of digits in formater, '0' is
filling at the beginning. The value that converted by the digits into a integer indicates the value of
the first device NO. in the termination id. If the no digit existing, it indicates that no format need to
be applied.
prefix is a string constructed by any character that is valid for MEGACO termination id.
At least one of the deli and the formater must be presenting after the key(exclude 'Dslam_Id').
for example:
format string port position termination id
(dslamid/rack/shelf/slot/port)
-------------------------------------------------------------------
AL/Dslam_Id/rack/shelf/slot/port nod01/1/1/1/1 AL/nod01/1/1/1/1
AL/Dslam_Id/shelf/slot/port nod01/1/1/1/1 AL/nod01/1/1/1
AL/rack/shelf/slot/port nod01/1/1/1/1 AL/1/1/1/1
AL/rack0/shelf0/slot0/port00 nod01/1/1/1/1 AL/0/0/0/00
ALDslam_Idrack0shelf0slot0port00 nod01/1/1/1/1 ALnod0100000
ALDslam_Idrack0shelf0slot0port0 nod01/1/1/1/12 ALnod0100012
-------------------------------------------------------------------
If the termid-type is flat,It should be a string constructed according to the following rule:
[prefix]['<tid'[formater]'>']
and thereinto:
prefix is a string construct by any character that is valid for MEGACO termination id.
formater is a format string to indicate how ISAMV should format the id right before it.
It must be constructed by zero or at most five digits. The number of digits indicat the
minimum width of the id in the termination id,If contains no digit, it indicat that no
format need to be applied. for example:
format string port position termination id
(termination-id)
------------------------------------------------
AL/ 0 AL/0
AL 0 AL0
AL<tid000> 0 AL000
AL<tid000> 888 AL888
-------------------------------------------------
- isdn-term-format: the termination id format pattern of isdn user.
If termid-type is hierarchy, It should be a string constructed according to the following rule:
[prefix][['Dslam_Id'][deli1]][['rack'][formater][deli2]]'shelf'[formater][deli3]'slot'[formater]
[deli4]'port'[formater]][deli4]'channel'
and thereinto:
'Dslam_Id' is key to indicate whether the Dslam id should be filled into hierarchy termination id.
It is optional.
'rack' is key to indicate whether the rack id should be filled into hierarchy termination id.
It is optional.
'shelf' is key to indicate the shelf id. It is mandatory.
'slot' is key to indicate the slot id. It is mandatory.
'port' is key to indicate the port id. It is mandatory.
'channel' is key to indicate channel id. It is mandatory.
Each key should present only once and the order of the keys should keep as in the rule.
deli can be zero or several characters, be note that the char must be valid for MEGACO termination id.
formater is a format string to indicate how ISAMV should format the id right before it. It must be
constructed by zero or at most five digits. The number of digits indicate the minimum width of the id
in the termination id, so if the width of the id is less than number of digits in formater, '0' is
filling at the beginning. The value that converted by the digits into a integer indicates the value of
the first device NO. in the termination id. If the no digit existing, it indicates that no format need to
be applied. suffix already includes delimiter, so deli4 is will be replaced by suffix.
prefix is a string constructed by any character that is valid for MEGACO termination id.
At least one of the deli and the formater must be presenting after the key(exclude 'Dslam_Id').
for example:
format string port position termination id
(dslamid/rack/shelf/slot/port suffix)
--------------------------------------------------------------------------------------
BA/Dslam_Id/rack/shelf/slot/port/channel nod01/1/1/1/1 /B1 BA/nod01/1/1/1/1/B1
BA/Dslam_Id/shelf/slot/port/channel nod01/1/1/1/1 /B1 BA/nod01/1/1/1/B1
BA/rack/shelf/slot/port/channel nod01/1/1/1/1 /B1 BA/1/1/1/1/B1
BA/rack0/shelf0/slot0/port00/channel/channel nod01/1/1/1/1 /B1 BA/0/0/0/00/B1
BADslam_Idrack0shelf0slot0port00 nod01/1/1/1/1 /B1 BAnod0100000/B1
BADslam_Idrack0shelf0slot0port0/channel nod01/1/1/1/12 B1 BAnod0100012B1
-------------------------------------------------------------------------------------
If the termid-type is flat,It should be a string constructed according to the following rule:
[prefix]['<tid'[formater]'>']
and thereinto:
prefix is a string construct by any character that is valid for MEGACO termination id.
formater is a format string to indicate how ISAMV should format the id right before it.It must be
constructed by zero or at most five digits. The number of digits indicat the minimum width of the id
in the termination id,If contains no digit, it indicat that no format need to be applied. ISDN
termination id should not be zero because zero is reserved for special use of IID.
for example:
format string port position termination id
(termination-id sufix)
----------------------------------------------------
BA/ 1 /B1 BA/1/B1
BA 1 /B1 BA1/B1
BA<tid000> 1 /B1 BA001/B1
BA<tid000> 888 /B1 BA888/B1
----------------------------------------------------
User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 38.25-1 "Voice Megaco Media Gateway Configuration Commands" Resource Parameters
Resource Identifier Type Description
(cluster-id) Format: uniquely identify of this xvps
- the xvps cluster id cluster
- range: [1...8]
(media-gateway-id) Format: uniquely identify of this media
- the media gateway table index gateway
- range: [1]
Table 38.25-2 "Voice Megaco Media Gateway Configuration Commands" Command Parameters
Parameter Type Description
[no] name Parameter type: <MEGACO::mediaGatewayName> optional parameter with default
Format: value: "AG"
- uniquely name of this media gateway device name of media gateway,
- length: 1<=x<=64 can be modified when mgi is
locked, this parameter will be
used for mg mid when
mg-mid-type select device-name.
only '*', '/', '_', '$', '@', 'ALPHA',
'DIGIT', '-', '.' are valid for
device-name.
[no] ip-mode Parameter type: <MEGACO::voiceIPConfigMode> optional parameter with default
Format: value: "manual"
( dhcp the ip mode of this media
| manual ) gateway
Possible values:
- dhcp : The ip mode is dhcp
- manual : The ip mode is manual
[no] dhcpoption60 Parameter type: <MEGACO::voiceIPDhcpv4Option60> optional parameter with default
Format: value: ""
- DHCP option 60 for the DHCP client the DHCP option 60 for the
- length: x<=64 DHCP client
[no] ip-address Parameter type: <Ip::V4Address> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address the ip address of this media
gateway
[no] netmask Parameter type: <Ip::V4Address> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address the netmask of this media
gateway
[no] udp-port Parameter type: <MEGACO::mediaGatewayUDPPort> optional parameter with default
Format: value: 2944
- the udp port of media gateway the udp port of mgi
- range: [1025...65534]
[no] router-ip Parameter type: <Ip::V4Address> optional parameter with default
Format: value: "0.0.0.0"
- IPv4-address the next hop ip address of media
gateway
vlan-id Parameter type: <MEGACO::mediaGatewayVLAN> mandatory parameter
Format: the vlan id of this xvps cluster
- the vlan id of media gateway
- range: [1...4093]
[no] mgc-type Parameter type: <MEGACO::mediaGatewayMgcType> optional parameter with default
Format: value: "general"
( general the type of media gateway
| lucent-fs5000 controller
| alcatel-a5020
| alcatel-e10
| zte-zxss
| hw-soft3000
| siemens
| nortel
| ericsson
| meta-softswitch
| italtel
| comverse
Command Description
This command allows the operator to manage the Voice Megaco signal gateway.
User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 38.26-1 "Voice Megaco Signal Gateway Configuration Commands" Resource Parameters
Resource Identifier Type Description
(cluster-id) Format: uniquely identify of this xvps
- the xvps cluster id cluster
- range: [1...8]
(signal-gateway-id) Format: uniquely identify of this signal
- the signal gateway table index gateway
- range: [1]
Table 38.26-2 "Voice Megaco Signal Gateway Configuration Commands" Command Parameters
Parameter Type Description
prim-asp-ip Parameter type: <Ip::V4Address> mandatory parameter
Format: the primary asp ip
- IPv4-address
prim-sctp-port Parameter type: mandatory parameter
<MEGACO::signallingGatewayInterfacePrimarySCTPPort> the sctp port of the primary asp
Format:
- the sctp port of the primary asp
Description
This chapter gives an overview of nodes that are handled by "Debug Configuration Commands".
Command Tree
----configure
----debug-trace
----[no] protocol-trace
- (trace-subject)
- protocol
- syslog
- [no] events
- [no] packet-summary
Command Description
This commands allows the operator to enable/disable protocol tracing. The operator can enter the protocol, port
and level of detail for which tracing can be enabled. It is mandatory to enable/disable atleast one of the tracings,
events or packet-summary.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 39.2-1 "Protocol Tracing Configuration Command" Resource Parameters
Resource Identifier Type Description
(trace-subject) Format: subject for which tracing is
( dsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> / enabled(e.g ADSL line,PVC)
<Eqpt::SlotId> / <Debug::PortId>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Debug::PortId> :
<Eqpt::VpiMandatoryId> : <Eqpt::VciMandatoryId>
| shdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Debug::PortId>
| ethernet-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Debug::PortId>
| uni : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| voip : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> )
Possible values:
- dsl-line : the xDSL line
- atm-pvc : the PVC of the ADSL line
- shdsl-line : a static shdsl line interface
- ethernet-line : a native ethernet line interface
- uni : GPON ONT uni interface
- voip : virtual uni identifier
Field type <Eqpt::RackId>
- the rack number
Description
This chapter gives an overview of nodes that are handled by "Ethernet User Ports Configuration Commands".
Command Tree
----configure
----ethernet
----line
- (if-index)
- port-type
- [no] admin-up
----tca-line-threshold
- [no] enable
- [no] los
- [no] fcs
- [no] rx-octets
- [no] tx-octets
- [no] los-day
- [no] fcs-day
- [no] rx-octets-day
- [no] tx-octets-day
----mau
- (index)
- type
- power
- [no] speed-auto-sense
- [no] autonegotiate
- [no] cap1000base-xfd
- [no] cap1000base-tfd
Command Description
This command allows the operator to configure the ethernet line.
User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 40.2-1 "Ethernet Line Configuration Command" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 40.2-2 "Ethernet Line Configuration Command" Command Parameters
Parameter Type Description
port-type Parameter type: <ETHITF::PortType> optional parameter
Format: the whole network service model
( uni based on this interface
| nni
| hc-uni
| uplink )
Possible values:
- uni : uni port type
- nni : nni port type
- hc-uni : hicap uni port type
- uplink : uplink port type
[no] admin-up Parameter type: boolean optional parameter
admin status is up (read-only for
voicefxs interface)
Command Description
This command allows the operator to configure the Threshold Crossing Alert (TCA) thresholds. The configuration
is specific per ethernet line.
User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.
Command Syntax
The command has the following syntax:
> configure ethernet line (if-index) tca-line-threshold [ [ no ] enable ] [ no los | los <ETHITF::TcaThresholdLOS> ]
[ no fcs | fcs <ETHITF::TcaThresholdFCS> ] [ no rx-octets | rx-octets <ETHITF::TcaThresholdMB> ] [ no
tx-octets | tx-octets <ETHITF::TcaThresholdMB> ] [ no los-day | los-day <ETHITF::TcaThresholdLOS> ] [ no
fcs-day | fcs-day <ETHITF::TcaThresholdFCS> ] [ no rx-octets-day | rx-octets-day <ETHITF::TcaThresholdMB> ]
[ no tx-octets-day | tx-octets-day <ETHITF::TcaThresholdMB> ]
Command Parameters
Table 40.3-1 "Ethernet Line TCA Threshold Configuration Command" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 40.3-2 "Ethernet Line TCA Threshold Configuration Command" Command Parameters
Parameter Type Description
[no] enable Parameter type: boolean optional parameter
enable the reporting of TCA's for
this ethernet line
[no] los Parameter type: <ETHITF::TcaThresholdLOS> optional parameter with default
Format: value: 0
- the tca threshold value (times), 0 - disable loss of signal error in 15 minute
Command Description
This command allows the operator to configure the Mau. The configuration is specific per ethernet line.
User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.
Command Syntax
The command has the following syntax:
> configure ethernet line (if-index) mau (index) [ type <Ether::MAUType> ] [ power <ETHITF::Power> ] [ [ no ]
speed-auto-sense ] [ [ no ] autonegotiate ] [ [ no ] cap1000base-xfd ] [ [ no ] cap1000base-tfd ]
Command Parameters
Table 40.4-1 "Ethernet Line Mau Configuration Command" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
(index) Format: identify MAU, among others
- port to which the MAU is connected connected to same interface
- range: [1...2147483647]
Table 40.4-2 "Ethernet Line Mau Configuration Command" Command Parameters
Parameter Type Description
type Parameter type: <Ether::MAUType> optional parameter
Format: the mau type
( 10baset
| 100basetxhd
| 100basetxfd
| 100basefxhd
| 100basefxfd
| 1000basexhd
| 1000basexfd
| 1000baselxhd
Description
This chapter gives an overview of nodes that are handled by "Efm Oam Configuration Commands".
Command Tree
----configure
----efm-oam
----interface
- (interface)
- [no] admin-up
- [no] passive-mode
- [no] keep-alive-intvl
- [no] response-intvl
X data-length
X bitrate
X smac
X dmac
Command Description
This command will allow the operator to enable/disable EFM OAM on the specified Ethernet-like interface and
configure the mode, alive timer and response timer intervals. In addition also the internal traffic generator data
applicable to this interface can be configured.
User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 41.2-1 "Efm Oam Interface ConfigurationCommand" Resource Parameters
Resource Identifier Type Description
(interface) Format: identification of EFM port /
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / Ethernet port
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 41.2-2 "Efm Oam Interface ConfigurationCommand" Command Parameters
Parameter Type Description
[no] admin-up Parameter type: boolean optional parameter
enable efm oam
[no] passive-mode Parameter type: boolean optional parameter
oam mode is passive
[no] keep-alive-intvl Parameter type: <Ether::KeepAliveTimeTicks> optional parameter with default
Format: value: 300
- a timeout value expressed in seconds keep alive time interval
- unit: seconds
- range: [1...300]
Description
This chapter gives an overview of nodes that are handled by "CFM Configuration Commands".
Command Tree
----configure
----cfm
----[no] domain
- (domain-index)
- name
- level
----[no] association
- (association-index)
- [no] bridgeport
- [no] vlan
- [no] mhf-creation
- name
- [no] ccm-interval
- [no] ccm-aware
- [no] ccm-admin-state
- ltm-filtering
- [no] dual-tag-aware
----[no] mep
- (mepid)
- location
- [no] cci-enable
- [no] ccm-priority
- [no] ais-enable
- [no] ais-meg-level
- [no] ais-period
- [no] ais-priority
- [no] equipment
- [no] low-pri-defect
- [no] fng-alarm-time
- [no] fng-reset-time
- [no] slm-resp-enable
- [no] dm-resp-enable
- [no] lm-resp
- [no] slm-init-enable
- [no] lm-init
----[no] remote-mep
- (rmepid)
----slm
- [no] inactivity-time
----y1731pm
----[no] domain
- (domain-index)
- association
- mep
- session-id
- type
- target-mac
- [no] priority
- [no] adminup
- interval
- size
- measurement-intvl
Command Description
This command is used to define a Maintenance Domain (MD) at particular maintenance level. There are 8 possible
levels. Note that once created, the MD cannot be modified. To modify, delete the entry and create a new one.
Note that, if an MD is deleted, any subtending Maintenance Associations (MAs), and their subtending Maintenance
Points (MPs), will be automatically deleted only if CCM Admin State is locked for all of the MAs.
User Level
The command can be accessed by operators with alarm , oam , vlan privileges, and executed by operators with
alarm , oam , vlan privileges.
Command Syntax
The command has the following syntax:
> configure cfm ( no domain (domain-index) ) | ( domain (domain-index) name <Cfm::FormatedName> level
<Cfm::MdLevelType> )
Command Parameters
Table 42.2-1 "Maintenance Domain Configuration Command" Resource Parameters
Resource Identifier Type Description
(domain-index) Format: Maintenance Domain (MD)
- Maintenance Domain (MD) index index
- range: [1...4294967295]
Table 42.2-2 "Maintenance Domain Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <Cfm::FormatedName> mandatory parameter
Format: The parameter is not visible
( dns : <Cfm::PrintableString> during modification.
| mac : <Cfm::MacAddress> Maintenance Domain (MD) name
| string : <Cfm::PrintableString> type and unique name
| none )
Possible values:
- dns : DNS name (e.g. alcatel.com)
- mac : MAC address plus 2 hex octets, e.g.
11:22:33:44:55:66:77:88
- string : A character string (e.g. operator)
- none : No MD name.
Field type <Cfm::PrintableString>
- all characters except for characters 0 to 31
- length: 1<=x<=43
Field type <Cfm::MacAddress>
- MAC address plus 2 hex octets, e.g.
Command Description
This command is used to create or modify a Maintenance Association (MA). Only modification of the
MHFCreation is allowed. As a result, the VlanId has been made optional in the Command Syntax as VlanId is
mandatory for creation and is not applicable for modification. Each Maintenance Domain (MD) can have one or
more MAs.
Note that, if an MA is deleted, any subtending Maintenance Points (MPs) will automatically be deleted.
User Level
The command can be accessed by operators with alarm , oam , vlan privileges, and executed by operators with
alarm , oam , vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 42.3-1 "Maintenance Association Configuration Command" Resource Parameters
Resource Identifier Type Description
(domain-index) Format: Maintenance Domain (MD)
- Maintenance Domain (MD) index index
- range: [1...4294967295]
(association-index) Format: Maintenance Association (MA)
- Maintenance Association (MA) index. Unique within an index. Unique within an MD
MD
- range: [1...4294967295]
Table 42.3-2 "Maintenance Association Configuration Command" Command Parameters
Parameter Type Description
[no] bridgeport Parameter type: <Cfm::InterfaceZeroIndex> optional parameter with default
Format: value: "none"
( none The parameter is not visible
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / during modification.
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> / IfIndex of UNI
<Eqpt::OntPortId> )
Command Description
This command is used to configure a Maintenance association End Point (MEP) within a Maintenance Association
(MA). Each MA can have zero or more MEPs. Once a MEP is created, it cannot be modified. To modify the MEP,
delete the entry and create a new one.
Note that there are correlations between a MEP and a VLAN port location. To create a MEP, the MEP's MA must
be associated with the port location's VLAN. Also if the port location is deleted, the related MEP(s) will
automatically be deleted.
User Level
The command can be accessed by operators with alarm , oam , vlan privileges, and executed by operators with
alarm , oam , vlan privileges.
Command Syntax
The command has the following syntax:
> configure cfm domain (domain-index) association (association-index) ( no mep (mepid) ) | ( mep (mepid)
location <Cfm::location> [ [ no ] cci-enable ] [ no ccm-priority | ccm-priority <Cfm::MepCcmPriority> ] [ [ no ]
ais-enable ] [ no ais-meg-level | ais-meg-level <Cfm::MepAisMegLevel> ] [ no ais-period | ais-period
<Cfm::MepAisPeriod> ] [ no ais-priority | ais-priority <Cfm::MepAisPriority> ] [ no equipment | equipment
<Cfm::MepEquipmentType> ] [ no low-pri-defect | low-pri-defect <Cfm::MepLowPriorityDefect> ] [ no
fng-alarm-time | fng-alarm-time <Cfm::MepFngAlarmTime> ] [ no fng-reset-time | fng-reset-time
<Cfm::MepFngResetTime> ] [ [ no ] slm-resp-enable ] [ [ no ] dm-resp-enable ] [ no lm-resp | lm-resp
<Cfm::MepLmEnableDisable> ] [ [ no ] slm-init-enable ] [ no lm-init | lm-init <Cfm::MepLmInitEnableDisable> ]
)
Command Parameters
Table 42.4-1 "Maintenance Association End Point Configuration Command" Resource Parameters
Resource Identifier Type Description
(domain-index) Format: Maintenance Domain (MD)
- Maintenance Domain (MD) index index
- range: [1...4294967295]
(association-index) Format: Maintenance Association (MA)
- Maintenance Association (MA) index. Unique within an index. Unique within an MD
MD
- range: [1...4294967295]
(mepid) Format: MA End Point (MEP) ID. Unique
- MA End Point (MEP) ID. Unique within an MA within an MA
- range: [1...8191]
Table 42.4-2 "Maintenance Association End Point Configuration Command" Command
Parameters
Parameter Type Description
location Parameter type: <Cfm::location> mandatory parameter
Format: The parameter is not visible
( user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / during modification.
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> Maintenance association End
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / Point (MEP) location
<Eqpt::PortId>
| slot : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni )
Possible values:
- user : User bridge-port location
- slot : slot location
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
[no] cci-enable Parameter type: boolean optional parameter
CCM generation is enabled on
the current MEP
[no] ccm-priority Parameter type: <Cfm::MepCcmPriority> optional parameter with default
Format: value: 7UL
- Priority value for CCMs transmitted by the MEP Priority value for CCMs
- range: [0...7] transmitted by the MEP
[no] ais-enable Parameter type: boolean optional parameter
AIS generation is enabled on the
current MEP
[no] ais-meg-level Parameter type: <Cfm::MepAisMegLevel> optional parameter with default
Format: value: 0UL
- Meg Level for AIS frames transmitted by the MEP MEG level at which the most
- range: [0...7] immediate client layer MIPs and
Command Description
This command is used to configure a Remote Maintenance association End Point (RMEP) within a Maintenance
Association (MA). Once a RMEP is created, it cannot be modified. To modify the RMEP, delete the entry and
create a new one.
Note
User Level
The command can be accessed by operators with alarm , oam , vlan privileges, and executed by operators with
alarm , oam , vlan privileges.
Command Syntax
The command has the following syntax:
> configure cfm domain (domain-index) association (association-index) ( no remote-mep (rmepid) ) | ( remote-mep
(rmepid) )
Command Parameters
Table 42.5-1 "Remote Maintenance Association End Point Configuration Command" Resource
Parameters
Resource Identifier Type Description
(domain-index) Format: Maintenance Domain (MD)
- Maintenance Domain (MD) index index
- range: [1...4294967295]
(association-index) Format: Maintenance Association (MA)
- Maintenance Association (MA) index. Unique within an index. Unique within an MD
MD
- range: [1...4294967295]
(rmepid) Format: Remote MA End Point (MEP)
- MA End Point (MEP) ID. Unique within an MA ID. Unique within an MA
- range: [1...8191]
Command Description
This command can be used to configure the parameters for synthetic loss measurement
User Level
The command can be accessed by operators with alarm , oam , vlan privileges, and executed by operators with
alarm , oam , vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 42.6-2 "Synthetic Loss Measurement configuration Commands" Command Parameters
Parameter Type Description
[no] inactivity-time Parameter type: <Cfm::slmInactivityTime> optional parameter with default
Format: value: 100L
- inactivity time value of slm inactivity timer
- unit: seconds
- range: [10...100]
Command Description
This command is used to configure PM-Proactive tests.
User Level
The command can be accessed by operators with alarm , oam , vlan privileges, and executed by operators with
alarm , oam , vlan privileges.
Command Syntax
The command has the following syntax:
Command Description
This command is used to configure PM Proactive tests.
User Level
The command can be accessed by operators with alarm , oam , vlan privileges, and executed by operators with
alarm , oam , vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 42.8-1 "CFM PM Proactive test management Command" Resource Parameters
Resource Identifier Type Description
(domain-index) Format: Maintenance Domain Index.
- Maintenance Domain (MD) index
- range: [1...4294967295]
association Parameter type: <Cfm::CfmMaIndexType> Maintenance Association Index.
Format:
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]
mep Parameter type: <Cfm::MepIdType> Maintenance Association End
Format: Point (MEP) ID. Unique within
- MA End Point (MEP) ID. Unique within an MA an MA.
- range: [1...8191]
session-id Parameter type: <Cfm::SessionIdType> PM Proactive test SessionId.
Format:
- Session Id for PM proactive
- range: [1...960]
Table 42.8-2 "CFM PM Proactive test management Command" Command Parameters
Parameter Type Description
type Parameter type: <Cfm::PmTestType> mandatory parameter
Description
This chapter gives an overview of nodes that are handled by "Trouble-Shooting Configuration Commands".
Command Tree
----configure
----trouble-shooting
----statistics
----[no] interface
- (if-index)
Command Description
This command allows the operator to enable or disable the extensive trouble-shooting counters.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 43.2-1 "Trouble-shooting Interface Configuration Commands" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the port
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> :
<Eqpt::UnstackedVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
Description
This chapter gives an overview of nodes that are handled by "IPoA/E IW Configuration Commands".
Command Tree
----configure
----ipoa/e-iw
----[no] port
- (interworking-port)
- user-ip
- gw-ip
----[no] gateway
- (vlanid)
- gw-ip-addr
Command Description
This command allows the operator to configure the parameter on the IPOA L2 interworking port level
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 44.2-1 "IPoA/E IW Interworking Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(interworking-port) Format: index of rack/shelf/slot/port
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / user-bridgeport
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Table 44.2-2 "IPoA/E IW Interworking Port Configuration Command" Command Parameters
Parameter Type Description
user-ip Parameter type: <Ip::V4AddressHex> optional parameter
Format: ip address for user
- IPv4-address
gw-ip Parameter type: <Ip::V4AddressHex> optional parameter
Format: ip address for next-hop gateway
Command Description
This command allows the operator to configure gateway address per L2 forwarder vlan
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 44.3-1 "IPoA/E IW Gateway Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlanid) Format: vlan id
( <Network::UVlanIndex>
| stacked : <Network::SVlanIndex> :
<Network::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Network::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Network::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Network::CVlanIndex>
- customer vlan identity
- range: [0...4093]
Table 44.3-2 "IPoA/E IW Gateway Configuration Command" Command Parameters
Parameter Type Description
gw-ip-addr Parameter type: <Ip::V4AddressHex> mandatory parameter
Format: the gateway ip address
- IPv4-address
Description
This chapter gives an overview of nodes that are handled by "LineTest Configuration Commands".
Command Tree
----configure
----linetest
----cluster
- (cluster-id)
----ltsession
- (sessionid)
- session-cmd
- ownerid
- timeout-period
- line-num
- type-high
- type-low
- test-parm-num
- test-mode
- type-extend
----ltline
- (sessionid)
- lineid
- line-status
----ltparm
- (sessionid)
- test-name(unit)
- value1
- value2
- value3
- value4
- value5
- min-threshold
- max-threshold
- min-threshold2
- max-threshold2
----single
----ltsession
- (sessionid)
- session-cmd
- ownerid
- timeout-period
- line-num
- type-high
- type-low
- test-parm-num
- test-mode
- inactive-timer
- type-extend
- [no] group-opt
- [no] busy-overwrite
----ltline
- (sessionid)
- lineid
- line-status
----ltparm
- (sessionid)
- test-name(unit)
- value1
- value2
- value3
- value4
- value5
- min-threshold
- max-threshold
Command Description
This command allows the operator to configure the MEGACO LineTest session parameters.
User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 45.2-1 "Megaco LineTest Session Configuration Command" Resource Parameters
Resource Identifier Type Description
(cluster-id) Format: uniquely identify of this xvps
- the xvps cluster id cluster
- range: [1...8]
(sessionid) Format: uniquely identify of session
- available session id
- range: [1]
Table 45.2-2 "Megaco LineTest Session Configuration Command" Command Parameters
Parameter Type Description
session-cmd Parameter type: <LineTest::SessCmdForConfig> optional parameter
Format: the linetest session command
( create
| starttest
| sendinfo
| startinfo
| destroy
| recv-subtest
| start-subtest
| repeat
| endtest )
Possible values:
- create : create a test session
Command Description
This command allows the operator to configure the MEGACO LineTest line parameters.
User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.
Command Syntax
The command has the following syntax:
> configure linetest cluster (cluster-id) ltline (sessionid) lineid <Itf::LineTestMegacoLineId> [ line-status
<LineTest::LineStatusForConfig> ]
Command Parameters
Table 45.3-1 "Megaco LineTest Line Configuration Command" Resource Parameters
Resource Identifier Type Description
(cluster-id) Format: uniquely identify of this xvps
- the xvps cluster id cluster
- range: [1...8]
(sessionid) Format: uniquely identify of session
- available session id
- range: [1]
lineid Parameter type: <Itf::LineTestMegacoLineId> Identify of line
Format:
<Eqpt::NodeId> / <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::NewSlotId> / <Eqpt::MegacoPortId>
Field type <Eqpt::NodeId>
- the Node number
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::NewSlotId>
- the LT slot number
Field type <Eqpt::MegacoPortId>
- the port number of Megaco
Table 45.3-2 "Megaco LineTest Line Configuration Command" Command Parameters
Parameter Type Description
line-status Parameter type: <LineTest::LineStatusForConfig> optional parameter
Command Description
This command allows the operator to manage megaco linetest parameters.
User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.
Command Syntax
The command has the following syntax:
> configure linetest cluster (cluster-id) ltparm (sessionid) test-name(unit) <LineTest::TestTypeMegaco> [ value1
<LineTest::ExtRpVal> ] [ value2 <LineTest::ExtRpVal> ] [ value3 <LineTest::ExtRpVal> ] [ value4
<LineTest::ExtRpVal> ] [ value5 <LineTest::ExtRpVal> ] [ min-threshold <LineTest::TestThreshold> ] [
max-threshold <LineTest::TestThreshold> ] [ min-threshold2 <LineTest::TestThreshold> ] [ max-threshold2
<LineTest::TestThreshold> ]
Command Parameters
Table 45.4-1 "MEGACO LineTest Param Configuration Command" Resource Parameters
Resource Identifier Type Description
(cluster-id) Format: uniquely identify of this xvps
- the xvps cluster id cluster
- range: [1...8]
(sessionid) Format: uniquely identify of session
- available session id
- range: [1...16]
test-name(unit) Parameter type: <LineTest::TestTypeMegaco> test type
Format:
( feeded-ac-tr(mv)
| feeded-ac-tg(mv)
| feeded-ac-rg(mv)
| foreign-ac-tr(mv)
| foreign-ac-tg(mv)
| foreign-ac-rg(mv)
| feeded-dc-tr(mv)
| foreign-dc-tr(mv)
| foreign-dc-tg(mv)
| foreign-dc-rg(mv)
| feed-current(ua)
| feeded-dc-rt(mv)
| resist-tr(ohm)
Command Description
This command allows the operator to configure the single LineTest session parameters.
User Level
The command can be accessed by operators with sip , xdsl privileges, and executed by operators with sip , xdsl
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 45.5-1 "SINGLE LineTest Session Configuration Command" Resource Parameters
Resource Identifier Type Description
(sessionid) Format: uniquely identify of session
- available session id
- range: [1...16]
Table 45.5-2 "SINGLE LineTest Session Configuration Command" Command Parameters
Parameter Type Description
session-cmd Parameter type: <LineTest::SessCmdForConfig> optional parameter
Format: the linetest session command
( create
| starttest
| sendinfo
| startinfo
| destroy
| recv-subtest
| start-subtest
| repeat
| endtest )
Possible values:
- create : create a test session
- starttest : transfer data done, start a test
Command Description
This command allows the operator to configure the single LineTest line parameters.
User Level
The command can be accessed by operators with sip , xdsl privileges, and executed by operators with sip , xdsl
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 45.6-1 "SINGLE LineTest Line Configuration Command" Resource Parameters
Resource Identifier Type Description
(sessionid) Format: uniquely identify of session
- available session id
- range: [1...16]
lineid Parameter type: <Itf::LineTestSingleLineId> Identify of line
Format:
<Eqpt::NodeId> / <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
Field type <Eqpt::NodeId>
- the Node number
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 45.6-2 "SINGLE LineTest Line Configuration Command" Command Parameters
Parameter Type Description
line-status Parameter type: <LineTest::LineStatusForConfig> optional parameter
Format: status of line for test
( intest
| testover
Command Description
This command allows the operator to manage single linetest parameters.
User Level
The command can be accessed by operators with sip , xdsl privileges, and executed by operators with sip , xdsl
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 45.7-1 "SINGLE LineTest Param Configuration Command" Resource Parameters
Resource Identifier Type Description
(sessionid) Format: uniquely identify of session
- available session id
- range: [1...16]
test-name(unit) Parameter type: <LineTest::TestTypeSip> test type
Format:
( feeded-ac-tr(mv)
| feeded-ac-tg(mv)
| feeded-ac-rg(mv)
| foreign-ac-tr(mv)
| foreign-ac-tg(mv)
| foreign-ac-rg(mv)
| feeded-dc-tr(mv)
| foreign-dc-tr(mv)
| foreign-dc-tg(mv)
| foreign-dc-rg(mv)
| feed-current(ua)
| feeded-dc-rt(mv)
| resist-tr(ohm)
| resist-rt(ohm)
| resist-tg(ohm)
| resist-rg(ohm)
| resist-tbat(ohm)
Description
This chapter gives an overview of nodes that are handled by "LACP Configuration Commands".
Command Tree
----configure
----link-agg
----general
- [no] priority
----port
- (port)
- [no] passive-lacp
- [no] short-timeout
- [no] actor-port-prio
----group
- (group)
- load-sharing-policy
- [no] max-active-port
- mode
----[no] port
- (port)
Command Description
This command allows the operator to configure the general LACP parameters.
User Level
The command can be accessed by operators with lacp privileges, and executed by operators with lacp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 46.2-2 "LACP general configuration command" Command Parameters
Parameter Type Description
[no] priority Parameter type: <Lacp::SysPriority> optional parameter with default
Format: value: 1
- the lacp system priority the lacp system priority
- range: [1...65535]
Command Description
This command allows the operator to configure the link aggregation port parameters.
User Level
The command can be accessed by operators with lacp privileges, and executed by operators with lacp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 46.3-1 "LACP port configuration command" Resource Parameters
Resource Identifier Type Description
(port) Format: interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 46.3-2 "LACP port configuration command" Command Parameters
Parameter Type Description
[no] passive-lacp Parameter type: boolean optional parameter
set lacp inactive for the actor
[no] short-timeout Parameter type: boolean optional parameter
short timeout for the lacp
protocol
[no] actor-port-prio Parameter type: <Lacp::ActorPortPriority> optional parameter with default
Format: value: "1"
- la aggregate port priority port priority for the actor
- range: [0...255]
Command Description
This command allows the operator to configure the link aggregation group parameters.
User Level
The command can be accessed by operators with lacp privileges, and executed by operators with lacp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 46.4-1 "LACP group configuration command" Resource Parameters
Resource Identifier Type Description
(group) Format: interface index of the link
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / aggregation group
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 46.4-2 "LACP group configuration command" Command Parameters
Parameter Type Description
load-sharing-policy Parameter type: <Lacp::LoadSharingPolicy> optional parameter
Format: link aggregation load sharing
( mac-src policy
| mac-dst
| mac-src-dst
| ip-src
| ip-dst
| ip-src-dst )
Possible values:
- mac-src : source mac based
- mac-dst : destination mac based
- mac-src-dst : source and destination mac based
- ip-src : source ip based
- ip-dst : destination ip based
Command Description
This command allows the operator to add/remove link aggregation group member ports.
User Level
The command can be accessed by operators with lacp privileges, and executed by operators with lacp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 46.5-1 "LACP Group Port configuration command" Resource Parameters
Resource Identifier Type Description
(group) Format: interface index of the link
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / aggregation group
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
(port) Format: Interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Description
This chapter gives an overview of nodes that are handled by "MSTP Configuration Commands".
Command Tree
----configure
----xstp
----general
- [no] enable-stp
- [no] priority
- [no] max-instance-num
- [no] max-age
- [no] hello-time
- [no] forward-delay
- [no] version
- [no] tx-hold-count
- [no] path-cost-type
- [no] max-hop-count
- region-name
- [no] region-version
- [no] config-id-sel
----[no] instance
- (instance)
- [no] priority
----[no] associate-vlan
- (vlan)
----port
- (port)
- [no] priority
- [no] enable-stp
- path-cost
- [no] edge-port
- [no] admin-p2p
- [no] hello-time
----port-instance
- (port)
- instance
- [no] priority
- [no] enable-stp
- path-cost
Command Description
This command allows the operator to configure the general MSTP parameters .The configuration of the parameters
apply for the whole bridge.
The port, instance and port-instance specific MSTP parameters are in subsequent chapters.
The bridge max-age value should be less than or equal to (2 * ((forward-delay/100)-1) and should be greater than
or equal to (2 * ((Port hello-time/100) + 1)).
The bridge hello-time is only applicable when the version is stp/rstp, in case of version mstp the port hello-time is
used.
User Level
The command can be accessed by operators with mstp privileges, and executed by operators with mstp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 47.2-2 "MSTP general configuration Command" Command Parameters
Parameter Type Description
[no] enable-stp Parameter type: boolean optional parameter
all stp protocol operations start
[no] priority Parameter type: <Mstp::StpPriority> optional parameter with default
Format: value: 32768
- stp bridge priority(n*4096) stp bridge priority(n*4096)
- range: [0...61440]
[no] max-instance-num Parameter type: <Mstp::StpMaxInstanceNumberShub> optional parameter with default
Format: value: 17
- the max spanning trees number the maximun number of spanning
- range: [1...17] trees to be allowed
[no] max-age Parameter type: <Mstp::StpMaxAge> optional parameter with default
Format: value: 2000
- stp bridge priority(n*100) stp max-age for
- unit: 10msec root-bridge(n*100)
- range: [600...4000]
Command Description
This command allows the operator to configure the MSTP parameters for a specific MSTP instance.
User Level
The command can be accessed by operators with mstp privileges, and executed by operators with mstp privileges.
Command Syntax
The command has the following syntax:
> configure xstp ( no instance (instance) ) | ( instance (instance) [ no priority | priority <Mstp::StpPriority> ] )
Command Parameters
Table 47.3-1 "MSTP Instance configuration Command" Resource Parameters
Resource Identifier Type Description
(instance) Format: MSTP instance
- MSTP Instance
- range: [1...64]
Table 47.3-2 "MSTP Instance configuration Command" Command Parameters
Parameter Type Description
[no] priority Parameter type: <Mstp::StpPriority> optional parameter with default
Format: value: 32768
- stp bridge priority(n*4096) the Bridge Priority(n*4096)
- range: [0...61440]
Command Description
This command allows the operator to map/unmap VLANs to a specific MSTP instance.The VLAN can be associated
with the MSTP instance without being configured first. One or more VLANs can be associated to an instance, but
one VLAN can not be assigned to different instances.
User Level
The command can be accessed by operators with mstp privileges, and executed by operators with mstp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 47.4-1 "MSTP Vlan-Instance Mapping configuration Command" Resource Parameters
Resource Identifier Type Description
(instance) Format: MSTP instance
- MSTP Instance
- range: [1...64]
(vlan) Format: vlan id to be associated with the
( <Vlan::UVlanIndex> mstp instance
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Command Description
This command allows the operator to configure the port parameters for the Common Instance.
By default mstp is disabled on the ports.
User Level
The command can be accessed by operators with mstp privileges, and executed by operators with mstp privileges.
Command Syntax
The command has the following syntax:
> configure xstp port (port) [ no priority | priority <Mstp::MstpPortPriority> ] [ [ no ] enable-stp ] [ path-cost
<Mstp::MstpPathCost> ] [ [ no ] edge-port ] [ no admin-p2p | admin-p2p <Mstp::MstpAdminP2PPort> ] [ no
hello-time | hello-time <Mstp::StpHelloTime> ]
Command Parameters
Table 47.5-1 "MSTP Port configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: Interface index of the lag
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 47.5-2 "MSTP Port configuration Command" Command Parameters
Parameter Type Description
[no] priority Parameter type: <Mstp::MstpPortPriority> optional parameter with default
Format: value: 128
- mstp port priority(n*16) mstp port priority(n*16)
- range: [0...240]
[no] enable-stp Parameter type: boolean optional parameter
current Msti port state enabled
path-cost Parameter type: <Mstp::MstpPathCost> optional parameter
Format: port path cost
- port path cost
- range: [1...200000000]
[no] edge-port Parameter type: boolean optional parameter
Command Description
This command allows the operator to configure the MSTP parameters for a specific port-instance configuration. In
order to be able to configure the port-instance parameters, the port must be member of the vlan-port map.This
configuration applies to the Mstp.
User Level
The command can be accessed by operators with mstp privileges, and executed by operators with mstp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 47.6-1 "MSTP Port-Instance configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: interface index of the lag
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
instance Parameter type: <Mstp::MstpInstance> mstp instance
Format:
- MSTP Instance
- range: [1...64]
Table 47.6-2 "MSTP Port-Instance configuration Command" Command Parameters
Parameter Type Description
[no] priority Parameter type: <Mstp::MstpPortPriority> optional parameter with default
Format: value: 128
- mstp port priority(n*16) mstp port priority(n*16)
- range: [0...240]
[no] enable-stp Parameter type: boolean optional parameter
current Msti port state enabled
path-cost Parameter type: <Mstp::MstpPathCost> optional parameter
Format: port path cost
Description
This chapter gives an overview of nodes that are handled by "Distributed Router Configuration Commands".
Command Tree
----configure
----dist-router
----[no] interface
- (lt-vlan)
- [no] addrtype
- ip-address
- [no] mpls
----mpls
----[no] interface
- (index)
- label-map
----[no] static-lsp
- (lsp-name)
- interface
- push
- [no] nexthopaddrtype
- nexthop
----[no] sdp
- (sdp-id)
- lsp-name
Command Description
This command allows the operator to configure a distributed router IP interface on a linecard and assign an IP
address.
User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.2-1 "Drouter IP Configuration Command" Resource Parameters
Resource Identifier Type Description
(lt-vlan) Format: lt-vlan index
( slot-vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> : <Eqpt::UnstackedVlan>
| slot-stacked : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- slot-vlan : slot unstacked (supported vlan [1...4093])
- slot-stacked : slot stacked (supported cvlan [0...4093])
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Table 48.2-2 "Drouter IP Configuration Command" Command Parameters
Parameter Type Description
[no] addrtype Parameter type: <Drouter::IpAddressType> optional parameter with default
Format: value: "ipv4"
( ipv4 specify the type of IP address
Command Description
This command allows the operator to configure an inbound MPLS LSP, include the MPLS label of an incoming
MPLS tunnel.
User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.
Command Syntax
The command has the following syntax:
> configure dist-router mpls ( no interface (index) label-map <Drouter::InSegLabel> ) | ( interface (index)
label-map <Drouter::InSegLabel> )
Command Parameters
Table 48.3-1 "Inbound MPLS LSP Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: MPLS enabled ip interface index
( slot-vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> : <Eqpt::UnstackedVlan>
| slot-stacked : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- slot-vlan : slot unstacked
- slot-stacked : slot stacked
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
label-map Parameter type: <Drouter::InSegLabel> Specify incoming MPLS label
Format:
- MPLS Insegment label
- range: [32...1023]
Command Description
This command allows the operator to configure a static outbound MPLS LSP, include the MPLS label and nexthop
of an outgoing MPLS tunnel.
User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.
Command Syntax
The command has the following syntax:
> configure dist-router mpls ( no static-lsp (lsp-name) ) | ( static-lsp (lsp-name) interface <Drouter::IfIndex> push
<Drouter::OutLabel> [ no nexthopaddrtype | nexthopaddrtype <Drouter::IpAddressType> ] nexthop
<Ip::V4AddressHex> )
Command Parameters
Table 48.4-1 "Static Outbound MPLS LSP Configuration Command" Resource Parameters
Resource Identifier Type Description
(lsp-name) Format: Administrative name for the LSP
- LSP name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 48.4-2 "Static Outbound MPLS LSP Configuration Command" Command Parameters
Parameter Type Description
interface Parameter type: <Drouter::IfIndex> mandatory parameter
Format: specify the outgoing interface
( slot-vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> : <Eqpt::UnstackedVlan>
| slot-stacked : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- slot-vlan : slot unstacked
- slot-stacked : slot stacked
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Command Description
This command allows the operator to configure an SDP(typically corresponding to an MPLS tunnel).
User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.5-1 "SDP Configuration Command" Resource Parameters
Resource Identifier Type Description
(sdp-id) Format: SDP Identifier
- SDP ID
- range: [1...17407]
Table 48.5-2 "SDP Configuration Command" Command Parameters
Parameter Type Description
lsp-name Parameter type: <Drouter::MplsLspName> mandatory parameter
Format: LSP name to set the LSP list
- LSP name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Description
This chapter gives an overview of nodes that are handled by "Distributed Service Configuration Commands".
Command Tree
----configure
----[no] dist-service
- (service-id)
- [no] service-type
- [no] qos-profile
----[no] sdp
- (spoke-sdp-id)
- egress-vc-label
- ingress-vc-label
----apipe-sdp
- (spoke-sdpid)
- [no] max-cells
- [no] max-delay
----[no] apipe-pvc
- (atm-pvc)
- in-mapped-vpi
- in-mapped-vci
- out-mapped-vpi
- out-mapped-vci
Command Description
This command allows the operator to configure a distributed service.
User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 49.2-1 "Distributed Service Configuration Command" Resource Parameters
Resource Identifier Type Description
(service-id) Format: Service Identifier
- Service ID
- range: [1...2147483647]
Table 49.2-2 "Distributed Service Configuration Command" Command Parameters
Parameter Type Description
[no] service-type Parameter type: <Drouter::ServiceType> optional parameter with default
Format: value: "apipe"
( unknown Service type to be configured
| epipe
| p3pipe
| tls
| vprn
| ies
| mirror
| apipe
| fpipe
| ipipe
| cpipe )
Possible values:
- unknown : unknown
- epipe : epipe
- p3pipe : p3pipe
- tls : tls
- vprn : vprn
- ies : ies
- mirror : mirror
Command Description
This command allows the operator to associate an SDP(typically corresponding to an MPLS tunnel) to a service.
User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 49.3-1 "SDP Binding Configuration Command" Resource Parameters
Resource Identifier Type Description
(service-id) Format: Service Identifier
- Service ID
- range: [1...2147483647]
(spoke-sdp-id) Format: SDP Identifier
id : <Drouter::SdpId>
Possible values:
- id : SDP ID
Field type <Drouter::SdpId>
- SDP ID
- range: [1...17407]
Table 49.3-2 "SDP Binding Configuration Command" Command Parameters
Parameter Type Description
egress-vc-label Parameter type: <Drouter::EgressLabel> mandatory parameter
Format: MPLS label used by this device
- MPLS Egress label to send packets out
- range: [1...1048575]
ingress-vc-label Parameter type: <Drouter::IngressLabel> mandatory parameter
Format: MPLS label used by the far-end
- MPLS ingress label device
- range: [2048...18431]
Command Description
This command allows the operator to configure the particular association between an SDP(typically corresponding
to an MPLS tunnel) and an APIPE service, including the specific handling of upstream cell concatenation. It is
used to configure an ATM Pseudowire on a linecard.
User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 49.4-1 "APIPE SDP Binding Configuration Command" Resource Parameters
Resource Identifier Type Description
(service-id) Format: Service Identifier
- Service ID
- range: [1...2147483647]
(spoke-sdpid) Format: SDP Identifier
id : <Drouter::SdpId>
Possible values:
- id : SDP ID
Field type <Drouter::SdpId>
- SDP ID
- range: [1...17407]
Table 49.4-2 "APIPE SDP Binding Configuration Command" Command Parameters
Parameter Type Description
[no] max-cells Parameter type: <Drouter::MaxCells> optional parameter with default
Format: value: 1
- Maximum number of ATM cells to accumulate into a Maximum number of ATM cells
MPLS packet to accumulate into a MPLS
- range: [1...8] packet
[no] max-delay Parameter type: <Drouter::MaxDelay> optional parameter with default
Format: value: 4
- Maximum amount of time to wait while performing ATM Maximum amount of time to wait
cell concatenation into an MPLS packet while performing ATM cell
- unit: msec concatenation into an MPLS
- range: [1...10] packet
Command Description
This command allows the operator to configure an ATM cross-connect between an ATM PVC on the DSL line and
the ATM VPI/VCI value used in an ATM Pseudowire.
User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 49.5-1 "VCL Binding Configuration Command" Resource Parameters
Resource Identifier Type Description
(service-id) Format: Service Identifier
- Service ID
- range: [1...2147483647]
(atm-pvc) Format: atm pvc index
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Table 49.5-2 "VCL Binding Configuration Command" Command Parameters
Parameter Type Description
in-mapped-vpi Parameter type: <Drouter::InMappedVpi> mandatory parameter
Format: atm inmapped vpi value for the
Description
This chapter gives an overview of nodes that are handled by "CLI Alias Configuration Command".
Command Tree
----configure
----[no] alias
- (name)
- (value)
Command Description
This command allows the operator to configure CLI alias commands for the system.
The order of the displayed alias commands when executing the 'info configure alias' command does not persist
after an NT switchover or reset.
User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.2-1 "CLI Alias Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: alias name
- alias name for the command
- range: [a-z0-9]
- length: 2<=x<=8
Table 50.2-2 "CLI Alias Configuration Command" Command Parameters
Parameter Type Description
(value) Format: mandatory parameter
- command string for alias command string for alias
- length: 2<=x<=128
Description
This chapter gives an overview of nodes that are handled by "Equipment Status Commands".
Command Tree
----show
----equipment
----slot
- (slot)
----capab-profile
- (profilename)
----applique
- (applique)
----shelf-summary
- (shelf)
----protection-element
- (slot-id)
----protection-group
- (prot-group-id)
----external-link-host
- (faceplate-number)
----external-link-remote
- (exp-slot)
----diagnostics
----sfp
- (position)
----sfp-threshold
- (position)
----rssiprof
- (index)
----temperature
- (slot)
- sensor-id
----planned-resource
- (slot)
- resource-id
----transceiver-inventory
- (index)
----isam
----rack
- (rack)
----shelf
- (shelf)
Command Description
This commands shows the slot status. The following information is shown for each slot:
• type : describes the type of the unit that is currently present in the slot.
• capab-profile: capabilty profile assigned to the slot, applicable for line boards, NTIOs and mini-NT NRNT-A.
• oper-status: describes whether the unit is able to perform its normal operation.
• error-status: provides the reason why the board is not operational. These values correspond to the alarms
generated in case of a failure.
• available-status: provides further information regarding the state of the unit.
• manufacturer: provides an identification of the unit manufacturer.
• inventory-pba: provides the Alcatel-Lucent Printed Board Assembly code of the unit.
• inventory-fpba: provides the Alcatel-Lucent Printed Board Assembly code of the unit which also identifies the
boot software.
• inventory-ics: provides the Item Change Status iteration code of the unit.
• inventory-clei: provides the (USA) Common Language Equipment Identification code of the unit.
• serial-no: provides the serial number of the board.
• failed-test: provides identification of the last failing test using four numbers, from MSB to LSB:
- - table number (1 byte)
- - segment number (1 byte)
- - case number (1 byte)
- - check number (1 byte)
As long as there has been no failing self test, the value of this attribute will be 0.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.2-1 "Slot Status Command" Resource Parameters
Resource Identifier Type Description
(slot) Format: the physical slot position
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
Command Output
Table 51.2-2 "Slot Status Command" Display parameters
Specific Information
name Type Description
planned-type Parameter type: <Equipm::BrdType> A string representing the board
Data driven field type that is planned in the slot.
Possible values are depending on the actual configuration This element is only shown in
and software. detail mode.
The currently allowed values can be shown with online-help.
actual-type Parameter type: <Equipm::ActBoardType> A string representing the board
Data driven field type that is actually present in the slot.
Possible values are depending on the actual configuration This element is always shown.
and software.
The currently allowed values can be shown with online-help.
oper-status Parameter type: <Equipm::OperStatus> Specifies whether the plug-in unit
short name: enabled ( ( enabled | yes ) is able to perform its normal
| ( disabled | no ) ) operation.
Possible values: This element is always shown.
- enabled :
- yes :
- disabled :
- no :
error-status Parameter type: <Equipm::OperError> Specifies for what reason the
( no-error board is not operational. These
| type-mismatch values correspond with the
| board-missing alarms which are generated in
| no-installation case of a failure.
| no-planned-board This element is always shown.
| waiting-for-sw
| init-boot-failed
| init-download-failed
| init-connection-failed
| configuration-failed
| board-reset-protection
| invalid-parameter
| temperature-alarm
Command Description
This commands displays the information related to a profile. The following information is shown for each profile:
• profile-id : displays the profile-id associated with a profile name
• description :displays the description of the profile.
• board-type: displays the board type associated with a given profile
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.3-1 "Profile Description Command" Resource Parameters
Resource Identifier Type Description
(profilename) Format: the profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Command Output
Table 51.3-2 "Profile Description Command" Display parameters
Specific Information
name Type Description
profile-id Parameter type: <AsamProfilePointer> The profile id of the
- a pointer to a profile or profile index corresponding profile name.
- range: [0...65535] This element is always shown.
description Parameter type: <PrintableString> Description of the profile
- printable string This element is always shown.
board-type Parameter type: <Equipm::Profile> Description of the profile
Data driven field type This element is always shown.
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Command Description
This command shows the applique status. The following information is shown for each applique slot:
• type: provides the type of the applique that is currently present in the slot.
• oper-status: describes whether the applique is able to perform its normal operation.
• error-status: describes the reason why the applique is not operational. These values correspond to the alarms
generated in case of a failure.
• available-status: provides further information regarding the state of the applique.
• manufacturer: provides an identification of the applique manufacturer.
• inventory-pba: provides the Alcatel-Lucent Printed Board Assembly code of the applique.
• inventory-fpba: provides the Alcatel-Lucent Printed Board Assembly code of the applique which also identifies
the boot software.
• inventory-ics: provides the Item Change Status iteration code of the qpplique.
• inventory-clei: provides the (USA) Common Language Equipment Identification code of the applique.
• serial-no: provides the serial number of the applique.
• failed-test: provides the identification of the last failing test using four numbers, from MSB to LSB:
- - table number (1 byte)
- - segment number (1 byte)
- - case number (1 byte)
- - check number (1 byte)
As long as there has been no failing self test, the value of this attribute will be 0.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.4-1 "Applique Status Command" Resource Parameters
Resource Identifier Type Description
(applique) Format: the physical applique position
( iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::AppliqueSlotId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
- iont : an nt applique slot
Command Output
Table 51.4-2 "Applique Status Command" Display parameters
Specific Information
name Type Description
planned-type Parameter type: <Equipm::AppliqueType> A string representing the board
Data driven field type that is planned in the slot.
Possible values are depending on the actual configuration This element is only shown in
and software. detail mode.
The currently allowed values can be shown with online-help.
actual-type Parameter type: <Equipm::AppliqueType> A string representing the board
Data driven field type that is actually present in the slot.
Possible values are depending on the actual configuration This element is always shown.
and software.
The currently allowed values can be shown with online-help.
oper-status Parameter type: <Equipm::OperStatus> Specifies whether the plug-in unit
short name: enabled ( ( enabled | yes ) is able to perform its normal
| ( disabled | no ) ) operation.
Possible values: This element is always shown.
- enabled :
- yes :
- disabled :
- no :
error-status Parameter type: <Equipm::OperError> Specifies for what reason the
( no-error board is not operational. These
| type-mismatch values correspond with the
| board-missing alarms which are generated in
| no-installation case of a failure.
| no-planned-board This element is always shown.
| waiting-for-sw
| init-boot-failed
| init-download-failed
| init-connection-failed
| configuration-failed
| board-reset-protection
| invalid-parameter
| temperature-alarm
| tempshutdown
| defense
| board-not-licensed
| sem-power-fail
| sem-ups-fail
| incompatible-slot
| download-ongoing
Command Description
This commands shows a summary of the slots in a shelf.
The least significant bit of the first byte shown corresponds to the slot position 1.
User Level
none
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.5-1 "Shelf Summary Status Command" Resource Parameters
Resource Identifier Type Description
(shelf) Format: the physical shelf position
<Eqpt::RackId> / <Eqpt::ShelfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Command Output
Table 51.5-2 "Shelf Summary Status Command" Display parameters
Specific Information
name Type Description
changes Parameter type: <Counter> Number of configuration or status
- 32 bit counter changes for slots/boards within
this shelf.
This element is always shown.
occupied-slots Parameter type: <Equipm::Octet-8> Specifies the occupation of slots.
- a binary string This element is only shown in
- length: 8 detail mode.
admin-unlocked Parameter type: <Equipm::Octet-8> Specifies the administrative state
- a binary string of the boards whether it is locked
- length: 8 or not.
This element is only shown in
detail mode.
oper-unlocked Parameter type: <Equipm::Octet-8> Specifies the operational state of
- a binary string the boards whether it is locked or
Command Description
This command shows the protected element-related parameter of the equipment.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.6-1 "Protection Element Status Command" Resource Parameters
Resource Identifier Type Description
(slot-id) Format: Index in eqpt Prot Element Table
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Command Output
Table 51.6-2 "Protection Element Status Command" Display parameters
Specific Information
name Type Description
standby-status Parameter type: <Equipm::ProtElementStandbyStatus> The standby status of the
( providing-service protection group element.
| hot-standby This element is always shown.
| cold-standby
| idle )
Command Description
This command shows the parameters related to protection groups.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.7-1 "Protection Group Status Command" Resource Parameters
Resource Identifier Type Description
(prot-group-id) Format: Index in eqpt Prot Group Table
- a signed integer
Command Output
Table 51.7-2 "Protection Group Status Command" Display parameters
Specific Information
name Type Description
admin-status Parameter type: <Equipm::PortGroupAdminStatus> distinguishes the
( unlock administration-status
| lock ) This element is always shown.
Possible values:
- unlock : unlock
- lock : lock
service-status Parameter type: <Equipm::ServiceStatus> indicate the service status of
( in-service protection group, a protection
| not-in-service ) group and its elements are not
Possible values: configurable when it is out of
- in-service : the protection group is in service service
- not-in-service : the protection group is not in service This element is always shown.
eps-quenchfactor Parameter type: <Equipm::TimeTicks> timervalue of quenching
- timer value for quench mechanish mechanism, 0 is valid value
- unit: 1/100 sec This element is only shown in
detail mode.
prot-group-type Parameter type: <Equipm::PortGroupType> distinguishes between 1+1 and
( one-plus-one 1:N protection groups
| one-for-n ) This element is always shown.
Command Description
This command allows the operator to show the host shelf's external-links status. The following information is
shown for each external-link:
• The SHub/IHub port which the host external link is connected to
• The downlink status
• The slot id of the expansion shelf that is cabled to the host expansion board.
• The output "none" for the display parameter "exp-slot" means the sfp is not connected to any rack/shelf/slot.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.8-1 "External-link-host Status Commands" Resource Parameters
Resource Identifier Type Description
(faceplate-number) Format: the external-link faceplate
( <Eqpt::ExtLinkFaceplateNumber> number
| nt : sfp : <Eqpt::ShowExtLinkHostPortIndex>
| nt : xfp : <Eqpt::ShowExtLinkHostPortIndex>
| ntio-1 : sfp : <Eqpt::ShowExtLinkHostPortIndex>
| ntio-1 : xfp : <Eqpt::ShowExtLinkHostPortIndex>
| ntio-2 : sfp : <Eqpt::ShowExtLinkHostPortIndex>
| ntio-2 : xfp : <Eqpt::ShowExtLinkHostPortIndex> )
Possible values:
- nt : nt-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Possible values:
- sfp : SFP port
- xfp : XFP port
Field type <Eqpt::ShowExtLinkHostPortIndex>
- the external link faceplate number
Field type <Eqpt::ExtLinkFaceplateNumber>
- the external link faceplate number
Command Output
Table 51.8-2 "External-link-host Status Commands" Display parameters
Specific Information
name Type Description
shub-port Parameter type: <Equipm::lanxPortNumber> the shub port which the host
- a signed integer external link is connected to
This element is always shown.
downlink-status Parameter type: <Equipm::HostSfpDownlinkStatus> the host expansion card's external
( ok downlink status
| sfp-not-present This element is always shown.
| los
| tx-fail
| invalid-alcatel-id
| unknown
| sfp-control-fail
| uplink
| tx-fail-and-los )
Possible values:
- ok : the downlink is operational
- sfp-not-present : no sfp present for the downlink
- los : los is detected by the host for the downlink
- tx-fail : the downlink tx failed
- invalid-alcatel-id : the downlink sfp plugged does not have
a valid alcatel (-Lucent) id
- unknown : the host expansion card is planned but not
inserted
- sfp-control-fail : sfp not responding or i2c failure
- uplink : the sfp is configured as uplink
- tx-fail-and-los : the downlink tx failed and los detected by
the host for the downlink
exp-slot Parameter type: <Equipm::ExpansionSlotIndex> the slot id of the expansion shelf
<Eqpt::ExpRack> / <Eqpt::ExpShelf> / <Eqpt::ExpSlot> that is cabled to the host
Field type <Eqpt::ExpRack> expansion board
- the physical number of the expansion rack, 0 stands for no This element is always shown.
remote
Field type <Eqpt::ExpShelf>
- physical nbr of expansion shelf within expansion rack, 0
stands for no remote
Field type <Eqpt::ExpSlot>
- the physical number of the slot within expansion shelf, 0
stands for no remote
host-sfp-type Parameter type: <Equipm::SfpType> the host shelf sfp type
( unknown This element is only shown in
| 1000base-sx detail mode.
| 1000base-lx
| 1000base-cx
| 1000base-t
| 100base-lx/lx10
| 100base-fx
| base-bx10
| base-px
| reserved
| 10gbase-ew
| 10gbase-lw
| 10gbase-sw
| 10gbase-lrm
| 10gbase-er
| 10gbase-lr
| 10gbase-sr
| 10gbase-sr-sw
Command Description
This command allows the operator to show the remote shelves external-links status. The following information is
shown for each external-link:
• The slot id of the expansion shelf
• The link status
• The faceplate number of the host external-link device in which the expansion shelf's external-link device is
cabled to
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.9-1 "External-link-remote Status Commands" Resource Parameters
Resource Identifier Type Description
(exp-slot) Format: the physical expansion slot
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::ExpSlotId> position
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::ExpSlotId>
- the expansion slot number
Command Output
Table 51.9-2 "External-link-remote Status Commands" Display parameters
Specific Information
name Type Description
sfp-status Parameter type: <Equipm::ExpSfpStatus> the status of the expansion shelf
( ok sfp
| sfp-not-present This element is always shown.
| los
| tx-fail
| invalid-alcatel-id
| unknown
| sfp-control-fail
Command Description
This command allows the operator to read real-time diagnostic measurements from the A2 bank of a specified SFP
or lower data bank of XFP. The following information is shown for each specified sfp/xfp:
• The slot index of the sfp
• The number of the sfp cage
• The diagnostics availability: For XFP, AO denotes the upper bank and A2 denotes the lower bank.
• The Loss of Signal status
• The Transmit Fault status
• The transmit power (tx-power): This parameter displays the transmit power of the SFP/XFP.It is a string that
can be one of the following possible values:
- A string containing power value ranging from "-40.00 dBm" to "8.16 dBm", in 0.01 dBm increments.
- "No Power" - When no optical power is being transmitted by an sfp.
- "NotApplicable" - This is used for an electrical SFP.
- "NotAvailable" - The measurement could not be obtained.
- "Invalid" - The calibration calculation returned an invalid result.
• The received power (rx-power): This parameter displays the received power of the SFP/XFP(not applicable for
pon ports). It is a string that can be one of the following possible values:
- A string containing power value ranging from "-40.00 dBm" to "8.16 dBm", in 0.01 dBm increments.
- "No Power" - When no optical power is being received by an sfp.
- "NotApplicable" - This is used for an electrical SFP.
- "NotAvailable" - The measurement could not be obtained.
- "Invalid" - The calibration calculation returned an invalid result.
• The transmit bias current (tx-bias-current) : This parameter displays the transmit bias current of the SFP/XFP.
It is a string that can be one of the following possible values:
- A string containing a current value ranging from "0.00 mA" to "262.00 mA", in 0.01 mA increments.
- "NotApplicable" - This is used for an electrical SFP.
- "NotAvailable" - The measurement could not be obtained.
- "Invalid" - The calibration calculation returned an invalid result.
• The transceiver supply voltage (supply-voltage) : This parameter displays the transceiver supply voltage of the
SFP/XFP. It is a string that can be one of the following possible values:
- A string containing a voltage value ranging from "0.00 VDC" to "6.55 VDC", in 0.01 VDC increments.
- "NotAvailable" - The measurement could not be obtained.
- "Invalid" - The calibration calculation returned an invalid result.
• The temperature : This parameter displays the temperature of the SFP/XFP. It is a string that can be one of the
following possible values:
- A string containing a temperature value ranging from "-128.00 degrees Celsius" to "128.00 degrees
Celsius" in 0.01 degrees Celsius increments.
- "NotAvailable" - The measurement could not be obtained.
• temperature-tca : This parameter displays the freshly-measured temperature alarm/warning threshold crossing
status of the specified SFP/SFP+/XFP. It is a string that can be one of the following possible values:
- "not-available" - the measurement could not be obtained
- "normal-value" - No threshold crossing, present value is within the threshold
- "low-warning-th" - Present value is greater than the low warning level threshold
- "low-alarm-th" - Present value is greater than the low alarm level threshold
- "high-warning-th" - Present value is greater than the high warning level threshold
- "high-alarm-th" - Present value is greater than the high alarm level threshold
• voltage-tca : This parameter displays the freshly-measured voltage alarm/warning threshold crossing status of
the specified SFP/SFP+/XFP. It is a string that can be one of the following possible values:
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.10-1 "SFP/XFP Diagnostics Status Command" Resource Parameters
Resource Identifier Type Description
(position) Format: the physical sfp or xfp cage
( acu : <Eqpt::RackId> / <Eqpt::ShelfId> / position
<Eqpt::SfpCageNumber>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SfpCageNumber>
Command Output
Table 51.10-2 "SFP/XFP Diagnostics Status Command" Display parameters
Specific Information
name Type Description
diag-avail-status Parameter type: <Eqpt::SfpDiagAvailable> sfp/xfp diagnostics availability
( no-error status. for xfp, a0 denotes the
| cage-no-diag-supp upper bank and a2 denotes the
| cage-empty lower bank
| cage-no-a2-supp This element is always shown.
| a0-read-failed
| a0-checksum-failed
| sfp-no-a2-supp
| a2-read-failed
| a2-checksum-failed )
Possible values:
- no-error : sfp diag is available
- cage-no-diag-supp : cage does not support diag
- cage-empty : cage is empty
- cage-no-a2-supp : cage does not support A2
- a0-read-failed : A0 read failed
- a0-checksum-failed : A0 checksum failed
- sfp-no-a2-supp : SFP does not support A2
- a2-read-failed : A2 read failed
- a2-checksum-failed : A2 checksum failed
los Parameter type: <Eqpt::SfpDiagLos> loss of signal
( los This element is always shown.
| no-los
| not-available )
Possible values:
- los : loss of signal info
- no-los : no los
- not-available : not available
tx-fault Parameter type: <Eqpt::SfpDiagTxFault> sfp/xfp tx fault
( tx-fault This element is always shown.
| no-tx-fault
| not-applicable
| not-available )
Possible values:
- tx-fault : transmit fault info
- no-tx-fault : no tx fault
- not-applicable : not applicable
- not-available : not available
tx-power Parameter type: <PrintableString> the transmit power.
- printable string This element is only shown in
detail mode.
rx-power Parameter type: <PrintableString> the received power - not
- printable string applicable for PON ports
This element is only shown in
detail mode.
tx-bias-current Parameter type: <PrintableString> the transmit bias current.
- printable string This element is only shown in
Command Description
This command allows the operator to read real-time diagnostic measurements from the A2 bank of a specified SFP
or lower data bank of XFP. The following information is shown for each specified sfp/xfp:
• The slot index of the sfp
• The number of the sfp cage
• The diagnostics availability: For XFP, AO denotes the upper bank and A2 denotes the lower bank.
• The Loss of Signal status
• The Transmit Fault status
• The transmit power (tx-power): This parameter displays the transmit power of the SFP/XFP.It is a string that
can be one of the following possible values:
- A string containing power value ranging from "-40.00 dBm" to "8.16 dBm", in 0.01 dBm increments.
- "No Power" - When no optical power is being transmitted by an sfp.
- "NotApplicable" - This is used for an electrical SFP.
- "NotAvailable" - The measurement could not be obtained.
- "Invalid" - The calibration calculation returned an invalid result.
• The received power (rx-power): This parameter displays the received power of the SFP/XFP(not applicable for
pon ports). It is a string that can be one of the following possible values:
- A string containing power value ranging from "-40.00 dBm" to "8.16 dBm", in 0.01 dBm increments.
- "No Power" - When no optical power is being received by an sfp.
- "NotApplicable" - This is used for an electrical SFP.
- "NotAvailable" - The measurement could not be obtained.
- "Invalid" - The calibration calculation returned an invalid result.
• The transmit bias current (tx-bias-current) : This parameter displays the transmit bias current of the SFP/XFP.
It is a string that can be one of the following possible values:
- A string containing a current value ranging from "0.00 mA" to "262.00 mA", in 0.01 mA increments.
- "NotApplicable" - This is used for an electrical SFP.
- "NotAvailable" - The measurement could not be obtained.
- "Invalid" - The calibration calculation returned an invalid result.
• The transceiver supply voltage (supply-voltage) : This parameter displays the transceiver supply voltage of the
SFP/XFP. It is a string that can be one of the following possible values:
- A string containing a voltage value ranging from "0.00 VDC" to "6.55 VDC", in 0.01 VDC increments.
- "NotAvailable" - The measurement could not be obtained.
- "Invalid" - The calibration calculation returned an invalid result.
• The temperature : This parameter displays the temperature of the SFP/XFP. It is a string that can be one of the
following possible values:
- A string containing a temperature value ranging from "-128.00 degrees Celsius" to "128.00 degrees
Celsius" in 0.01 degrees Celsius increments.
- "NotAvailable" - The measurement could not be obtained.
• temperature-tca : This parameter displays the freshly-measured temperature alarm/warning threshold crossing
status of the specified SFP/SFP+/XFP. It is a string that can be one of the following possible values:
- "not-available" - the measurement could not be obtained
- "normal-value" - No threshold crossing, present value is within the threshold
- "low-warning-th" - Present value is greater than the low warning level threshold
- "low-alarm-th" - Present value is greater than the low alarm level threshold
- "high-warning-th" - Present value is greater than the high warning level threshold
- "high-alarm-th" - Present value is greater than the high alarm level threshold
• voltage-tca : This parameter displays the freshly-measured voltage alarm/warning threshold crossing status of
the specified SFP/SFP+/XFP. It is a string that can be one of the following possible values:
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.11-1 "SFP/XFP Diagnostics Status Command" Resource Parameters
Resource Identifier Type Description
(position) Format: the physical sfp or xfp cage
( acu : <Eqpt::RackId> / <Eqpt::ShelfId> / position
<Eqpt::SfpCageNumber>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SfpCageNumber>
Command Output
Table 51.11-2 "SFP/XFP Diagnostics Status Command" Display parameters
Specific Information
name Type Description
rx-pwr-alm-low Parameter type: <PrintableString> alarm low threshold for Rx power
- printable string This element is always shown.
rx-pwr-alm-high Parameter type: <PrintableString> alarm high threshold for Rx
- printable string power
This element is always shown.
rx-pwr-warn-low Parameter type: <PrintableString> warn low threshold for Rx power
- printable string This element is only shown in
detail mode.
rx-pwr-warn-high Parameter type: <PrintableString> warn high threshold for Rx power
- printable string This element is only shown in
detail mode.
tx-pwr-alm-low Parameter type: <PrintableString> alarm low threshold for Tx power
- printable string This element is always shown.
tx-pwr-alm-high Parameter type: <PrintableString> alarm high threshold for Tx
- printable string power
This element is always shown.
tx-pwr-warn-low Parameter type: <PrintableString> warn low threshold for Tx power
- printable string This element is only shown in
detail mode.
tx-pwr-warn-high Parameter type: <PrintableString> warn high threshold for Tx power
- printable string This element is only shown in
detail mode.
temp-alm-low Parameter type: <PrintableString> alarm low threshold for
- printable string temperature
This element is only shown in
detail mode.
temp-alm-high Parameter type: <PrintableString> alarm high threshold for
- printable string temperature
This element is only shown in
detail mode.
temp-warn-low Parameter type: <PrintableString> warn low threshold for
- printable string temperature
This element is only shown in
detail mode.
temp-warn-high Parameter type: <PrintableString> warn high threshold for
- printable string temperature
This element is only shown in
detail mode.
bias-alm-low Parameter type: <PrintableString> alarm low threshold for bias
- printable string This element is only shown in
detail mode.
bias-alm-high Parameter type: <PrintableString> alarm high threshold for bias
- printable string This element is only shown in
detail mode.
bias-warn-low Parameter type: <PrintableString> warn low threshold for bias
- printable string This element is only shown in
Command Description
This command allows the operator to create and configure the RSSI parameters on SFPs.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.12-1 "Sfp RSSI Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: an unique index of the rssi profile
- an unique index value for the rssi
profile(1-200:userdefined,65535:automode)
- range: [1...200,65535]
Command Output
Table 51.12-2 "Sfp RSSI Configuration Command" Display parameters
Specific Information
name Type Description
name Parameter type: <Eqpt::DisplayString> A unique profile name
- string to identify the rssi profile This element is always shown.
- length: 1<=x<=16
ref-count Parameter type: <Eqpt::rssiRefCount> rssi profile reference count
- number of entities using this particular profile This element is always shown.
- range: [0...65535]
Command Description
This commands shows the board temperature status. The following information is shown for each thermal sensor:
• act-temp : actual temperature of thermal sensor; expressed in degrees Celsius.
• tca-low: low thresholds for the alarm "Temperature Exceeded"; expressed in degrees Celsius.
• tca-high: high thresholds for the alarm "Temperature Exceeded"; expressed in degrees Celsius.
• shut-low: low threshold for the alarm "Temperature Shutdown"; expressed in degrees Celsius.
• shut-high: high threshold for the alarm "Temperature Shutdown"; expressed in degrees Celsius.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.13-1 "Board Temperature Status Command" Resource Parameters
Resource Identifier Type Description
(slot) Format: the physical slot position
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| ntio-1
| ntio-2 )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- iont : an nt applique slot
- ctrl : ctrl-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
Command Output
Table 51.13-2 "Board Temperature Status Command" Display parameters
Specific Information
name Type Description
actual-temperature Parameter type: <SignedInteger> actual temperature of thermal
short name: act-temp - a signed integer sensor; expressed in degrees
Celsius.
This element is always shown.
tca-threshold-low Parameter type: <SignedInteger> Low thresholds for the alarm
short name: tca-low - a signed integer "Temperature Exceeded";
expressed in degrees Celsius.
This element is always shown.
tca-threshold-high Parameter type: <SignedInteger> High thresholds for the alarm
short name: tca-high - a signed integer "Temperature Exceeded";
expressed in degrees Celsius.
This element is always shown.
shut-threshold-low Parameter type: <SignedInteger> Low threshold for the alarm
short name: shut-low - a signed integer "Temperature Shutdown";
expressed in degrees Celsius.
This element is always shown.
shut-threshold-high Parameter type: <SignedInteger> High threshold for the alarm
short name: shut-high - a signed integer "Temperature Shutdown";
expressed in degrees Celsius.
This element is always shown.
Command Description
This commands shows the actual values of configured hardware resources on boards.. The following information is
shown for each resource:
• current: The actual planned value for the resource
• max-value: The maximum value that the board supports for this resource.
• description: A string describing the planned resource for this board.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.14-1 "Board Planned Resource Command" Resource Parameters
Resource Identifier Type Description
(slot) Format: the physical slot position
lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
resource-id Parameter type: <SignedInteger> the planned resource id of a board
Format:
- a signed integer
Command Output
Table 51.14-2 "Board Planned Resource Command" Display parameters
Specific Information
name Type Description
current-value Parameter type: <SignedInteger> The actual planned value for the
short name: cur-val - a signed integer resource.
This element is always shown.
maximum-value Parameter type: <SignedInteger> The maximum value that the
Command Description
This command retrieves the configuration data associated with SFP/SFP+/XFP.The following information is
shown for each specified sfp/sfp+/xfp:
• For the following data, output "not-Available" implies that the the measurement could not be obtained.
• inventory-status - the transceiver inventory status. For XFP, AO denotes the upper bank and A2 denotes the
lower bank.
• alu-part-num - the alcatel lucent part number available in sfp or xfp eeprom
• clei-code - the clei code available in sfp or xfp eeprom
• tx-wavelength - the transmission wavelength available in sfp or xfp eeprom
• fiber-type - the fiber type available in sfp or xfp eeprom
• additional-info - the customer specific additional information of the specified sfp or sfp+ or xfp
• mfg-name - the manufacturer name available in sfp or xfp eeprom
• mfg-oui - the manufacturer code available in sfp or xfp eeprom
• mfg-date - the manufacturer date available in sfp or xfp eeprom
• vendor-serial-num - the vendor serial number available in sfp or xfp eeprom
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.15-1 "Transceiver Inventory Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the physical sfp or xfp cage
( acu : <Eqpt::RackId> / <Eqpt::ShelfId> / position
<Eqpt::SfpCageNumber>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> : sfp :
<Eqpt::SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> : xfp :
<Eqpt::SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> : qsfp :
<Eqpt::SfpCageNumber>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> /
<Eqpt::SfpCageNumber>
| nt : sfp : <Eqpt::SfpCageNumber>
| nt : xfp : <Eqpt::SfpCageNumber>
| nt : qsfp : <Eqpt::SfpCageNumber>
Command Output
Table 51.15-2 "Transceiver Inventory Status Command" Display parameters
Specific Information
name Type Description
inventory-status Parameter type: <Eqpt::InvStatus> transceiver inventory status. for
Command Description
This command displays the status of the NE.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 51.16-2 "NE Status Command" Display parameters
Specific Information
name Type Description
planned-type Parameter type: <Equipm::SystemType> Specifies the planned isam type.
( laus This element is only shown in
| laeu detail mode.
| leeu
| maus
| leus
| lneu
| leww
| lnww )
Possible values:
- laus : large ASAM US / ANSI market (6 racks, 3 shelves
per rack)
- laeu : large ASAM EU / ETSI market (6 racks, 3 shelves
per rack)
- leeu : large ISAM for EU / ETSI market
- maus : mini RAM ASAM for US / ANSI market
- leus : large ISAM for US / ANSI market
- lneu : new equipment practice (NEP)
- leww : large ISAM World wide
- lnww : large ISAM World wide
actual-type Parameter type: <Equipm::SystemType> A string representing the system
( laus type that is actually present.
| laeu This element is always shown.
| leeu
| maus
| leus
| lneu
| leww
Command Description
This command shows the rack status.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.17-1 "Rack Status Command" Resource Parameters
Resource Identifier Type Description
(rack) Format: the rack identifier
<Eqpt::RackId>
Field type <Eqpt::RackId>
- the rack number
Command Output
Table 51.17-2 "Rack Status Command" Display parameters
Specific Information
name Type Description
planned-type Parameter type: <Equipm::RackType> Specifies the planned rack type.
( altr-e This element is only shown in
| altr-a detail mode.
| not-planned
| not-allowed
| empty )
Possible values:
- altr-e : ISAM ETSI DSL line termination rack (2200mm)
- altr-a : ISAM ANSI DSL line termination rack
- not-planned : holder is not planned
- not-allowed : shelf is not allowed in this position
- empty : shelf is empty in this position
actual-type Parameter type: <Equipm::RackType> A string representing the racktype
( altr-e that is actually present.
| altr-a This element is always shown.
| not-planned
| not-allowed
Command Description
This command shows the shelf status. The following information is shown in addition to configuration information:
• oper-status: describes whether the board is able to perform its normal operation.
• error-status: provides the reason why the board is not operational. These values correspond to the alarms
generated in case of a failure.
• available-status: provides further information regarding the state of the board.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.18-1 "Shelf Status Command" Resource Parameters
Resource Identifier Type Description
(shelf) Format: a shelf identifier: <rack>/<shelf>
<Eqpt::RackId> / <Eqpt::ShelfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Command Output
Table 51.18-2 "Shelf Status Command" Display parameters
Specific Information
name Type Description
planned-type Parameter type: <Equipm::ShelfType> Specifies the planned shelf type.
Data driven field type This element is only shown in
Possible values are depending on the actual configuration detail mode.
and software.
The currently allowed values can be shown with online-help.
actual-type Parameter type: <Equipm::ShelfType> A string representing the
Data driven field type shelftype that is actually present
Possible values are depending on the actual configuration in the rack.
and software. This element is always shown.
The currently allowed values can be shown with online-help.
admin-status Parameter type: <Equipm::HolderAdminStatus> Specifies the shelf is locked or
Description
This chapter gives an overview of nodes that are handled by "Protection Group Status Commands".
Command Tree
----show
----port-protection
- (port)
Command Description
This commands shows the protection group status. The following information is shown for each group :
• first-port: describes the port index of the first port in the protection group.
• paired-port: describes the port index of the paired port in the protection group.
• first-state: describes the the operational status of the first port.
• paired-state: describes the operational status of the paired port.
• swo-reason: describes the reason for the last switchover.
• num-swo: describes the number of switchovers that have occurred.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.2-1 "Protection Group Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: the port identifier of the first port
pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / in the protection group.
<Eqpt::PonId>
Possible values:
- pon : pon-aid
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier
Command Output
Table 52.2-2 "Protection Group Status Command" Display parameters
Specific Information
name Type Description
paired-port Parameter type: <RedPort::PairedPortIndex> the port identifier of the paired
pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / port in the protection group.
Description
This chapter gives an overview of nodes that are handled by "Trap Status Commands".
Command Tree
----show
----trap
----manager
- (address)
Command Description
This command displays the status of the trap manager queue.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 53.2-1 "Trap Manager Queue Status Command" Resource Parameters
Resource Identifier Type Description
(address) Format: the IP address of the manager
<Ip::V4Address> : <Trap::Port>
Field type <Ip::V4Address>
- IPv4-address
Field type <Trap::Port>
- trap port number
- range: [1...65535]
Command Output
Table 53.2-2 "Trap Manager Queue Status Command" Display parameters
Specific Information
name Type Description
last-reset-time Parameter type: <Sys::timeInSecs> time when the buffer has been
- the time (yyyy-mm-dd:hour:minutes:secs) reset.
- unit: UTC This element is always shown.
buffer-status Parameter type: <Trap::QueueStatus> specifies whether the trap buffer
( no-traps-lost is overflowed or not.
| traps-lost ) This element is always shown.
Possible values:
- no-traps-lost : the queue did not overflow - no traps were
lost
- traps-lost : the queue did overflow - traps were lost
Description
This chapter gives an overview of nodes that are handled by "Alarm Log Status Commands".
Command Tree
----show
----alarm
----log
----table
- (index)
----equipment
- (index)
----eqpt-holder
- (index)
----eqpt-holder-ext
- (index)
----plug-in-unit
- (index)
----atm
- (index)
----ether-itf
- (index)
----sw-mgmt
- (index)
----temporal
- (index)
----spatial
- (index)
----xdsl
----misc
- (index)
----near-end
- (index)
----far-end
- (index)
----xdsl-ext
----near-end
- (index)
----far-end
- (index)
----xdsl-tca
- (index)
----vect-line
- (index)
----vect-board
- (index)
----eo-conversion
- (index)
----authentication
- (index)
----bonding-group
- (index)
----redundancy
- (index)
----custom
- (index)
----sfp
- (index)
----custom-ext-alarm
- (index)
----sfprssi
- (index)
----pppcc-engine-tca
- (index)
----sfpe1t1-clock
- (index)
----sfpe1t1-framer
- (index)
----plug-in-unit-ext
- (index)
----sip-server
- (index)
----sip-vsp
- (index)
----sip-dial-plan
- (index)
----sip-plugin-unit
- (index)
----sip-termination
- (index)
----megaco-media-gw
- (index)
----megaco-sig-gw
- (index)
----megaco-plug-unit
- (index)
----megaco-term
- (index)
----megaco-sig-lt
- (index)
----shdsl
- (index)
----shdsl-isam
- (index)
----ima-group
- (index)
----ima-link
- (index)
----ether-tca
- (index)
----ether-sfp
- (index)
----uplink-ether-sfp
- (index)
----nni-ether-sfp
- (index)
----qos-slot
- (index)
----qos-queue
- (index)
----filetransfer
- (index)
----lsmredundancy
- (index)
----l2forward
- (index)
----external-device
- (index)
----cfm
- (index)
----sync
- (index)
----voice-plugin-unit
- (index)
----efm-oam
- (index)
----alarm-table
- (index)
----auto-switch
- (index)
Command Description
This command displays the alarm log entries.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.2-1 "Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.2-2 "Alarm Log Status Command" Display parameters
Specific Information
name Type Description
type Parameter type: <Alarm::alarmType> unique id for an alarm.
( equipment This element is always shown.
| eqpt-holder
| plug-in-unit
| atm
| custom
| ima-group
| ima-link
| redundancy
| shdsl
| ether-itf
| traffic-overflow
| qos-queue
| temporal
| spatial
| ( software-mngt | sw-mgmt )
| xdsl
| xdsl-ext
| xdsl-tca
| eo-conv
Command Description
This command displays the equipment alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.3-1 "Equipment Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.3-2 "Equipment Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
Only Show Details: current and previous alarm log status
name Type Description
cf-error Parameter type: <Alarm::cfError> Compact flash read or write error
( ( error | cfError ) occurred
| ( no-error | cfNoError ) ) This element is only shown in
Possible values: detail mode.
- error : CF access error
- cfError : CF access error
- no-error : CF no access error
- cfNoError : CF no access error
board-with-cf-error Parameter type: <Equipm::EqptNtSlotIndexOrNone> Board identification with cf-error
( nt-a This element is only shown in
| nt-b detail mode.
| nt
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
Command Description
This command displays the equipment holder alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.4-1 "Equipment Holder Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.4-2 "Equipment Holder Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
shelf Parameter type: <Equipm::Shelf> specify which shelf the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> occurred on.
Field type <Eqpt::RackId> This element is only shown in
- the rack number detail mode.
Field type <Eqpt::ShelfId>
- the shelf number
Only Show Details: current and previous alarm log status
name Type Description
rack-power Parameter type: <Alarm::rackPower> current status of rack power
( failing alarm, indicating fuse is broken
| ok ) or intact
Possible values: This element is only shown in
Command Description
This command displays the equipment holder extended alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.5-1 "Equipment Holder Extended Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.5-2 "Equipment Holder Extended Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
shelf Parameter type: <Equipm::Shelf> specify which shelf the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> occurred on.
Field type <Eqpt::RackId> This element is only shown in
- the rack number detail mode.
Field type <Eqpt::ShelfId>
- the shelf number
Only Show Details: current and previous alarm log status
name Type Description
ctl-com-fail Parameter type: <Alarm::ctlComFail> current status of shelf controller
( ( failing | fail ) communication failure.
| ok ) This element is only shown in
Possible values: detail mode.
Command Description
This command displays the plug-in unit alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.6-1 "Plug-in Unit Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.6-2 "Plug-in Unit Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
board-position Parameter type: <Alarm::SlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Command Description
This command displays the ATM alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.7-1 "ATM Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.7-2 "ATM Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Equipm::AtmIndex> identify where the alarm has
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred.
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
vpi-vci Parameter type: <Alarm::VpiVciValues> identify where the alarm has
- the vpi and vci value (vpi/vci) occurred.
This element is only shown in
detail mode.
Command Description
This command displays the ethernet interface alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.8-1 "Ethernet Interface Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.8-2 "Ethernet Interface Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
ether-ifindex Parameter type: <Ether::InterfaceIndex> identify where the alarm has
- index of the collision interface occurred.
- range: [0...2147483647] This element is only shown in
detail mode.
Only Show Details: current and previous alarm log status
name Type Description
prev-status Parameter type: <Alarm::EtherLinkStatus> status of link-down with its
( yes previous logged value.
| no ) This element is only shown in
Possible values: detail mode.
- yes : board switched off - excess temperature
- no : board switched on
Command Description
This command displays the software management Alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.9-1 "Software Management Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.9-2 "Software Management Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
board-position Parameter type: <Equipm::EqptSlotIndex> identifies the physical position of
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> the slot
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
Command Description
This command displays the temporal filter alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.10-1 "Temporal Filter Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.10-2 "Temporal Filter Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
Only Show Details: current and previous alarm log status
name Type Description
tmp-filter1 Parameter type: <Alarm::alrmFilter1> current status of temporal filter1
( yes alarm is derived or not
| no ) This element is only shown in
Possible values: detail mode.
- yes : derived filter1 alarm
- no : not derived filter1 alarm
prev-status Parameter type: <Alarm::alrmFilter1> status of temporal filter1 alarm
( yes with its previous logged value.
| no ) This element is only shown in
Possible values: detail mode.
- yes : derived filter1 alarm
- no : not derived filter1 alarm
tmp-filter2 Parameter type: <Alarm::alrmFilter2> current status of temporal filter2
Command Description
This command displays the spatial filter alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.11-1 "Spatial Filter Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.11-2 "Spatial Filter Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
Only Show Details: current and previous alarm log status
name Type Description
spa-filter1 Parameter type: <Alarm::alrmFilter1> current status of spatial filter1
( yes alarm is derived or not
| no ) This element is only shown in
Possible values: detail mode.
- yes : derived filter1 alarm
- no : not derived filter1 alarm
prev-status Parameter type: <Alarm::alrmFilter1> status of spatial filter1 alarm with
( yes its previous logged value.
| no ) This element is only shown in
Possible values: detail mode.
- yes : derived filter1 alarm
- no : not derived filter1 alarm
spa-filter2 Parameter type: <Alarm::alrmFilter2> current status of spatial filter2
Command Description
This command displays the xDSL common alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.12-1 "xDSL Common Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.12-2 "xDSL Common Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::XdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
name Type Description
line-config Parameter type: <Alarm::LineConfig> specifies whether line
( config-error configuration data is used or not.
Command Description
This command displays the xDSL near-end alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.13-1 "xDSL Near-end Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.13-2 "xDSL Near-end Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::XdslLine> Specifies where the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred.
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
name Type Description
los Parameter type: <Alarm::NearEndLOS> specifies near end loss of signal
( yes occured or not.
Command Description
This command displays the xDSL far-end alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.14-1 "xDSL Far-end Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.14-2 "xDSL Far-end Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::XdslLine> identifies where the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
name Type Description
los Parameter type: <Alarm::FarEndLOS> specifies whether far end loss of
( yes signal occured or not.
Command Description
This command displays the extended xDSL near-end alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.15-1 "xDSL Extended Near-End Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.15-2 "xDSL Extended Near-End Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::XdslLine> Specifies where the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred.
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
Command Description
This command displays the extended xDSL far-end alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.16-1 "xDSL Extended Far-End Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.16-2 "xDSL Extended Far-End Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::XdslLine> Specifies where the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred.
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
Command Description
This command displays the xDSL threshold cross alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.17-1 "TCA xDSL Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.17-2 "TCA xDSL Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::XdslLine> identifies where the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
name Type Description
errored-secs Parameter type: <Alarm::ErroredSeconds> number of errored seconds
( above-thres exceeded or below threshold
Command Description
This command displays the vectoring line alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.18-1 "Vectoring Line Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.18-2 "Vectoring Line Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::XdslLine> specifies where the alarm has
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred.
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
name Type Description
xtc-variation-vict Parameter type: <Alarm::VectXtcVariation> excessive : abnormal amplitude
( excessive variation in xtc coefficients
Command Description
This command displays the vectoring board alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.19-1 "Vectoring Board Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.19-2 "Vectoring Board Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
board-index Parameter type: <Equipm::EqptVpSlotIndex> specifies where the alarm has
( ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> occurred.
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> ) This element is only shown in
Possible values: detail mode.
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
vp-link-index Parameter type: <Alarm::VectVpLinkIdx2> this is the vplink id, soft-link id
- specifies the soft-link or the vp-link on the vp-board, or or ltlink id seen from the board
zero identified by board-index.
- range: [0,1...8] This element is only shown in
Command Description
This command displays the electrical-to-optical conversion alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.20-1 " Electrical-to-Optical Conversion Alarm Log Status Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.20-2 " Electrical-to-Optical Conversion Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <SignedInteger> identifies where the alarm
- a signed integer occurred
This element is only shown in
detail mode.
Only Show Details: current and previous alarm log status
name Type Description
loss-of-signal Parameter type: <Alarm::EoConvLOS> specifies whether loss of signal
( yes detected or not in the EO
| no ) conversion module
Possible values: This element is only shown in
- yes : loss of signal detected in the EO conversion module detail mode.
Command Description
This command displays the authentication-related alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.21-1 "Authentication Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.21-2 "Authentication Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
Only Show Details: current and previous alarm log status
name Type Description
vlan-assignment Parameter type: <Alarm::VLANassignment> specifies whether a VLAN for a
short name: vlan-assign ( failed user session is assigned or failed
| successful ) This element is only shown in
Possible values: detail mode.
- failed : failure to assign a VLAN for a user session
- successful : assigned a VLAN for a user session
prev-status Parameter type: <Alarm::VLANassignment> status of vlan-assignment with its
( failed previous logged value.
| successful ) This element is only shown in
Possible values: detail mode.
- failed : failure to assign a VLAN for a user session
- successful : assigned a VLAN for a user session
Command Description
This command displays the xDSL bonding-related alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.22-1 "xDSL Bonding Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.22-2 "xDSL Bonding Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
group Parameter type: <Xdsl::BondingInterfaceIndex> identifies the bonding group
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / interface index
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
name Type Description
up-plan-bitrate Parameter type: <Alarm::UpPlannedBitrate> specifies whether the actual
( failure group upstream bit rate is above
Command Description
This command displays the redundancy alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.23-1 "Redundancy Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.23-2 "Redundancy Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
Only Show Details: current and previous alarm log status
name Type Description
loss-over-cap Parameter type: <Alarm::SwoCap> identify the switchover capability
( loss in a redundant system.
| not-loss ) This element is only shown in
Possible values: detail mode.
- loss : system loss of the swichover capability
- not-loss : system not loss of the swichover capability
prev-status Parameter type: <Alarm::SwoCap> status of the switchover
( loss capability with its previous
| not-loss ) logged value.
Possible values: This element is only shown in
- loss : system loss of the swichover capability detail mode.
- not-loss : system not loss of the swichover capability
ping-check Parameter type: <Alarm::PingCheck> identify the ping check in a
Command Description
This command displays the custom alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.24-1 "Custom Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.24-2 "Custom Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
custom-alarm1 Parameter type: <Alarm::custom1> identify the customizableAlarm1
( yes .
| no ) This element is only shown in
Possible values: detail mode.
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
prev-status Parameter type: <Alarm::custom1> status of customizableAlarm1
( yes with its previous logged value.
| no ) This element is only shown in
Possible values: detail mode.
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
custom-alarm2 Parameter type: <Alarm::custom2> identify the customizableAlarm2
( yes .
| no ) This element is only shown in
Command Description
This command displays the SFP alarm log status.
For Expander card SFP alarms, the remote LT slot-identifier that corresponds to the SFP is displayed in the output
parameter "alarm index 1", and not the SFP faceplate cage-number identifier.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.25-1 "SFP Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.25-2 "SFP Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
alarm index 1 Parameter type: <Alarm::SfpAlarmIdx1Type> this is the host sfp faceplate
( <Alarm::SfpAlarmIdx1> number for host alarms or it is the
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> ) equipment slot id for expansion
Possible values: shelf alarms
- lt : the lt-slot This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Alarm::SfpAlarmIdx1>
- the host port faceplate number or the equipment slot-id for
Command Description
This command displays the customizable external alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.26-1 "Custom External Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.26-2 "Custom External Alarm Log Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::EqptSlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is always shown.
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
Command Description
This command displays the SFP RSSI alarm log status.
For NT card SFP alarms, the remote LT slot-identifier that corresponds to the SFP is displayed in the output
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.27-1 "SFP RSSI for NT Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.27-2 "SFP RSSI for NT Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
alarm index 1 Parameter type: <Alarm::SlotIndex> this is the nt/ntio slot id for host
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> alarms.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::LtAppliqueSlotId>
| ntio-1
Command Description
This command displays the PPP cross-connect engine TCA alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.28-1 "PPP Cross-Connect Engine TCA Alarm Log Status Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.28-2 "PPP Cross-Connect Engine TCA Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
engine Parameter type: <Vlan::StackedVlanSigned> this is the ppp-cc engine number
( <Vlan::UVlanIndex> This element is only shown in
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> ) detail mode.
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Command Description
This command displays the 2xE1/DS1 SFP Clock Alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.29-1 "2xE1/DS1 SFP Clock Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 54.29-2 "2xE1/DS1 SFP Clock Alarm Log Status Command" Display parameters
Specific Information
name Type Description
alarm index 1 Parameter type: <Alarm::SlotIndex> this is the nt/ntio slot id for host
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> alarms.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
Command Description
This command displays the 2xE1/DS1 SFP Framer alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.30-1 "2xE1/DS1 SFP Framer Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 54.30-2 "2xE1/DS1 SFP Framer Alarm Log Status Command" Display parameters
Specific Information
name Type Description
alarm index 1 Parameter type: <Alarm::SlotIndex> this is the nt/ntio slot id for host
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> alarms.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
Command Description
This command displays the plug-in unit extended alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.31-1 "Plug In Unit Extended Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.31-2 "Plug In Unit Extended Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
board-position Parameter type: <Equipm::EqptSlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
Command Description
This command displays the SIP server alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.32-1 "SIP Server Alarm Log Status Commands" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.32-2 "SIP Server Alarm Log Status Commands" Display parameters
Only Show Details: current and previous alarm log status
name Type Description
transport-mismatch Parameter type: <Alarm::transportMismatch> specifies isamv and server
( yes transport mismatch or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : mismatch
- no : not mismatch
prev-status Parameter type: <Alarm::transportMismatch> status of specifies transport
( yes mismatch with its previous
| no ) logged value
Possible values: This element is only shown in
- yes : mismatch detail mode.
- no : not mismatch
dns-lookup-failure Parameter type: <Alarm::dnsLookUpFailure> specifies dns look up fail or not.
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : fail
- no : not fail
prev-status Parameter type: <Alarm::dnsLookUpFailure> status of dns look up fail with its
Command Description
This command displays the SIP vsp alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.33-1 "SIP VSP Alarm Log Status Commands" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.33-2 "SIP VSP Alarm Log Status Commands" Display parameters
Only Show Details: current and previous alarm log status
name Type Description
none-dns-srv Parameter type: <Alarm::noneDNSSRV> specifies none of dns server give
( yes reply to to DNS look up or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : none of dns server give reply to to DNS look up
- no : dns server give reply to to DNS look up
prev-status Parameter type: <Alarm::noneDNSSRV> status of specifies none of dns
( yes server give reply to DNS look up
| no ) with its previous logged value
Possible values: This element is only shown in
- yes : none of dns server give reply to to DNS look up detail mode.
- no : dns server give reply to to DNS look up
no-dns-srv Parameter type: <Alarm::noDNSSRV> specifies no dns server
( yes configured when sip request or
| no ) not.
Possible values: This element is only shown in
- yes : no dns server configured when sip request detail mode.
- no : dns server configured when sip request
prev-status Parameter type: <Alarm::noDNSSRV> status of specifies no dns server
Command Description
This command displays the SIP dial plan alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.34-1 "SIP Dial Plan Alarm Log Status Commands" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.34-2 "SIP Dial Plan Alarm Log Status Commands" Display parameters
Only Show Details: current and previous alarm log status
name Type Description
bad-digitmap Parameter type: <Alarm::badDigitMap> specifies sip digitmap usable or
( yes not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : digit map unusable
- no : digit map usable
prev-status Parameter type: <Alarm::badDigitMap> status of specifies sip digitmap
( yes with its previous logged value
| no ) This element is only shown in
Possible values: detail mode.
- yes : digit map unusable
- no : digit map usable
Command Description
This command displays the SIP slot alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.35-1 "SIP Slot Alarm Log Status Commands" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.35-2 "SIP Slot Alarm Log Status Commands" Display parameters
Only Show Details: current and previous alarm log status
name Type Description
dhcp-unreach Parameter type: <Alarm::dhcpServerUnreach> specifies DHCP server status.
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : DHCP server unreachable
- no : DHCP server reachable
prev-status Parameter type: <Alarm::dhcpServerUnreach> status of specifies dhcp server
( yes with its previous logged value
| no ) This element is only shown in
Possible values: detail mode.
- yes : DHCP server unreachable
- no : DHCP server reachable
proxy-srv-unreach Parameter type: <Alarm::sipProxyServerUnreach> specifies sip proxy server status.
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : proxy server unreachable
- no : proxy server reachable
prev-status Parameter type: <Alarm::sipProxyServerUnreach> status of specifies sip proxy
Command Description
This command displays the SIP termination alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.36-1 "SIP Termination Alarm Log Status Commands" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.36-2 "SIP Termination Alarm Log Status Commands" Display parameters
Only Show Details: current and previous alarm log status
name Type Description
unknown-sub Parameter type: <Alarm::unknownSubscriber> specfies the sip subscriber
( yes unknow or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : wrong subscriber
- no : right subscriber
prev-status Parameter type: <Alarm::unknownSubscriber> status of specifies subscribers
( yes with its previous logged value
| no ) This element is only shown in
Possible values: detail mode.
- yes : wrong subscriber
- no : right subscriber
ground-key Parameter type: <Alarm::groundKey> status of the ground key.
( yes This element is only shown in
| no ) detail mode.
Possible values:
Command Description
This command displays the Megaco media gateway alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.37-1 "Megaco Media Gateway Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.37-2 "Megaco Media Gateway Alarm Log Status Command" Display parameters
Only Show Details: current and previous alarm log status
name Type Description
mgc-unreachable Parameter type: <Alarm::mgcUnreachable> specifies the media gateway
( yes controller status
| no ) This element is only shown in
Possible values: detail mode.
- yes : media gateway controller is unreachable
- no : media gateway controller is reachable
prev-status Parameter type: <Alarm::mgcUnreachable> status of specifies media gateway
( yes with its previous logged value
| no ) This element is only shown in
Possible values: detail mode.
- yes : media gateway controller is unreachable
- no : media gateway controller is reachable
failover-to-esamgc Parameter type: <Alarm::failovertoESAMGC> specifies the esa mgc status
( yes This element is only shown in
| no ) detail mode.
Possible values:
Command Description
This command displays the Megaco signaling gateway alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.38-1 "Megaco Signaling Gateway Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.38-2 "Megaco Signaling Gateway Alarm Log Status Command" Display parameters
Only Show Details: current and previous alarm log status
name Type Description
sgc-unreachable Parameter type: <Alarm::sgcUnreachable> specifies the signaling gateway
( yes controller status
| no ) This element is only shown in
Possible values: detail mode.
- yes : signallling gateway controller is unreachable
- no : signallling gateway controller is reachable
prev-status Parameter type: <Alarm::sgcUnreachable> status of specifies signaling
( yes gateway with its previous logged
| no ) value
Possible values: This element is only shown in
- yes : signallling gateway controller is unreachable detail mode.
- no : signallling gateway controller is reachable
Command Description
This command displays the Megaco plug unit alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.39-1 "Megaco Plug Unit Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.39-2 "Megaco Plug Unit Alarm Log Status Command" Display parameters
Only Show Details: current and previous alarm log status
name Type Description
lcard-unreach-srvcard Parameter type: <Alarm::lineCardUnreachSrvCard> specifies the line card with server
( yes card status
| no ) This element is only shown in
Possible values: detail mode.
- yes : line card is unreachable with server card
- no : line card is reachable with server card
prev-status Parameter type: <Alarm::lineCardUnreachSrvCard> status of line card and server card
( yes with its previous logged value
| no ) This element is only shown in
Possible values: detail mode.
- yes : line card is unreachable with server card
- no : line card is reachable with server card
lcard-type-mismatch Parameter type: <Alarm::lineCardTypeMismathch> specifies the line card type status
( yes This element is only shown in
| no ) detail mode.
Possible values:
Command Description
This command displays the Megaco termination alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.40-1 "Megaco Termination Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.40-2 "Megaco Termination Alarm Log Status Command" Display parameters
Only Show Details: current and previous alarm log status
name Type Description
meg-unknown-sub Parameter type: <Alarm::megacoUnknownSubscriber> specifies the megaco subscriber
( yes status
| no ) This element is only shown in
Possible values: detail mode.
- yes : unknown wrong megaco subscriber
- no : no wrong megaco subscriber
prev-status Parameter type: <Alarm::megacoUnknownSubscriber> status of the megaco subscriber
( yes with its previous logged value
| no ) This element is only shown in
Possible values: detail mode.
- yes : unknown wrong megaco subscriber
- no : no wrong megaco subscriber
meg-ground-key Parameter type: <Alarm::voicePortGroundKey> specifies the voice port ground
( yes key status
| no ) This element is only shown in
Possible values: detail mode.
Command Description
This command displays the Megaco signaling lt alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.41-1 "Megaco Signaling Lt Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.41-2 "Megaco Signaling Lt Alarm Log Status Command" Display parameters
Only Show Details: current and previous alarm log status
name Type Description
sig-brd-persist-loss Parameter type: <Alarm::megacoSigBoardPersDataLoss> specifies the voice signaling
( yes board persistenet data status
| no ) This element is only shown in
Possible values: detail mode.
- yes : the voice signaling board persistenet data loss
- no : the voice signaling board persistenet data not loss
prev-status Parameter type: <Alarm::megacoSigBoardPersDataLoss> status of voice signaling board
( yes persistenet data with its previous
| no ) logged value
Possible values: This element is only shown in
- yes : the voice signaling board persistenet data loss detail mode.
- no : the voice signaling board persistenet data not loss
sig-brd-disk-full Parameter type: <Alarm::voiceSigBoard90PercentFull> specifies the voice signaling
( yes board disk status
| no ) This element is only shown in
Possible values: detail mode.
Command Description
This command displays the Shdsl alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.42-1 "Shdsl Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.42-2 "Shdsl Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::ShdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
wire-pair Parameter type: <Alarm::LinkDeviceValuesHigh> identify where the alarm has
- identify where the alarm occurred occurred
This element is only shown in
detail mode.
Command Description
This command displays the Shdsl alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.43-1 "Shdsl Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.43-2 "Shdsl Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::ShdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
unit Parameter type: <Alarm::LinkDeviceValues> identify where the alarm has
- a signed integer occurred
This element is only shown in
detail mode.
Command Description
This command displays the Ima-Group alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.44-1 "Ima-Group Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.44-2 "Ima-Group Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Equipm::AtmImaIndex> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
name Type Description
far-end-start Parameter type: <Alarm::FarEndStartup> far-end starting up
( yes This element is only shown in
Command Description
This command displays the Ima-Link alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.45-1 "Ima-Link Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.45-2 "Ima-Link Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::ShdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
name Type Description
loss-ima-frm Parameter type: <Alarm::LossImaFrame> loss of ima frame
( yes This element is only shown in
Command Description
This command displays the Ether-Tca alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.46-1 "Ether-Tca Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.46-2 "Ether-Tca Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::EthernetPortIndex> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
name Type Description
etca-los Parameter type: <Alarm::EthTcaLos> ethernet loss of signal
( yes This element is only shown in
Command Description
This command displays the Ether-Sfp alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.47-1 "Ether-Sfp Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.47-2 "Ether-Sfp Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::EthernetPortIndex> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
name Type Description
sfp-los Parameter type: <Alarm::EthSfpLos> ethernet sfp loss of signal
( yes This element is only shown in
Command Description
This command displays the Ether-Sfp alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.48-1 "Ether-Sfp Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.48-2 "Ether-Sfp Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::EthernetPortIndex> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
name Type Description
uplink-sfp-los Parameter type: <Alarm::EthSfpLos> ethernet uplink sfp loss of signal
( yes This element is only shown in
Command Description
This command displays the Ether-Sfp alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.49-1 "Ether-Sfp Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.49-2 "Ether-Sfp Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::EthernetPortIndex> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
name Type Description
nni-sfp-los Parameter type: <Alarm::EthSfpLos> ethernet nni sfp loss of signal
( yes This element is only shown in
Command Description
This command displays the Qos Slot alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.50-1 "Alarm Qos Slot Log Status Commands" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.50-2 "Alarm Qos Slot Log Status Commands" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is always shown.
board-position Parameter type: <Equipm::EqptSlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is always shown.
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
Command Description
This command displays the Qos Queue alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.51-1 "Alarm Qos Queue Log Status Commands" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.51-2 "Alarm Qos Queue Log Status Commands" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is always shown.
port Parameter type: <Itf::PhyLine> identifies the physical position of
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is always shown.
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> )
Possible values:
- ont : ont
Field type <Eqpt::RackId>
- the rack number
Command Description
This command displays the log status of the file transfer server alarm.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.52-1 "Log File Transfer Server Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.52-2 "Log File Transfer Server Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
server-id Parameter type: <Alarm::FileTransfer> this is the server id for file server
- next hop IP address alarms
This element is only shown in
detail mode.
fileserv-unavail Parameter type: <Alarm::FileTransferUnavial> current status specifing that
( unavailable whether file transfer server
| available ) available
Possible values: This element is only shown in
- unavailable : file transfer Server unavailable or file transfer detail mode.
failed
- available : file transfer server available
prev-status Parameter type: <Alarm::relayNotSet> status of relay with its previous
Command Description
This command displays the log status of the Lsm Redundancy alarm.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.53-1 "Log Lsm Redundancy Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.53-2 "Log Lsm Redundancy Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
board-station Parameter type: <Equipm::LtSlotIndex> this is the physical number of the
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> slot for lsm redundancy alarms
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> ) This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
loss-lsmswp-cap Parameter type: <Alarm::SwoCap> current status specifing the
( loss switchover capability in a
| not-loss ) redundant system
Command Description
This command displays the log status of the l2 forward alarm.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.54-1 "Log L2 Forward Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.54-2 "Log L2 Forward Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
bridgeport Parameter type: <Vlan::BridgePort> identify the bridge port where the
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / alarm has occurred.
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> This element is only shown in
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / detail mode.
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
Command Description
This command displays the external-device alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.55-1 "External Device Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.55-2 "External Device Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
loss-env-mon Parameter type: <Alarm::LossEnvMon> status of env-monitor box
( lost This element is only shown in
| not-lost ) detail mode.
Possible values:
- lost : env-mon box lost or not alive
- not-lost : env-mon box exists
prev-status Parameter type: <Alarm::LossEnvMon> status of loss-env-mon with its
( lost previous logged value
| not-lost ) This element is only shown in
Possible values: detail mode.
- lost : env-mon box lost or not alive
- not-lost : env-mon box exists
Command Description
This command displays lt cfm alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.56-1 "LT CFM Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.56-2 "LT CFM Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged
- unit: UTC This element is only shown in
detail mode.
cfm-mep-id Parameter type: <UnsignedSignedInteger> dot1agCfmMepIdentifier index
- an unsigned integer where the alarm has occurred.
This element is only shown in
detail mode.
cfm-unique-id Parameter type: <Alarm::IdentificationIdxOrZero> unique identification for the
- a signed integer alarm or zero when not
applicable, alarm entry is further
specified in additional-info
This element is only shown in
detail mode.
additional-info Parameter type: <PrintableString> Additional information regarding
- printable string the cfm alarm
This element is only shown in
detail mode.
Only Show Details: current and previous alarm log status
Command Description
This command displays the synce and bits alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.57-1 "Sync Clock Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.57-2 "Sync Clock Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged
- unit: UTC This element is only shown in
detail mode.
Only Show Details: slot information
name Type Description
slot Parameter type: <Alarm::SynceSlot> identifies the synce port where
( ntio-1 the alarm has occurred.
| ntio-2 This element is only shown in
| nt-a detail mode.
| nt-b
| nt
| not-used
| nt )
Possible values:
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot
Command Description
This command displays the voice plug-in unit alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.58-1 "Voice Plug-in Unit Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.58-2 "Voice Plug-in Unit Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
board-position Parameter type: <Alarm::SlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
Command Description
This command displays the EFM-OAM alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.59-1 "EFM-OAM Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.59-2 "EFM-OAM Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
line Parameter type: <Itf::EfmEthernetIndex> identifies the physical xdsl line
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / This element is only shown in
<Eqpt::PortId> detail mode.
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
name Type Description
link-fault Parameter type: <Alarm::linkFaultType> specifies whether link fault is
( yes present or not.
Command Description
This command displays the alarm-table alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.60-1 "Alarm Table Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.60-2 "Alarm Table Alarm Log Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
Only Show Details: current and previous alarm log status
name Type Description
alrm-tbl-overflow Parameter type: <Alarm::AlrmTblOflow> identify if the alarm table has
( overflow overflowed
| no-overflow ) This element is only shown in
Possible values: detail mode.
- overflow : alarm table overflow
- no-overflow : no alarm table overflow
prev-status Parameter type: <Alarm::AlrmTblOflow> previously logged value of the
( overflow alarm table overflow alarm
| no-overflow ) This element is only shown in
Possible values: detail mode.
- overflow : alarm table overflow
- no-overflow : no alarm table overflow
Command Description
This command displays log table of autoswitch alarm.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.61-1 "Auto-Switch Alarm Log Status command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 54.61-2 "Auto-Switch Alarm Log Status command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
port Parameter type: <Itf::XdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current and previous alarm log status
name Type Description
auto-switch-status Parameter type: <Alarm::autoSwitchStatus> show auto-switch alarm status.
( yes This element is only shown in
Description
This chapter gives an overview of nodes that are handled by "Current Alarm Status Commands".
Command Tree
----show
----alarm
----current
----table
- (index)
----equipment
- (index)
----eqpt-holder
- (index)
----eqpt-holder-ext
- (index)
----plug-in-unit
- (index)
----atm
- (index)
----ether-itf
- (index)
----sw-mgmt
- (index)
----temporal
- (index)
----spatial
- (index)
----xdsl
- (index)
----xdsl-ext
- (index)
----xdsl-tca
- (index)
----vect-line
- (index)
----vect-board
- (index)
----eo-conversion
- (index)
----authentication
- (index)
----bonding-group
- (index)
----redundancy
- (index)
----custom
- (index)
----sfp
- (index)
----custom-ext-alarm
- (index)
----sfprssi
- (index)
----pppcc-engine-tca
- (index)
----sfpe1t1-clock
- (index)
----sfpe1t1-framer
- (index)
----plug-in-unit-ext
- (index)
----sip-server
- (index)
----sip-vsp
- (index)
----sip-dial-plan
- (index)
----sip-plugin-unit
- (index)
----sip-termination
- (index)
----megaco-media-gw
- (index)
----megaco-sig-gw
- (index)
----megaco-plug-unit
- (index)
----megaco-term
- (index)
----megaco-sig-lt
- (index)
----shdsl
- (index)
----shdsl-isam
- (index)
----ima-group
- (index)
----ima-link
- (index)
----ether-tca
- (index)
----ether-sfp
- (index)
----uplink-ether-sfp
- (index)
----nni-ether-sfp
- (index)
----qos-slot
- (index)
----qos-queue
- (index)
----filetransfer
- (index)
----lsmredundancy
- (index)
----l2forward
- (index)
----external-device
- (index)
----sync
- (index)
----voice-plugin-unit
- (index)
----cfm
- (index)
----efm-oam
- (index)
----alarm-table
- (index)
----auto-switch
- (index)
Command Description
This command displays all current alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.2-1 "Alarm Current Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.2-2 "Alarm Current Status Command" Display parameters
Specific Information
name Type Description
type Parameter type: <Alarm::alarmType> type of the alarms that are active.
( equipment This element is always shown.
| eqpt-holder
| plug-in-unit
| atm
| custom
| ima-group
| ima-link
| redundancy
| shdsl
| ether-itf
| traffic-overflow
| qos-queue
| temporal
| spatial
| ( software-mngt | sw-mgmt )
| xdsl
| xdsl-ext
| xdsl-tca
| eo-conv
Command Description
This command displays the equipment current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.3-1 "Equipment Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.3-2 "Equipment Current Alarm Status Command" Display parameters
Specific Information
name Type Description
persist-data Parameter type: <Alarm::persistDataLoss> current status specifing persistant
( lost data is lost or not
| not-lost ) This element is only shown in
Possible values: detail mode.
- lost : persistant data is lost
- not-lost : persistant data is not lost
sntp-comm Parameter type: <Alarm::sntpCommLoss> current status of sntp
( lost communication is lost or not
| not-lost ) This element is only shown in
Possible values: detail mode.
- lost : SNTP communication lost
- not-lost : SNTP communication is not lost
cf-error Parameter type: <Alarm::cfError> Compact flash read or write error
( ( error | cfError ) occurred
| ( no-error | cfNoError ) ) This element is only shown in
Possible values: detail mode.
- error : CF access error
- cfError : CF access error
- no-error : CF no access error
Command Description
This command displays the equipment holder current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.4-1 "Equipment Holder Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.4-2 "Equipment Holder Current Alarm Status Command" Display parameters
Specific Information
name Type Description
shelf Parameter type: <Equipm::Shelf> specify which shelf the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> occurred on.
Field type <Eqpt::RackId> This element is only shown in
- the rack number detail mode.
Field type <Eqpt::ShelfId>
- the shelf number
rack-power Parameter type: <Alarm::rackPower> current status of rack power
( failing alarm, indicating fuse is broken
| ok ) or intact
Possible values: This element is only shown in
- failing : the fuse is broken detail mode.
- ok : the fuse is intact
fan-unit1 Parameter type: <Alarm::fanUnit1> current status of fan-unit1
short name: fan1 ( ( failing | fail ) This element is only shown in
| ok ) detail mode.
Possible values:
Command Description
This command displays the equipment holder extended current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.5-1 "Equipment Holder Extended Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.5-2 "Equipment Holder Extended Current Alarm Status Command" Display parameters
Specific Information
name Type Description
shelf Parameter type: <Equipm::Shelf> specify which shelf the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> occurred on.
Field type <Eqpt::RackId> This element is only shown in
- the rack number detail mode.
Field type <Eqpt::ShelfId>
- the shelf number
ctl-com-fail Parameter type: <Alarm::ctlComFail> current status of shelf controller
( ( failing | fail ) communication failure.
| ok ) This element is only shown in
Possible values: detail mode.
- failing : shelf controller communication is failing
- fail : shelf controller communication is failing
- ok : shelf controller communication is ok
network-power-loss Parameter type: <Alarm::netPwrFail> current status of network power
( ( failing | fail ) failure.
| ok ) This element is only shown in
Command Description
This command displays the plug-in unit current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.6-1 "Plug-in Unit Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.6-2 "Plug-in Unit Current Alarm Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Alarm::SlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
Command Description
This command displays the ATM current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.7-1 "ATM Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.7-2 "ATM Current Alarm Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Equipm::AtmIndex> identify where the alarm has
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred.
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
vpi-vci Parameter type: <Alarm::VpiVciValues> identify where the alarm has
- the vpi and vci value (vpi/vci) occurred.
This element is only shown in
detail mode.
cell-discard-up Parameter type: <Alarm::CellDiscardUpstream> specifies ATM cell is discarded
( discarded or not in upstream direction.
| no-discard ) This element is only shown in
Possible values: detail mode.
Command Description
This command displays the Ethernet Interface current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.8-1 "Ethernet Interface Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.8-2 "Ethernet Interface Current Alarm Status Command" Display parameters
Specific Information
name Type Description
ether-ifindex Parameter type: <Ether::InterfaceIndex> identify where the alarm has
- index of the collision interface occurred.
- range: [0...2147483647] This element is only shown in
detail mode.
Command Description
This command displays the software management current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.9-1 "Software Management Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.9-2 "Software Management Current Alarm Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::EqptSlotIndex> identifies the physical position of
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> the slot
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
Command Description
This command displays temporal filter current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.10-1 "Temporal Filter Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.10-2 "Temporal Filter Current Alarm Status Command" Display parameters
Specific Information
name Type Description
tmp-filter1 Parameter type: <Alarm::alrmFilter1> current status for temporal filter1
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : derived filter1 alarm
- no : not derived filter1 alarm
tmp-filter2 Parameter type: <Alarm::alrmFilter2> current status for temporal filter2
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : derived filter2 alarm
- no : not derived filter2 alarm
tmp-filter3 Parameter type: <Alarm::alrmFilter3> current status for temporal filter3
( yes This element is only shown in
| no ) detail mode.
Possible values:
Command Description
This command displays spatial filter current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.11-1 "Spatial Filter Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.11-2 "Spatial Filter Current Alarm Status Command" Display parameters
Specific Information
name Type Description
spa-filter1 Parameter type: <Alarm::alrmFilter1> current status for spatial filter1
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : derived filter1 alarm
- no : not derived filter1 alarm
spa-filter2 Parameter type: <Alarm::alrmFilter2> current status for spatial filter2
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : derived filter2 alarm
- no : not derived filter2 alarm
spa-filter3 Parameter type: <Alarm::alrmFilter3> current status for spatial filter3
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : derived filter3 alarm
- no : not derived filter3 alarm
spa-filter4 Parameter type: <Alarm::alrmFilter4> current status for spatial filter4
Command Description
This command displays the xDSL current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.12-1 "xDSL Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.12-2 "xDSL Current Alarm Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::XdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
near-end-los Parameter type: <Alarm::NearEndLOS> specifies near end loss of signal
( yes occured or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : near end loss of signal occurred
- no : no near end loss of signal
near-end-lof Parameter type: <Alarm::NearEndLOF> specifies near end loss of frame
( yes occured or not.
Command Description
This command displays the xDSL extended current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.13-1 "xDSL Extended Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.13-2 "xDSL Extended Current Alarm Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::XdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
near-end-lor Parameter type: <Alarm::NearEndLOR> specifies if near end loss of
( yes robust management channel
| no ) occured or not.
Possible values: This element is only shown in
- yes : near end loss of robust management channel occurred detail mode.
Command Description
This command displays the xDSL threshold cross current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.14-1 "TCA xDSL Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.14-2 "TCA xDSL Current Alarm Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::XdslLine> identifies where the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
errored-secs Parameter type: <Alarm::ErroredSeconds> number of errored seconds
( above-thres exceeded or below threshold
| below-thres ) This element is only shown in
Possible values: detail mode.
- above-thres : number of errored seconds exceeded
threshold
- below-thres : number of errored seconds below threshold
es-in-a-day Parameter type: <Alarm::ErroredSecondsInAday> errored seconds in a day
Command Description
This command displays the vectoring line current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.15-1 "Vectoring Line Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm table index
- index of a current alarm entry
Command Output
Table 55.15-2 "Vectoring Line Current Alarm Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::XdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port where the alarm has
<Eqpt::PortId> occurred.
Field type <Eqpt::RackId> This element is only shown in
- the rack number detail mode.
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
xtc-variation-vict Parameter type: <Alarm::VectXtcVariation> excessive : abnormal amplitude
( excessive variation in xtc coefficients
| normal ) This element is only shown in
Possible values: detail mode.
- excessive : abnormal amplitude variation in xtc
Command Description
This command displays the vectoring board current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.16-1 "Vectoring Board Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm table index
- index of a current alarm entry
Command Output
Table 55.16-2 "Vectoring Board Current Alarm Status Command" Display parameters
Specific Information
name Type Description
board-index Parameter type: <Equipm::EqptVpSlotIndex> specifies where the alarm has
( ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> occurred.
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> ) This element is only shown in
Possible values: detail mode.
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
vp-link-index Parameter type: <Alarm::VectVpLinkIdx2> this is the vplink id, soft-link id
- specifies the soft-link or the vp-link on the vp-board, or or ltlink id seen from the board
zero identified by board-index.
- range: [0,1...8] This element is only shown in
detail mode.
Command Description
This command displays the Electrical-to-Optical conversion current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.17-1 "Electrical-to-Optical Conversion Current Alarm Status Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.17-2 "Electrical-to-Optical Conversion Current Alarm Status Command" Display
parameters
Specific Information
name Type Description
port Parameter type: <SignedInteger> identifies where the alarm
- a signed integer occurred.
This element is only shown in
detail mode.
loss-of-signal Parameter type: <Alarm::EoConvLOS> specifies whether loss of signal
( yes detected or not in the EO
| no ) conversion module
Possible values: This element is only shown in
- yes : loss of signal detected in the EO conversion module detail mode.
- no : no loss of signal detected in the EO conversion
module
transmission Parameter type: <Alarm::EoConvTx> specifies whether transmission
( faulty fault is occurred or not in the EO
| ok ) module
Command Description
This command displays the authentication current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.18-1 "Authentication Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.18-2 "Authentication Current Alarm Status Command" Display parameters
Specific Information
name Type Description
vlan-assign Parameter type: <Alarm::VLANassignment> specifies whether a VLAN for a
( failed user session is assigned or failed
| successful ) This element is only shown in
Possible values: detail mode.
- failed : failure to assign a VLAN for a user session
- successful : assigned a VLAN for a user session
Command Description
This command displays the xDSL Bonding current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.19-1 "xDSL Bonding Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.19-2 "xDSL Bonding Current Alarm Status Command" Display parameters
Specific Information
name Type Description
group Parameter type: <Xdsl::BondingInterfaceIndex> identifies the bonding group
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / interface index
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
up-plan-bitrate Parameter type: <Alarm::UpPlannedBitrate> specifies whether the actual
( failure group upstream bit rate is above
| ok ) the group upstream planned bit
Possible values: rate or not
- failure : actual group bitrate is above the minimum This element is only shown in
Command Description
This command displays the redundancy current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.20-1 "Redundancy Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.20-2 "Redundancy Current Alarm Status Command" Display parameters
Specific Information
name Type Description
loss-over-cap Parameter type: <Alarm::SwoCap> identify the switchover capability
( loss in a redundant system.
| not-loss ) This element is only shown in
Possible values: detail mode.
- loss : system loss of the swichover capability
- not-loss : system not loss of the swichover capability
ping-check-fail Parameter type: <Alarm::PingCheck> identify the ping check in a
( failure redundant system.
| successful ) This element is only shown in
Possible values: detail mode.
- failure : system failure of ping check
- successful : system successful of ping check
Command Description
This command displays the custom current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.21-1 "Custom Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.21-2 "Custom Current Alarm Status Command" Display parameters
Specific Information
name Type Description
custom-alarm1 Parameter type: <Alarm::custom1> identify the customizableAlarm1
( yes .
| no ) This element is only shown in
Possible values: detail mode.
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
custom-alarm2 Parameter type: <Alarm::custom2> identify the customizableAlarm2
( yes .
| no ) This element is only shown in
Possible values: detail mode.
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
custom-alarm3 Parameter type: <Alarm::custom3> identify the customizableAlarm3
( yes .
| no ) This element is only shown in
Possible values: detail mode.
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
custom-alarm4 Parameter type: <Alarm::custom4> identify the customizableAlarm4
Command Description
This command displays the SFP current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.22-1 "SFP Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.22-2 "SFP Current Alarm Status Command" Display parameters
Specific Information
name Type Description
alarm index 1 Parameter type: <Alarm::SfpAlarmIdx1Type> this is the host sfp faceplate
( <Alarm::SfpAlarmIdx1> number for host alarms or it is the
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> ) equipment slot id for expansion
Possible values: shelf alarms
- lt : the lt-slot This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Alarm::SfpAlarmIdx1>
- the host port faceplate number or the equipment slot-id for
expansion shelf alarm
alarm index 2 Parameter type: <Alarm::SfpAlarmIdx2Type> this is the lanx port id for host
( <Alarm::SfpAlarmIdx2> alarms. this index is not used for
| nt : sfp : <Eqpt::PortIndex> expansion shelf alarms
| nt-a : sfp : <Alarm::SfpAlarmIdx2> This element is only shown in
| nt-a : xfp : <Alarm::SfpAlarmIdx2> detail mode.
Command Description
This command displays the custom external current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.23-1 "Custom External Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 55.23-2 "Custom External Current Alarm Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::EqptSlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is always shown.
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
Command Description
This command displays the SFP RSSI current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.24-1 "SFP RSSI Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.24-2 "SFP RSSI Current Alarm Status Command" Display parameters
Specific Information
name Type Description
alarm index 1 Parameter type: <Alarm::SlotIndex> this is the nt/ntio slot id for host
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> alarms.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
Command Description
This command displays the pppcc engine tca current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.25-1 "PPP Cross-Connect Engine TCA Current Alarm Status Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.25-2 "PPP Cross-Connect Engine TCA Current Alarm Status Command" Display
parameters
Specific Information
name Type Description
engine Parameter type: <Vlan::StackedVlanSigned> this is the ppp-cc engine number
( <Vlan::UVlanIndex> This element is only shown in
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> ) detail mode.
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]
Command Description
This command displays the 2xE1/DS1 SFP Clock current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.26-1 "2xE1/DS1 SFP Clock Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.26-2 "2xE1/DS1 SFP Clock Current Alarm Status Command" Display parameters
Specific Information
name Type Description
alarm index 1 Parameter type: <Alarm::SlotIndex> this is the nt/ntio slot id for host
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> alarms.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
Command Description
This command displays the 2xE1/DS1 SFP Framer current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.27-1 "2xE1/DS1 SFP Framer Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.27-2 "2xE1/DS1 SFP Framer Alarm Status Command" Display parameters
Specific Information
name Type Description
alarm index 1 Parameter type: <Alarm::SlotIndex> this is the nt/ntio slot id for host
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> alarms.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
Command Description
This command shows the plug-in unit extended current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.28-1 "Plug In Unit Extended Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snapshot table index
- index of a current alarm entry
Command Output
Table 55.28-2 "Plug In Unit Extended Current Alarm Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::EqptSlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
Command Description
This command displays the SIP Server current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.29-1 "SIP Server Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.29-2 "SIP Server Current Alarm Status Command" Display parameters
Specific Information
name Type Description
server-index Parameter type: <Sip::ServerId> identifies sip server
- the SIP server table index This element is only shown in
- range: [1...128] detail mode.
transport-mismatch Parameter type: <Alarm::transportMismatch> specifies isamv and server
( yes transport mismatch or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : mismatch
- no : not mismatch
dns-lookup-failure Parameter type: <Alarm::dnsLookUpFailure> specifies dns look up fail or not.
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : fail
- no : not fail
Command Description
This command displays the SIP VSP current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.30-1 "SIP VSP Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.30-2 "SIP VSP Current Alarm Status Command" Display parameters
Specific Information
name Type Description
vsp-index Parameter type: <Sip::DialPlanId> identifies sip vsp
- the dial plan table index This element is only shown in
- range: [1...255] detail mode.
none-dns-srv Parameter type: <Alarm::noneDNSSRV> specifies none of dns server give
( yes reply to to DNS look up or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : none of dns server give reply to to DNS look up
- no : dns server give reply to to DNS look up
no-dns-srv Parameter type: <Alarm::noDNSSRV> specifies no dns server
( yes configured when sip request or
| no ) not.
Possible values: This element is only shown in
- yes : no dns server configured when sip request detail mode.
- no : dns server configured when sip request
none-srv Parameter type: <Alarm::noneSRV> specifies none sip server give
( yes reply when send sip request or
| no ) not.
Possible values: This element is only shown in
Command Description
This command displays the SIP dial plan current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.31-1 "SIP Dial Plan Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.31-2 "SIP Dial Plan Current Alarm Status Command" Display parameters
Specific Information
name Type Description
dialplan-index Parameter type: <Sip::DialPlanId> identifies the dial plan
- the dial plan table index This element is only shown in
- range: [1...255] detail mode.
bad-digitmap Parameter type: <Alarm::badDigitMap> specifies sip digitmap status.
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : digit map unusable
- no : digit map usable
Command Description
This command displays the SIP slot current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.32-1 "SIP Slot Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.32-2 "SIP Slot Current Alarm Status Command" Display parameters
Specific Information
name Type Description
slot-index Parameter type: <Equipm::EqptSlotIndex> identifies the board
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> This element is only shown in
| nt-a detail mode.
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
Command Description
This command displays the SIP termination current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.33-1 "SIP Termination Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.33-2 "SIP Termination Current Alarm Status Command" Display parameters
Specific Information
name Type Description
term-index Parameter type: <Itf::PotsLine> identifies the termination
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / This element is only shown in
<Eqpt::PortId> detail mode.
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
unknown-sub Parameter type: <Alarm::unknownSubscriber> specfies the sip subscriber
( yes unknow or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : wrong subscriber
Command Description
This command displays the Megaco media gateway current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.34-1 "Megaco Media Gateway Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.34-2 "Megaco Media Gateway Current Alarm Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::EqptSlotIndex> identify the board where the
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> alarm has occurred.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
Command Description
This command displays the Megaco signaling gateway current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.35-1 "Megaco Signaling Gateway Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.35-2 "Megaco Signaling Gateway Current Alarm Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::LtSlotIndex> identify the board where the
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> alarm has occurred.
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> ) This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
sgc-unreachable Parameter type: <Alarm::sgcUnreachable> specifies the signaling gateway
( yes controller is unreachable or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : signallling gateway controller is unreachable
- no : signallling gateway controller is reachable
Command Description
This command displays the Megaco plugin unit current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.36-1 "Megaco Plugin Unit Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.36-2 "Megaco Plugin Unit Current Alarm Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::PortSlotIndex> identify the board where the
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> alarm has occurred.
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> ) This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::NewSlotId>
- the LT slot number
lcard-unreach-srvcard Parameter type: <Alarm::lineCardUnreachSrvCard> specifies the line card is
( yes unreachable with server card or
| no ) not.
Possible values: This element is only shown in
- yes : line card is unreachable with server card detail mode.
- no : line card is reachable with server card
lcard-type-mismatch Parameter type: <Alarm::lineCardTypeMismathch> specifies the line card type is
Command Description
This command displays the Megaco termination current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.37-1 "Megaco Termination Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.37-2 "Megaco Termination Current Alarm Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::MegacoPotsLine> identify the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> / the port.
<Eqpt::MegacoPortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::NewSlotId>
- the LT slot number
Field type <Eqpt::MegacoPortId>
- the port number of Megaco
meg-unknown-sub Parameter type: <Alarm::megacoUnknownSubscriber> specifies the megaco subscriber is
( yes unknown or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : unknown wrong megaco subscriber
Command Description
This command displays the Megaco signaling lt current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.38-1 "Megaco Signaling Lt Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.38-2 "Megaco Signaling Lt Current Alarm Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::LtSlotIndex> identify the board where the
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> alarm has occurred.
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> ) This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
sig-brd-persist-loss Parameter type: <Alarm::megacoSigBoardPersDataLoss> specifies the voice signaling
( yes board persistenet data loss or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : the voice signaling board persistenet data loss
- no : the voice signaling board persistenet data not loss
sig-brd-disk-full Parameter type: <Alarm::voiceSigBoard90PercentFull> specifies the voice signaling
Command Description
This command displays the Shdsl current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.39-1 "Shdsl Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.39-2 "Shdsl Current Alarm Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::ShdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
unit Parameter type: <Alarm::LinkDeviceValues> identify where the alarm has
- a signed integer occurred
This element is only shown in
detail mode.
loop-act-net Parameter type: <Alarm::LoopbackActiveNetwork> current status of loopback active
( yes at the network side
| no ) This element is only shown in
Possible values: detail mode.
Command Description
This command displays the Shdsl current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.40-1 "Shdsl Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.40-2 "Shdsl Current Alarm Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::ShdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
wire-pair Parameter type: <Alarm::LinkDeviceValuesHigh> identify where the alarm has
- identify where the alarm occurred occurred
This element is only shown in
detail mode.
unit Parameter type: <Alarm::LinkDeviceValuesLow> identify where the alarm has
- identify where the alarm occurred occurred
This element is only shown in
detail mode.
Command Description
This command displays the Ima-Group current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.41-1 "Ima-Group Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.41-2 "Ima-Group Current Alarm Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Equipm::AtmImaIndex> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
far-end-start Parameter type: <Alarm::FarEndStartup> current status of far-end starting
( yes up
| no ) This element is only shown in
Possible values: detail mode.
- yes : far-end startup
- no : no far-end startup
far-end-fconf Parameter type: <Alarm::FarEndFailedConfig> current status of failed
( yes configuration of far-end
Command Description
This command displays the Ima-Link current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.42-1 "Ima-Link Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.42-2 "Ima-Link Current Alarm Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::ShdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
loss-ima-frm Parameter type: <Alarm::LossImaFrame> current status of loss of ima
( yes frame
| no ) This element is only shown in
Possible values: detail mode.
- yes : loss ima frame
- no : no loss ima frame
lods Parameter type: <Alarm::LinkOutofDelaySynch> current status of link out of delay
( yes synchronization
Command Description
This command displays the Ether-Tca related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.43-1 "Alarm Current Ether-Tca Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.43-2 "Alarm Current Ether-Tca Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::EthernetPortIndex> identify where the alarm has
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
etca-los Parameter type: <Alarm::EthTcaLos> current status of ethernet los in 15
( yes min
| no ) This element is only shown in
Possible values: detail mode.
- yes : ethernet loss of signal errors exceeds
- no : ethernet loss of signal errors normal
etca-fcs Parameter type: <Alarm::EthTcaFcs> current status of ethernet fcs in 15
( yes min
Command Description
This command displays the Ether-Sfp related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.44-1 "Alarm Current Ether-Sfp Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.44-2 "Alarm Current Ether-Sfp Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::EthernetPortIndex> identify where the alarm has
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
sfp-los Parameter type: <Alarm::EthSfpLos> current status of ethernet sfp los
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : ethernet sfp los error
- no : ethernet sfp los normal
sfp-tx-fail Parameter type: <Alarm::EthSfpTxFail> current status of ethernet sfp tx
( yes This element is only shown in
Command Description
This command displays the Ether-Sfp related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.45-1 "Alarm Current Ether-Sfp Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.45-2 "Alarm Current Ether-Sfp Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::EthernetPortIndex> identify where the alarm has
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
uplink-sfp-los Parameter type: <Alarm::EthSfpLos> current status of uplink ethernet
( yes sfp los
| no ) This element is only shown in
Possible values: detail mode.
- yes : ethernet sfp los error
- no : ethernet sfp los normal
uplink-sfp-tx-fail Parameter type: <Alarm::EthSfpTxFail> current status of uplink ethernet
( yes sfp tx
Command Description
This command displays the Ether-Sfp related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.46-1 "Alarm Current Ether-Sfp Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.46-2 "Alarm Current Ether-Sfp Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::EthernetPortIndex> identify where the alarm has
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
nni-sfp-los Parameter type: <Alarm::EthSfpLos> current status of nni ethernet sfp
( yes los
| no ) This element is only shown in
Possible values: detail mode.
- yes : ethernet sfp los error
- no : ethernet sfp los normal
nni-sfp-tx-fail Parameter type: <Alarm::EthSfpTxFail> current status of nni ethernet sfp
( yes tx
Command Description
This command displays the Qos Slot related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.47-1 "Alarm Current Qos Slot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.47-2 "Alarm Current Qos Slot Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::EqptSlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
Command Description
This command displays the Qos Queue related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.48-1 "Alarm Current Qos Queue Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.48-2 "Alarm Current Qos Queue Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::PhyLine> identifies the physical position of
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / detail mode.
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> )
Possible values:
- ont : ont
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Command Description
This command displays the file transfer server related current alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.49-1 "Alarm File Transfer Server Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.49-2 "Alarm File Transfer Server Status Command" Display parameters
Specific Information
name Type Description
server-id Parameter type: <Alarm::FileTransfer> identify where the alarm has
- next hop IP address occurred.
This element is only shown in
detail mode.
fileserv-unavail Parameter type: <Alarm::FileTransferUnavial> current status specifing that
( unavailable whether file transfer server
| available ) available
Possible values: This element is only shown in
- unavailable : file transfer Server unavailable or file transfer detail mode.
failed
- available : file transfer server available
Command Description
This command displays the LSM Redundancy related current alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.50-1 "Alarm LSM Redundancy Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.50-2 "Alarm LSM Redundancy Status Command" Display parameters
Specific Information
name Type Description
board-station Parameter type: <Equipm::LtSlotIndex> physical number of the slot for
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> lsm redundancy alarms
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> ) This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
loss-lsmswp-cap Parameter type: <Alarm::SwoCap> current status specifing the
( loss switchover capability
| not-loss ) This element is only shown in
Possible values: detail mode.
- loss : system loss of the swichover capability
- not-loss : system not loss of the swichover capability
inv-xvps-pair-data Parameter type: <Alarm::DataXvps> log status of the data of xvps pair
( invalid This element is only shown in
| valid ) detail mode.
Possible values:
Command Description
This command displays the l2 forward related current alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.51-1 "Alarm L2 Forward Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.51-2 "Alarm L2 Forward Status Command" Display parameters
Specific Information
name Type Description
bridgeport Parameter type: <Vlan::BridgePort> identify the bridge port where the
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / alarm has occurred.
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> This element is only shown in
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / detail mode.
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Command Description
This command displays the external-device related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.52-1 "Alarm Current External Device Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.52-2 "Alarm Current External Device Status Command" Display parameters
Specific Information
name Type Description
loss-env-mon Parameter type: <Alarm::LossEnvMon> current status of env-monitor box
( lost This element is only shown in
| not-lost ) detail mode.
Possible values:
- lost : env-mon box lost or not alive
- not-lost : env-mon box exists
Command Description
This command displays the synce and bits current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.53-1 "Sync Clock Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 55.53-2 "Sync Clock Current Alarm Status Command" Display parameters
Only Show Details: slot information
name Type Description
slot Parameter type: <Alarm::SynceSlot> identifies the synce port where
( ntio-1 the alarm has occurred.
| ntio-2 This element is only shown in
| nt-a detail mode.
| nt-b
| nt
| not-used
| nt )
Possible values:
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot for bits
- nt : active nt slot
- not-used : no interface
port Parameter type: <Alarm::SyncePort> identifies the synce port where
( sfp : <Alarm::SynceClk> the alarm has occurred.
| xfp : <Alarm::SynceClk> This element is only shown in
Command Description
This command displays the voice plug-in unit current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.54-1 "Voice Plug-in Unit Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.54-2 "Voice Plug-in Unit Current Alarm Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Alarm::SlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
Command Description
This command displays lt cfm current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.55-1 "LT Cfm Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 55.55-2 "LT Cfm Current Alarm Status Command" Display parameters
Specific Information
name Type Description
cfm-mep-id Parameter type: <UnsignedSignedInteger> dot1agCfmMepIdentifier index
- an unsigned integer where the alarm has occurred.
This element is only shown in
detail mode.
cfm-unique-id Parameter type: <Alarm::IdentificationIdxOrZero> unique identification for the
- a signed integer alarm or zero when not
applicable, alarm entry is further
specified in additional-info
This element is only shown in
detail mode.
additional-info Parameter type: <PrintableString> Additional information regarding
- printable string the cfm alarm
This element is only shown in
detail mode.
Only Show Details: current alarm status
name Type Description
cfm-defrdiccm Parameter type: <Alarm::IacmCfmRdiCcm> specifies rdi bit in ccm received
( yes This element is only shown in
| no ) detail mode.
Command Description
This command displays the EFM-OAM current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.56-1 "EFM-OAM Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: current alarm index
- index of a current alarm entry
Command Output
Table 55.56-2 "EFM-OAM Current Alarm Status Command" Display parameters
Specific Information
name Type Description
last-updated-on Parameter type: <Sys::timeInSecs> network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs) the alarm was logged.
- unit: UTC This element is only shown in
detail mode.
line Parameter type: <Itf::EfmEthernetIndex> identifies the line where the
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / alarm has occurred.
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: current alarm status
name Type Description
link-fault Parameter type: <Alarm::linkFaultType> Link fault at cpe
( yes This element is only shown in
Command Description
This command displays the alarm-table current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.57-1 "Alarm Table Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.57-2 "Alarm Table Current Alarm Status Command" Display parameters
Specific Information
name Type Description
alrm-tbl-overflow Parameter type: <Alarm::AlrmTblOflow> identify if the alarm table has
( overflow overflowed
| no-overflow ) This element is only shown in
Possible values: detail mode.
- overflow : alarm table overflow
- no-overflow : no alarm table overflow
Command Description
This command displays the auto-switch current alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.58-1 "Auto-Switch Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 55.58-2 "Auto-Switch Current Alarm Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::XdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
auto-switch-status Parameter type: <Alarm::autoSwitchStatus> show auto-switch alarm status.
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : auto-switch alarm status
- no : auto-switch alarm status clear
Description
This chapter gives an overview of nodes that are handled by "Alarm Snap-shot Status Commands".
Command Tree
----show
----alarm
----snap-shot
----table
- (index)
----equipment
- (index)
----eqpt-holder
- (index)
----eqpt-holder-ext
- (index)
----plug-in-unit
- (index)
----atm
- (index)
----ether-itf
- (index)
----sw-mgmt
- (index)
----temporal
- (index)
----spatial
- (index)
----xdsl
- (index)
----xdsl-ext
- (index)
----xdsl-tca
- (index)
----vect-line
- (index)
----vect-board
- (index)
----eo-conversion
- (index)
----authentication
- (index)
----bonding-group
- (index)
----redundancy
- (index)
----custom
- (index)
----sfp
- (index)
----custom-ext-alarm
- (index)
----sfprssi
- (index)
----pppcc-engine-tca
- (index)
----sfpe1t1-clock
- (index)
----sfpe1t1-framer
- (index)
----plug-in-unit-ext
- (index)
----sip-server
- (index)
----sip-vsp
- (index)
----sip-dial-plan
- (index)
----sip-plugin-unit
- (index)
----sip-termination
- (index)
----megaco-media-gw
- (index)
----megaco-sig-gw
- (index)
----megaco-plug-unit
- (index)
----megaco-term
- (index)
----megaco-sig-lt
- (index)
----shdsl
- (index)
----shdsl-isam
- (index)
----ima-group
- (index)
----ima-link
- (index)
----ether-tca
- (index)
----ether-sfp
- (index)
----uplink-ether-sfp
- (index)
----nni-ether-sfp
- (index)
----qos-slot
- (index)
----qos-queue
- (index)
----filetransfer
- (index)
----lsmredundancy
- (index)
----l2forward
- (index)
----external-device
- (index)
----sync
- (index)
----voice-plugin-unit
- (index)
----cfm
- (index)
----efm-oam
- (index)
----alarm-table
- (index)
----auto-switch
- (index)
Command Description
This command displays the snapshot alarm entries.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.2-1 "Alarm Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.2-2 "Alarm Snapshot Status Command" Display parameters
Common Information:general information
name Type Description
timeout-period Parameter type: <IgnoredTimeTicks> specifies the time out of the
- a timeout value snapshot table
- unit: msec This element is always shown.
entries Parameter type: <IgnoredGauge> specifies nbr of entries in the
- gauge snapshot table.
This element is always shown.
indeterminate Parameter type: <Alarm::IndetSevState> active indeterminate severity
( active levels of the alarms in the
| not-active ) snapshot table.
Possible values: This element is always shown.
- active : at least one entry of this severity is present
- not-active : no entries of this severity
warning Parameter type: <Alarm::WarnSevState> active warning severity levels of
( active the alarms in the snapshot table.
| not-active ) This element is always shown.
Possible values:
- active : at least one entry of this severity is present
- not-active : no entries of this severity
minor Parameter type: <Alarm::MinorSevState> active minor severity levels of the
Command Description
This command displays the equipment snapshot.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.3-1 "Alarm Snapshot Equipment Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.3-2 "Alarm Snapshot Equipment Status Command" Display parameters
Specific Information
name Type Description
persist-data Parameter type: <Alarm::persistDataLoss> current status specifing persistant
( lost data is lost or not
| not-lost ) This element is only shown in
Possible values: detail mode.
- lost : persistant data is lost
- not-lost : persistant data is not lost
sntp-comm Parameter type: <Alarm::sntpCommLoss> current status of sntp
( lost communication is lost or not
| not-lost ) This element is only shown in
Possible values: detail mode.
- lost : SNTP communication lost
- not-lost : SNTP communication is not lost
cf-error Parameter type: <Alarm::cfError> Compact flash read or write error
( ( error | cfError ) occurred
| ( no-error | cfNoError ) ) This element is only shown in
Possible values: detail mode.
- error : CF access error
- cfError : CF access error
- no-error : CF no access error
Command Description
This command displays the snapshot equipment holder alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.4-1 "Equipment Holder Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.4-2 "Equipment Holder Alarm Log Status Command" Display parameters
Specific Information
name Type Description
shelf Parameter type: <Equipm::Shelf> specify which shelf the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> occurred on.
Field type <Eqpt::RackId> This element is only shown in
- the rack number detail mode.
Field type <Eqpt::ShelfId>
- the shelf number
rack-power Parameter type: <Alarm::rackPower> current status of rack power
( failing alarm, indicating fuse is broken
| ok ) or intact
Possible values: This element is only shown in
- failing : the fuse is broken detail mode.
- ok : the fuse is intact
fan-unit1 Parameter type: <Alarm::fanUnit1> current status of fan-unit1
( ( failing | fail ) This element is only shown in
| ok ) detail mode.
Possible values:
Command Description
This command displays the snapshot equipment holder extended alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.5-1 "Equipment Holder Alarm Extended Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.5-2 "Equipment Holder Alarm Extended Log Status Command" Display parameters
Specific Information
name Type Description
shelf Parameter type: <Equipm::Shelf> specify which shelf the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> occurred on.
Field type <Eqpt::RackId> This element is only shown in
- the rack number detail mode.
Field type <Eqpt::ShelfId>
- the shelf number
ctl-com-fail Parameter type: <Alarm::ctlComFail> status of shelf controller
( ( failing | fail ) communication failure.
| ok ) This element is only shown in
Possible values: detail mode.
- failing : shelf controller communication is failing
- fail : shelf controller communication is failing
- ok : shelf controller communication is ok
bat-a-fail Parameter type: <Alarm::batAFail> status of shelf power source A
( yes failure.
| no ) This element is only shown in
Command Description
This command displays the snapshot plug-in unit alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.6-1 "Plug-in Unit Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.6-2 "Plug-in Unit Alarm Log Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::EqptSlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
Command Description
This command displays the ATM alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.7-1 "ATM Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.7-2 "ATM Alarm Log Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Equipm::AtmIndex> identify where the alarm has
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred.
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
vpi-vci Parameter type: <Alarm::VpiVciValues> identify where the alarm has
- the vpi and vci value (vpi/vci) occurred.
This element is only shown in
detail mode.
cell-discard-up Parameter type: <Alarm::CellDiscardUpstream> specifies ATM cell is discarded
( discarded or not in upstream direction.
| no-discard ) This element is only shown in
Possible values: detail mode.
Command Description
This command displays the current Ethernet interface alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.8-1 "Alarm Snapshot Ethernet Interface Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.8-2 "Alarm Snapshot Ethernet Interface Status Command" Display parameters
Specific Information
name Type Description
ether-ifindex Parameter type: <Ether::InterfaceIndex> identify where the alarm has
- index of the collision interface occurred.
- range: [0...2147483647] This element is only shown in
detail mode.
Command Description
This command displays the snapshot software management status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.9-1 "Alarm Snapshot Software Management Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.9-2 "Alarm Snapshot Software Management Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::EqptSlotIndex> identifies the physical position of
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> the slot
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
Command Description
This command displays the temporal filter snapshot.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.10-1 "Alarm Snapshot Temporal Filter Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.10-2 "Alarm Snapshot Temporal Filter Status Command" Display parameters
Specific Information
name Type Description
tmp-filter1 Parameter type: <Alarm::alrmFilter1> current status of temporal filter1
( yes is derived or not
| no ) This element is only shown in
Possible values: detail mode.
- yes : derived filter1 alarm
- no : not derived filter1 alarm
tmp-filter2 Parameter type: <Alarm::alrmFilter2> current status of temporal filter2
( yes is derived or not
| no ) This element is only shown in
Possible values: detail mode.
- yes : derived filter2 alarm
- no : not derived filter2 alarm
tmp-filter3 Parameter type: <Alarm::alrmFilter3> current status of temporal filter3
( yes is derived or not
| no ) This element is only shown in
Possible values: detail mode.
Command Description
This command displays the spatial filter snapshot.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.11-1 "Alarm Snapshot Spatial Filter Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.11-2 "Alarm Snapshot Spatial Filter Status Command" Display parameters
Specific Information
name Type Description
spa-filter1 Parameter type: <Alarm::alrmFilter1> current status of spatial filter1 is
( yes derived or not
| no ) This element is only shown in
Possible values: detail mode.
- yes : derived filter1 alarm
- no : not derived filter1 alarm
spa-filter2 Parameter type: <Alarm::alrmFilter2> current status of spatial filter2 is
( yes derived or not
| no ) This element is only shown in
Possible values: detail mode.
- yes : derived filter2 alarm
- no : not derived filter2 alarm
spa-filter3 Parameter type: <Alarm::alrmFilter3> current status of spatial filter3 is
( yes derived or not
| no ) This element is only shown in
Possible values: detail mode.
Command Description
This command displays the status of the snapshot xDSL alarm.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.12-1 "Alarm xDSL Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.12-2 "Alarm xDSL Snapshot Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::XdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
near-end-los Parameter type: <Alarm::NearEndLOS> specifies near end loss of signal
( yes occured or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : near end loss of signal occurred
- no : no near end loss of signal
near-end-lof Parameter type: <Alarm::NearEndLOF> specifies near end loss of frame
( yes occured or not.
Command Description
This command displays the snap shot status for the extended xDSL alarm.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.13-1 "Alarm xDSL Extended Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.13-2 "Alarm xDSL Extended Snapshot Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::XdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
near-end-lor Parameter type: <Alarm::NearEndLOR> specifies if near end loss of
( yes robust management channel
| no ) occured or not.
Possible values: This element is only shown in
- yes : near end loss of robust management channel occurred detail mode.
Command Description
This command displays the xDSL threshold cross alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.14-1 "TCA xDSL Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.14-2 "TCA xDSL Alarm Log Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::XdslLine> identifies where the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
errored-secs Parameter type: <Alarm::ErroredSeconds> number of errored seconds
( above-thres exceeded or below threshold
| below-thres ) This element is only shown in
Possible values: detail mode.
- above-thres : number of errored seconds exceeded
threshold
- below-thres : number of errored seconds below threshold
es-in-a-day Parameter type: <Alarm::ErroredSecondsInAday> errored seconds in a day
Command Description
This command displays the status of the snapshot vectoring line alarm.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.15-1 "Alarm Vectoring Line Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the alarm snap shot table
- index of a current alarm entry
Command Output
Table 56.15-2 "Alarm Vectoring Line Snapshot Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::XdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port where the alarm has
<Eqpt::PortId> occurred.
Field type <Eqpt::RackId> This element is only shown in
- the rack number detail mode.
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
xtc-variation-vict Parameter type: <Alarm::VectXtcVariation> excessive : abnormal amplitude
( excessive variation in xtc coefficients
| normal ) This element is only shown in
Possible values: detail mode.
- excessive : abnormal amplitude variation in xtc
Command Description
This command displays the status of the snapshot vectoring board alarm.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.16-1 "Alarm Vectoring Board Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the alarm snap shot table
- index of a current alarm entry
Command Output
Table 56.16-2 "Alarm Vectoring Board Snapshot Status Command" Display parameters
Specific Information
name Type Description
board-index Parameter type: <Equipm::EqptVpSlotIndex> specifies where the alarm has
( ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> occurred.
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> ) This element is only shown in
Possible values: detail mode.
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
vp-link-index Parameter type: <Alarm::VectVpLinkIdx2> this is the vplink id, soft-link id
- specifies the soft-link or the vp-link on the vp-board, or or ltlink id seen from the board
zero identified by board-index.
- range: [0,1...8] This element is only shown in
detail mode.
Command Description
This command displays the electrical-to-optical conversion alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.17-1 "Alarm Electrical-to-Optical Conversion for Snapshot Status Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.17-2 "Alarm Electrical-to-Optical Conversion for Snapshot Status Command" Display
parameters
Specific Information
name Type Description
loss-of-signal Parameter type: <Alarm::EoConvLOS> specifies whether loss of signal
( yes detected or not in the EO
| no ) conversion module
Possible values: This element is only shown in
- yes : loss of signal detected in the EO conversion module detail mode.
- no : no loss of signal detected in the EO conversion
module
transmission Parameter type: <Alarm::EoConvTx> specifies whether transmission
( faulty fault is occurred or not in the EO
| ok ) module
Possible values: This element is only shown in
- faulty : transmission fault in the EO module detail mode.
- ok : transmission OK
Command Description
This command displays the status of authentication-related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.18-1 " Authentication Alarms for Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.18-2 " Authentication Alarms for Snapshot Status Command" Display parameters
Specific Information
name Type Description
vlan-assignment Parameter type: <Alarm::VLANassignment> specifies whether a VLAN for a
( failed user session is assigned or failed
| successful ) This element is only shown in
Possible values: detail mode.
- failed : failure to assign a VLAN for a user session
- successful : assigned a VLAN for a user session
Command Description
This command displays the alarms of the xDSL bonding snap shot.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.19-1 "Alarm xDSL Bonding Snap Shot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.19-2 "Alarm xDSL Bonding Snap Shot Status Command" Display parameters
Specific Information
name Type Description
group Parameter type: <Xdsl::BondingInterfaceIndex> identifies the bonding group
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / interface index
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
up-plan-bitrate Parameter type: <Alarm::UpPlannedBitrate> specifies whether the actual
( failure group upstream bit rate is above
| ok ) the group upstream planned bit
Possible values: rate or not
- failure : actual group bitrate is above the minimum This element is only shown in
Command Description
This command displays the redundancy snapshot-related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.20-1 "Alarm Redundancy Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.20-2 "Alarm Redundancy Snapshot Status Command" Display parameters
Specific Information
name Type Description
loss-over-cap Parameter type: <Alarm::SwoCap> identify the switchover capability
( loss in a redundant system.
| not-loss ) This element is only shown in
Possible values: detail mode.
- loss : system loss of the swichover capability
- not-loss : system not loss of the swichover capability
ping-check Parameter type: <Alarm::PingCheck> identify the ping check in a
( failure redundant system.
| successful ) This element is only shown in
Possible values: detail mode.
- failure : system failure of ping check
- successful : system successful of ping check
Command Description
This command displays custom snapshot-related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.21-1 "Alarm Custom Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.21-2 "Alarm Custom Snapshot Status Command" Display parameters
Specific Information
name Type Description
custom-alarm1 Parameter type: <Alarm::custom1> identify the customizableAlarm1
( yes .
| no ) This element is only shown in
Possible values: detail mode.
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
custom-alarm2 Parameter type: <Alarm::custom2> identify the customizableAlarm2
( yes .
| no ) This element is only shown in
Possible values: detail mode.
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
custom-alarm3 Parameter type: <Alarm::custom3> identify the customizableAlarm3
( yes .
| no ) This element is only shown in
Possible values: detail mode.
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
custom-alarm4 Parameter type: <Alarm::custom4> identify the customizableAlarm4
Command Description
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.22-1 "Alarm SFP Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.22-2 "Alarm SFP Snapshot Status Command" Display parameters
Specific Information
name Type Description
alarm index 1 Parameter type: <Alarm::SfpAlarmIdx1Type> this is the host sfp faceplate
( <Alarm::SfpAlarmIdx1> number for host alarms or it is the
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> ) equipment slot id for expansion
Possible values: shelf alarms
- lt : the lt-slot This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Alarm::SfpAlarmIdx1>
- the host port faceplate number or the equipment slot-id for
expansion shelf alarm
alarm index 2 Parameter type: <Alarm::SfpAlarmIdx2Type> this is the lanx port id for host
( <Alarm::SfpAlarmIdx2> alarms. this index is not used for
| nt : sfp : <Eqpt::PortIndex> expansion shelf alarms
| nt-a : sfp : <Alarm::SfpAlarmIdx2> This element is only shown in
| nt-a : xfp : <Alarm::SfpAlarmIdx2> detail mode.
Command Description
This command shows the customizable external alarm snap shot status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.23-1 "Alarm Custom External Snap Shot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.23-2 "Alarm Custom External Snap Shot Status Command" Display parameters
Specific Information
name Type Description
ext-alarm1 Parameter type: <Alarm::custExtAlarm1> current status specifying external
( yes alarm 1 is present or not
| no ) This element is always shown.
Possible values:
- yes : customizable external alarm 1
- no : no customizable external alarm 1
ext-alarm2 Parameter type: <Alarm::custExtAlarm2> current status specifying external
( yes alarm 2 is present or not
| no ) This element is always shown.
Possible values:
- yes : customizable external alarm 2
- no : no customizable external alarm 2
ext-alarm3 Parameter type: <Alarm::custExtAlarm3> current status specifying external
( yes alarm 3 is present or not
| no ) This element is always shown.
Possible values:
Command Description
This command displays the SFP RSSI snapshot-related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.24-1 "Alarm RSSI SFP Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snapshot table index
- index of a current alarm entry
Command Output
Table 56.24-2 "Alarm RSSI SFP Snapshot Status Command" Display parameters
Specific Information
name Type Description
alarm index 1 Parameter type: <Alarm::SlotIndex> this is the nt/ntio slot id for host
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> alarms.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
Command Description
This command displays the ppp cross-connect engine TCA snapshot-related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.25-1 "Alarm PPP Cross-Connect Engine TCA Snapshot Status Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: alarm snapshot table index
- index of a current alarm entry
Command Output
Table 56.25-2 "Alarm PPP Cross-Connect Engine TCA Snapshot Status Command" Display
parameters
Specific Information
name Type Description
engine Parameter type: <Vlan::StackedVlanSigned> this is the ppp-cc engine number
( <Vlan::UVlanIndex> This element is only shown in
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> ) detail mode.
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]
Command Description
This command displays the 2xE1/DS1 SFP Clock Snapshot-related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.26-1 "2xE1/DS1 SFP Clock Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 56.26-2 "2xE1/DS1 SFP Clock Snapshot Status Command" Display parameters
Specific Information
name Type Description
alarm index 1 Parameter type: <Alarm::SlotIndex> this is the nt/ntio slot id for host
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> alarms.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
Command Description
This command displays the 2xE1/DS1 SFP Framer snapshot-related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.27-1 "2xE1/DS1 SFP Framer Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 56.27-2 "2xE1/DS1 SFP Framer Snapshot Status Command" Display parameters
Specific Information
name Type Description
alarm index 1 Parameter type: <Alarm::SlotIndex> this is the nt/ntio slot id for host
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> alarms.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| lp : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
Command Description
This command shows the alarm snap shot status for the extended plug in unit.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.28-1 "Alarm Plug In Unit Extended Snap Shot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snapshot table index
- index of a current alarm entry
Command Output
Table 56.28-2 "Alarm Plug In Unit Extended Snap Shot Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::EqptSlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
Command Description
This command show the alarm snap-shot of SIP Server
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.29-1 "Alarm Snap-shot SIP Server Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 56.29-2 "Alarm Snap-shot SIP Server Status Command" Display parameters
Specific Information
name Type Description
transport-mismatch Parameter type: <Alarm::transportMismatch> specifies isamv and server
( yes transport mismatch or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : mismatch
- no : not mismatch
dns-lookup-failure Parameter type: <Alarm::dnsLookUpFailure> specifies dns look up fail or not.
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : fail
- no : not fail
Command Description
This command show the alarm snap-shot of SIP VSP
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.30-1 "Alarm Snap-shot SIP VSP Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 56.30-2 "Alarm Snap-shot SIP VSP Status Command" Display parameters
Specific Information
name Type Description
none-dns-srv Parameter type: <Alarm::noneDNSSRV> specifies none of dns server give
( yes reply to to DNS look up or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : none of dns server give reply to to DNS look up
- no : dns server give reply to to DNS look up
no-dns-srv Parameter type: <Alarm::noDNSSRV> specifies no dns server
( yes configured when sip request or
| no ) not.
Possible values: This element is only shown in
- yes : no dns server configured when sip request detail mode.
- no : dns server configured when sip request
none-srv Parameter type: <Alarm::noneSRV> specifies none sip server give
( yes reply when send sip request or
| no ) not.
Possible values: This element is only shown in
- yes : none sip server give reply when send sip request detail mode.
- no : sip server give reply when send sip request
no-srv Parameter type: <Alarm::noSRV> specifies no sip proxy server
Command Description
This command show the alarm snap-shot of SIP Dial Plan
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.31-1 "Alarm Snap-shot SIP Dial Plan Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 56.31-2 "Alarm Snap-shot SIP Dial Plan Status Command" Display parameters
Specific Information
name Type Description
bad-digitmap Parameter type: <Alarm::badDigitMap> sepcifies the sip digitmap usable
( yes or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : digit map unusable
- no : digit map usable
Command Description
This command show the alarm snap-shot of SIP Slot
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.32-1 "Alarm Snap-shot SIP Slot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 56.32-2 "Alarm Snap-shot SIP Slot Status Command" Display parameters
Specific Information
name Type Description
dhcp-unreach Parameter type: <Alarm::dhcpServerUnreach> specifies DHCP server status.
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : DHCP server unreachable
- no : DHCP server reachable
proxy-srv-unreach Parameter type: <Alarm::sipProxyServerUnreach> specifies sip proxy server status.
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : proxy server unreachable
- no : proxy server reachable
reg-srv-unreach Parameter type: <Alarm::sipRegistratorServerUnreach> specifies sip registrator server
( yes status.
| no ) This element is only shown in
Possible values: detail mode.
- yes : registrator server unreachable
- no : registrator server reachable
Command Description
This command show the alarm snap-shot of SIP termination
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.33-1 "Alarm Snap-shot SIP Termination Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 56.33-2 "Alarm Snap-shot SIP Termination Status Command" Display parameters
Specific Information
name Type Description
unknown-sub Parameter type: <Alarm::unknownSubscriber> specifies the sip subscriber
( yes unknown or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : wrong subscriber
- no : right subscriber
ground-key Parameter type: <Alarm::groundKey> status of the ground key.
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : current to ground
- no : current not to ground
port-hightemp Parameter type: <Alarm::highTemperature> status of the port temperature.
( yes This element is only shown in
| no ) detail mode.
Possible values:
Command Description
This command show the alarm snap-shot of Megaco media gateway.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.34-1 "Alarm Snap-shot Megaco Media Gateway Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 56.34-2 "Alarm Snap-shot Megaco Media Gateway Status Command" Display parameters
Specific Information
name Type Description
mgc-unreachable Parameter type: <Alarm::mgcUnreachable> specifies the media gateway
( yes controller is unreachable or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : media gateway controller is unreachable
- no : media gateway controller is reachable
failover-to-esamgc Parameter type: <Alarm::failovertoESAMGC> specifies the media gateway
( yes failover to esa mgc or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : failover to esa mgc
- no : normal mgc is in service
Command Description
This command show the alarm snap-shot of Megaco signaling gateway.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.35-1 "Alarm Snap-shot Megaco Signaling Gateway Status Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 56.35-2 "Alarm Snap-shot Megaco Signaling Gateway Status Command" Display parameters
Specific Information
name Type Description
sig-unreachable Parameter type: <Alarm::sgcUnreachable> specifies the signaling gateway
( yes controller is unreachable or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : signallling gateway controller is unreachable
- no : signallling gateway controller is reachable
Command Description
This command show the alarm snap-shot of Megaco plug unit.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.36-1 "Alarm Snap-shot Megaco Plug Unit Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 56.36-2 "Alarm Snap-shot Megaco Plug Unit Status Command" Display parameters
Specific Information
name Type Description
lcard-unreach-srvcard Parameter type: <Alarm::lineCardUnreachSrvCard> specifies the line card is
( yes unreachable with server card or
| no ) not.
Possible values: This element is only shown in
- yes : line card is unreachable with server card detail mode.
- no : line card is reachable with server card
lcard-type-mismatch Parameter type: <Alarm::lineCardTypeMismathch> specifies the line card type is
( yes mismatch or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : line card type is mismatch
- no : line card type is match
Command Description
This command show the alarm snap-shot of Megaco termination.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.37-1 "Alarm Snap-shot Megaco Termination Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 56.37-2 "Alarm Snap-shot Megaco Termination Status Command" Display parameters
Specific Information
name Type Description
meg-unknown-sub Parameter type: <Alarm::megacoUnknownSubscriber> specifies the megaco subscriber is
( yes unknown or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : unknown wrong megaco subscriber
- no : no wrong megaco subscriber
meg-ground-key Parameter type: <Alarm::voicePortGroundKey> specifies the voice port ground
( yes key or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : voice port ground key
- no : voice port not ground key
meg-high-temp Parameter type: <Alarm::voicePortHighTemp> specifies the voice port high
( yes temperature or not.
| no ) This element is only shown in
Possible values: detail mode.
Command Description
This command show the alarm snap-shot of Megaco signaling lt.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.38-1 "Alarm Snap-shot Megaco Signaling Lt Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 56.38-2 "Alarm Snap-shot Megaco Signaling Lt Status Command" Display parameters
Specific Information
name Type Description
sig-brd-persist-loss Parameter type: <Alarm::megacoSigBoardPersDataLoss> specifies the voice signaling
( yes board persistenet data loss or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : the voice signaling board persistenet data loss
- no : the voice signaling board persistenet data not loss
sig-brd-disk-full Parameter type: <Alarm::voiceSigBoard90PercentFull> specifies the voice signaling
( yes board disk 90% full or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : specifies the voice signaling board disk 90% full
- no : specifies the voice signaling board disk no 90% full
sig-brd-db-rollback Parameter type: <Alarm::sigBoardDBRollback> specifies he voice signaling board
( yes implicit db rollback or not.
| no ) This element is only shown in
Possible values: detail mode.
Command Description
This command show the alarm snap-shot of Shdsl
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.39-1 "Alarm Snap-shot Shdsl Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.39-2 "Alarm Snap-shot Shdsl Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::ShdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
unit Parameter type: <Alarm::LinkDeviceValues> identify where the alarm has
- a signed integer occurred
This element is only shown in
detail mode.
loop-act-net Parameter type: <Alarm::LoopbackActiveNetwork> snap shot of loopback active at
( yes the network side
| no ) This element is only shown in
Possible values: detail mode.
Command Description
This command show the alarm snap-shot of Shdsl
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.40-1 "Alarm Snap-shot Shdsl Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.40-2 "Alarm Snap-shot Shdsl Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::ShdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
wire-pair Parameter type: <Alarm::LinkDeviceValuesHigh> identify where the alarm has
- identify where the alarm occurred occurred
This element is only shown in
detail mode.
unit Parameter type: <Alarm::LinkDeviceValuesLow> identify where the alarm has
- identify where the alarm occurred occurred
This element is only shown in
detail mode.
Command Description
This command show the alarm snap-shot of Ima-Group
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.41-1 "Alarm Snap-shot Ima-Group Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.41-2 "Alarm Snap-shot Ima-Group Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Equipm::AtmImaIndex> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
far-end-start Parameter type: <Alarm::FarEndStartup> snap shot of far-end starting up
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : far-end startup
Command Description
This command show the alarm snap-shot of Ima-Link
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.42-1 "Alarm Snap-shot Ima-Link Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.42-2 "Alarm Snap-shot Ima-Link Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::ShdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
loss-ima-frm Parameter type: <Alarm::LossImaFrame> snap shot of loss of ima frame
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : loss ima frame
- no : no loss ima frame
lods Parameter type: <Alarm::LinkOutofDelaySynch> snap shot of link out of delay
( yes synchronization
Command Description
This command show the alarm snap-shot of Ether-Tca
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.43-1 "Alarm Snap-shot Ether-Tca Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.43-2 "Alarm Snap-shot Ether-Tca Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::EthernetPortIndex> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
etca-los Parameter type: <Alarm::EthTcaLos> snap shot of ethernet los in 15
( yes min
| no ) This element is only shown in
Possible values: detail mode.
- yes : ethernet loss of signal errors exceeds
- no : ethernet loss of signal errors normal
etca-fcs Parameter type: <Alarm::EthTcaFcs> snap shot of ethernet fcs in 15
( yes min
Command Description
This command show the alarm snap-shot of Ether-Sfp
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.44-1 "Alarm Snap-shot Ether-Sfp Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.44-2 "Alarm Snap-shot Ether-Sfp Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::EthernetPortIndex> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
sfp-los Parameter type: <Alarm::EthSfpLos> snap shot of ethernet sfp los
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : ethernet sfp los error
- no : ethernet sfp los normal
sfp-tx-fail Parameter type: <Alarm::EthSfpTxFail> snap shot of ethernet sfp tx
( yes This element is only shown in
Command Description
This command show the alarm snap-shot of Ether-Sfp
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.45-1 "Alarm Snap-shot Ether-Sfp Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.45-2 "Alarm Snap-shot Ether-Sfp Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::EthernetPortIndex> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
uplink-sfp-los Parameter type: <Alarm::EthSfpLos> snap shot of uplink ethernet sfp
( yes los
| no ) This element is only shown in
Possible values: detail mode.
- yes : ethernet sfp los error
- no : ethernet sfp los normal
uplink-sfp-tx-fail Parameter type: <Alarm::EthSfpTxFail> snap shot of uplink ethernet sfp tx
( yes This element is only shown in
Command Description
This command show the alarm snap-shot of Ether-Sfp
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.46-1 "Alarm Snap-shot Ether-Sfp Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.46-2 "Alarm Snap-shot Ether-Sfp Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::EthernetPortIndex> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
nni-sfp-los Parameter type: <Alarm::EthSfpLos> snap shot of nni ethernet sfp los
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : ethernet sfp los error
- no : ethernet sfp los normal
nni-sfp-tx-fail Parameter type: <Alarm::EthSfpTxFail> snap shot of nni ethernet sfp tx
( yes This element is only shown in
Command Description
This command show the alarm snap-shot of Qos Slot
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.47-1 "Alarm Snap-shot SIP Termination Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snapshot table index
- index of a current alarm entry
Command Output
Table 56.47-2 "Alarm Snap-shot SIP Termination Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::EqptSlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is always shown.
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
Command Description
This command show the alarm snap-shot of Qos Queue
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.48-1 "Alarm Snap-shot SIP Termination Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snapshot table index
- index of a current alarm entry
Command Output
Table 56.48-2 "Alarm Snap-shot SIP Termination Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::PhyLine> identifies the physical position of
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is always shown.
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> )
Possible values:
- ont : ont
Field type <Eqpt::RackId>
- the rack number
Command Description
This command displays the snap-shot of file transfer server alarm
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.49-1 "Alarm File Transfer Server Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.49-2 "Alarm File Transfer Server Status Command" Display parameters
Specific Information
name Type Description
server-id Parameter type: <Alarm::FileTransfer> identify where the alarm has
- next hop IP address occurred.
This element is only shown in
detail mode.
fileserv-unavail Parameter type: <Alarm::FileTransferUnavial> current status specifing that
( unavailable whether file transfer server
| available ) available
Possible values: This element is only shown in
- unavailable : file transfer Server unavailable or file transfer detail mode.
failed
- available : file transfer server available
Command Description
This command displays the snap-shot of Lsm Redundancy alarm
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.50-1 "Alarm Lsm Redundancy Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.50-2 "Alarm Lsm Redundancy Status Command" Display parameters
Specific Information
name Type Description
board-station Parameter type: <Equipm::LtSlotIndex> physical number of the slot for
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> lsm redundancy alarms
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> ) This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
loss-lsmswp-cap Parameter type: <Alarm::SwoCap> snapshot of the switchover
( loss capability in a redundant system
| not-loss ) This element is only shown in
Possible values: detail mode.
- loss : system loss of the swichover capability
- not-loss : system not loss of the swichover capability
inv-xvps-pair-data Parameter type: <Alarm::DataXvps> log status of the data of xvps pair
( invalid This element is only shown in
| valid ) detail mode.
Possible values:
Command Description
This command displays the snap-shot of l2 forward alarm
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.51-1 "Alarm L2 Forward Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.51-2 "Alarm L2 Forward Status Command" Display parameters
Specific Information
name Type Description
bridgeport Parameter type: <Vlan::BridgePort> identify the bridge port where the
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / alarm has occurred.
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> This element is only shown in
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / detail mode.
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Command Description
This command show the alarm snap-shot of external-device
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.52-1 "Alarm Snap-shot External Device Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.52-2 "Alarm Snap-shot External Device Status Command" Display parameters
Specific Information
name Type Description
loss-env-mon Parameter type: <Alarm::LossEnvMon> snap shot status of env-monitor
( lost box
| not-lost ) This element is only shown in
Possible values: detail mode.
- lost : env-mon box lost or not alive
- not-lost : env-mon box exists
Command Description
This command displays the synce and bits snapShot alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.53-1 "Sync Clock Alarm SnapShot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm log table index
- index of a current alarm entry
Command Output
Table 56.53-2 "Sync Clock Alarm SnapShot Status Command" Display parameters
Only Show Details: slot information
name Type Description
slot Parameter type: <Alarm::SynceSlot> identifies the synce port where
( ntio-1 the alarm has occurred.
| ntio-2 This element is only shown in
| nt-a detail mode.
| nt-b
| nt
| not-used
| nt )
Possible values:
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot for bits
- nt : active nt slot
- not-used : no interface
Command Description
This command displays the snapshot voice plug-in unit alarm log status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.54-1 "Voice Plug-in Unit Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.54-2 "Voice Plug-in Unit Alarm Log Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::EqptSlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is only shown in
| nt-b detail mode.
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
Command Description
This command displays the SnapShot lt cfm alarm status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.55-1 "LT CFM Alarm SnapShot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: cfm log table index
- index of a current alarm entry
Command Output
Table 56.55-2 "LT CFM Alarm SnapShot Status Command" Display parameters
Specific Information
name Type Description
cfm-mep-id Parameter type: <UnsignedSignedInteger> dot1agCfmMepIdentifier index
- an unsigned integer where the alarm has occurred.
This element is only shown in
detail mode.
cfm-unique-id Parameter type: <Alarm::IdentificationIdxOrZero> unique identification for the
- a signed integer alarm or zero when not
applicable, alarm entry is further
specified in additional-info
This element is only shown in
detail mode.
additional-info Parameter type: <PrintableString> Additional information regarding
- printable string the cfm alarm
This element is only shown in
detail mode.
Only Show Details: alarm snap-shot status
name Type Description
cfm-defrdiccm Parameter type: <Alarm::IacmCfmRdiCcm> specifies rdi bit in ccm received
( yes This element is only shown in
| no ) detail mode.
Command Description
This command shows the snap-shot of EFM-OAM alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.56-1 "EFM-OAM alarm Snap-shot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: current alarm index
- index of a current alarm entry
Command Output
Table 56.56-2 "EFM-OAM alarm Snap-shot Status Command" Display parameters
Specific Information
name Type Description
line Parameter type: <Itf::EfmEthernetIndex> identifies the line where the
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / alarm has occurred.
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Only Show Details: snap-shot alarm status
name Type Description
link-fault Parameter type: <Alarm::linkFaultType> Link fault at cpe
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : link fault at cpe/onu
- no : link fault is not exist
Command Description
This command displays the alarm-table snapshot-related alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.57-1 "Alarm Table Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.57-2 "Alarm Table Snapshot Status Command" Display parameters
Specific Information
name Type Description
alrm-tbl-overflow Parameter type: <Alarm::AlrmTblOflow> identify if the alarm table has
( overflow overflowed
| no-overflow ) This element is only shown in
Possible values: detail mode.
- overflow : alarm table overflow
- no-overflow : no alarm table overflow
Command Description
This command displays the status of the snapshot of auto-switch alarm.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.58-1 "Auto-Switch Alarm Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 56.58-2 "Auto-Switch Alarm Snapshot Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::XdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is only shown in
Field type <Eqpt::RackId> detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
auto-switch-status Parameter type: <Alarm::autoSwitchStatus> show auto-switch alarm status.
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : auto-switch alarm status
Description
This chapter gives an overview of nodes that are handled by "Alarm Delta Log Status Commands".
Command Tree
----show
----alarm
----delta-log
----alarm-changes
----indeterminate
- (index)
----warning
- (index)
----minor
- (index)
----major
- (index)
----critical
- (index)
Command Description
This command displays the number of reported alarm changes per severity level and in total.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 57.2-2 "Alarm Generic Delta Alarm Log Status Command" Display parameters
Specific Information
name Type Description
all Parameter type: <Counter> total number of changes of all
- 32 bit counter reported alarms since startup and
is independent of the alarm
severity level.
This element is always shown.
indeterminate Parameter type: <Counter> total number of changes of all
- 32 bit counter reported alarms with a severity
level indeterminate since startup.
This element is always shown.
warning Parameter type: <Counter> total number of changes of all
- 32 bit counter reported alarms with a severity
level warning since startup.
This element is always shown.
minor Parameter type: <Counter> total number of changes of all
- 32 bit counter reported alarms with a severity
level minor since startup.
This element is always shown.
major Parameter type: <Counter> total number of changes of all
- 32 bit counter reported alarms with a severity
level major since startup.
This element is always shown.
critical Parameter type: <Counter> total number of changes of all
- 32 bit counter reported alarms with a severity
level critical since startup.
This element is always shown.
Command Description
This command displays alarm values for all reported alarms with a severity level indeterminate.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.3-1 "Indeterminate Alarm Delta Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: delta log alarm table index
- index of a current alarm entry
Command Output
Table 57.3-2 "Indeterminate Alarm Delta Log Status Command" Display parameters
Specific Information
name Type Description
type Parameter type: <Alarm::alarmIndex> unique id for an alarm.
( xtca-ne-es This element is always shown.
| xtca-ne-ses
| xtca-ne-uas
| xtca-ne-day-es
| xtca-ne-day-ses
| xtca-ne-day-uas
| xtca-fe-es
| xtca-fe-ses
| xtca-fe-uas
| xtca-fe-day-es
| xtca-fe-day-ses
| xtca-fe-day-uas
| xtca-leftrs
| xtca-day-leftrs
| xtca-fe-leftrs
Command Description
This command displays alarm values for all reported alarms with a severity level warning.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.4-1 "Warning Alarm Delta Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: delta log alarm table index
- index of a current alarm entry
Command Output
Table 57.4-2 "Warning Alarm Delta Log Status Command" Display parameters
Specific Information
name Type Description
type Parameter type: <Alarm::alarmIndex> unique id for an alarm.
( xtca-ne-es This element is always shown.
| xtca-ne-ses
| xtca-ne-uas
| xtca-ne-day-es
| xtca-ne-day-ses
| xtca-ne-day-uas
| xtca-fe-es
| xtca-fe-ses
| xtca-fe-uas
| xtca-fe-day-es
| xtca-fe-day-ses
| xtca-fe-day-uas
| xtca-leftrs
| xtca-day-leftrs
| xtca-fe-leftrs
| xtca-fe-day-leftrs
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom
Command Description
This command displays alarm values for all reported alarms with a severity level minor.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.5-1 "Minor Alarm Delta Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: delta log alarm table index
- index of a current alarm entry
Command Output
Table 57.5-2 "Minor Alarm Delta Log Status Command" Display parameters
Specific Information
name Type Description
type Parameter type: <Alarm::alarmIndex> unique id for an alarm.
( xtca-ne-es This element is always shown.
| xtca-ne-ses
| xtca-ne-uas
| xtca-ne-day-es
| xtca-ne-day-ses
| xtca-ne-day-uas
| xtca-fe-es
| xtca-fe-ses
| xtca-fe-uas
| xtca-fe-day-es
| xtca-fe-day-ses
| xtca-fe-day-uas
| xtca-leftrs
| xtca-day-leftrs
| xtca-fe-leftrs
| xtca-fe-day-leftrs
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom
Command Description
This command displays alarm values for all reported alarms with a severity level major.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.6-1 "Major Alarm Delta Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: delta log alarm table index
- index of a current alarm entry
Command Output
Table 57.6-2 "Major Alarm Delta Log Status Command" Display parameters
Specific Information
name Type Description
type Parameter type: <Alarm::alarmIndex> unique id for an alarm.
( xtca-ne-es This element is always shown.
| xtca-ne-ses
| xtca-ne-uas
| xtca-ne-day-es
| xtca-ne-day-ses
| xtca-ne-day-uas
| xtca-fe-es
| xtca-fe-ses
| xtca-fe-uas
| xtca-fe-day-es
| xtca-fe-day-ses
| xtca-fe-day-uas
| xtca-leftrs
| xtca-day-leftrs
| xtca-fe-leftrs
| xtca-fe-day-leftrs
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom
Command Description
This command displays alarm values for all reported alarms with a severity level critical.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.7-1 "Critical Alarm Delta Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: delta log alarm table index
- index of a current alarm entry
Command Output
Table 57.7-2 "Critical Alarm Delta Log Status Command" Display parameters
Specific Information
name Type Description
type Parameter type: <Alarm::alarmIndex> unique id for an alarm.
( xtca-ne-es This element is always shown.
| xtca-ne-ses
| xtca-ne-uas
| xtca-ne-day-es
| xtca-ne-day-ses
| xtca-ne-day-uas
| xtca-fe-es
| xtca-fe-ses
| xtca-fe-uas
| xtca-fe-day-es
| xtca-fe-day-ses
| xtca-fe-day-uas
| xtca-leftrs
| xtca-day-leftrs
| xtca-fe-leftrs
| xtca-fe-day-leftrs
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom
Description
This chapter gives an overview of nodes that are handled by "SHub Alarm Status Command".
Command Tree
----show
----alarm
----shub
----snap-shot
----table
- (index)
----shub-gen
- (index)
----eth-shub
- (index)
----rip
- (index)
----ospf
- (index)
----uplink-group
- (index)
----forwarding
- (index)
----global-rip
- (index)
----global-ospf
- (index)
----global-fwd
- (index)
----nbr-changed-alarms
Command Description
This command displays the SHub snapshot table.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 58.2-1 "SHub Alarm Snapshot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 58.2-2 "SHub Alarm Snapshot Status Command" Display parameters
Common Information:common
name Type Description
timeout-period Parameter type: <IgnoredTimeTicks> specifies the time out of the
- a timeout value snapshot table
- unit: msec This element is always shown.
entries Parameter type: <IgnoredGauge> specifies nbr of entries inthe
- gauge snapshot table, when table status
is in-use.
This element is always shown.
owner-id Parameter type: <Alarm::alarmSnapShotOwner> the actual owner of the snap-shot
- string to identify the owner (example: Tom),the string This element is always shown.
should has less than or equal to 128 characters
Specific Information
name Type Description
type Parameter type: <Alarm::ShubAlarmType> specifies the type of the alarm
( shub-gen This element is always shown.
| eth-shub
| ospf
| rip
| ip
| uplink-group
Command Description
This command displays the log generated for equipment-related persistent-data (data that is stored on the system
data disk and that survives power failures and system resets), sntp-communication, nt-disk, and communication
alarms. The log also gives the previous status of the alarms.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 58.3-1 "SHub Alarm Equipment Snap-shot Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 58.3-2 "SHub Alarm Equipment Snap-shot Status Command" Display parameters
Specific Information
name Type Description
db-restore Parameter type: <Alarm::ShubDBrestore> specifies whether the DB restore
( failed is successful or not.
| successful ) This element is only shown in
Possible values: detail mode.
- failed : DB restore falied
- successful : DB restore successful
emergency-reboot Parameter type: <Alarm::ShubEmergencyRebbot> status of shub reboot from
( yes emergency boot package
| no ) This element is only shown in
Possible values: detail mode.
- yes : shub has rebooted from emergency boot package
- no : no shub reboot
sntp-comm Parameter type: <Alarm::ShubSNTPcommLoss> status of shub - SNTP server
( lost communication