Professional Documents
Culture Documents
Alcatel-Lucent 7330
INTELLIGENT SERVICES ACCESS MANAGER FIBER TO THE NODE
RELEASE 3.3.X | FEATURE GROUP 3.4
CLI COMMANDS
3HH-04416-CDAA-TCZZA Edition 03
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.
Contents
1- ISAM CLI 1
1.1 History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.2 Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
1.3 CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
1.4 Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
1.5 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
1.6 Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
1.7 Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.8 Getting help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
1.9 The CLI Prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
1.10 Entering CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
1.11 CLI Backward Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
10.16 SHub System UDP Filter Out Port List Configuration Command . . . . . . . . . . . . . . 198
10.17 SHub System Other Protocol Filter Configuration Command . . . . . . . . . . . . . . . . 199
10.18 SHub System Other Protocol Filter Configuration Command . . . . . . . . . . . . . . . . 202
10.19 SHub System VLAN Filter Configuration Command . . . . . . . . . . . . . . . . . . . . . 205
10.20 SHub System IP Group Configuration Command . . . . . . . . . . . . . . . . . . . . . . 206
10.21 SHub System ID Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 207
10.22 SHub System VLAN Group Configuration Command . . . . . . . . . . . . . . . . . . . . 208
10.23 SHub System HTTP Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 209
10.24 System Clock Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Abbreviations 1882
Index 1883
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 R2.4 and R2.2.03, review the delta's of the releases R2.4
versus R2.3.02 and R2.3.02 versus R2.2.03. To know the difference between e.g. FGN 3.0.02 and FGN 3.0, review
the delta's of FGN 3.0.02 and all tables referencing FGN 3.0.
New Commands
admin igmp shub cac clear-stats
admin igmp shub vlan clear-stats
admin ip vlan-itf-delete
admin mstp port(mstp feature)
configure debug protocol-trace(protocol tracing feature)
configure equipment envbox(environment monitoring feature)
configure equipment external-link-assign
configure ethernet line(ethernet LT feature)
configure igmp vlan(multi-vlan feature)
configure igmp shub vlan-enhance-perf(multi-vlan feature)
configure igmp system cdr-type(syslog video cdr feature)
configure interface shub ip unnumbered-as(mgmt via loop-back itf
feature)
configure mstp(all cmds in this node)(mstp feature)
configure qos interface eth-itf(ethernet LT feature)
configure software-mngt database(database automatic activation and
backup feature)
configure system security filetransfer(ftp for backup-restore and sw
download)
configure voice sip termination local-loop(VoIP-SIP feature)
configure xdsl spectrum-profile artificial-noise-down(xdsl artificial
noise feature)
ping vrf(ping per VRF feature)
Removed Commands
admin bridge rstp port(replaced by mstp cmd)
admin igmp shub clear-stats(replaced by admin igmp shub cac
clear-stats)
configure rstp(replaced by mstp cmds)
configure voice sip local-loop(replaced by configure voice sip
termination local-loop)
show alarm current sip-app-server(not applicable anymore)
show alarm log sip-app-server(not applicable anymore)
show alarm snap-shot sip-app-server(not applicable anymore)
show rstp(replaced by mstp cmds)
Modified Commands
admin alarm
admin equipment
admin equipment slot
admin ip vrf-media
admin shdsl-seg
configure alarm entry
configure cpe-management vlan-id proxy-mode
configure dhcp-relay agent
configure equipment shelf
configure equipment slot
configure mcast src (IGMP CAC for GE port,garanteed LT part)
configure mcast shub active-streams (IGMP CAC feature)
configure qos profiles session logical-flow-type
configure software-mngt oswp(autofetch obsolete parameter)
configure system id(feature config port nbr in protocol)
configure system security profile(numbering scheme feature)
configure system security default-profile(numbering scheme feature)
configure system security ssh access
configure system sntp(timezone feature)
configure trap definition
configure trap manager
configure vlan id (programmable ciruit-id dhcp,pppoe)
configure vlan shub unicast-mac
configure interface alarm
configure shdsl span
configure shdsl segment
configure shdsl unit
configure xdsl service profile(L2-L3 power modes)
configure xdsl spectrum profile(SRA fct added)
configure xdsl spectrum profile adsl2-plus((PSD functionality)
configure xdsl spectrum profile vdsl((PSD functionality)
configure xdsl spectrum profile vdsl2((PSD functionality)
configure xdsl line service-profile spectrum-profile
configure xdsl-bonding group-profile
environment
show atm pvc
New Commands
admin igmp shub bundle(IGMP CAC feature)
admin igmp shub clear-stats
admin igmp shub mcast-src vlan-id(IGMP CAC feature)
admin session id disconnect
admin system syslog
admin system security ssh generate-key(see removed command
configure system security ssh key-regen)
configure alarm custom-profile(REM feature)
configure bridge shub mac-learning
configure cpe-management manager
configure igmp shub bundle
configure mcast shub src vlan-id
configure qos-dsl-ctrl-pkt-policer
configure system id-syntax(atm/eth based id)
configure system syslog(security system log feature)
configure xdsl spectrum-profile adsl2-plus cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl cust-rx-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-rx-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 v-noise-psd-pt-down(PSD fct)
Removed Commands
admin ip traceroute(replaced by traceroute)
configure cpeproxy proxy-mode(replaced by configure
cpe-management proxy-mode)
configure system security ssh key-regen(replaced by admin system
security ssh generate-key) not backward compatible
show alarm entry(redundant with info configure alarm entry)
show alarm shub entry(redundant with info configure alarm shub
entry)
show cpeproxy
show ip traceroute(replaced by traceroute)
show alarm snap-shot plugin-unit-ext(replaced by show alarm
snap-shot plug-in-unit-ext)
configure system management vlan host-ip-address
New Commands
admin igmp shub bundle(IGMP CAC feature)
admin igmp shub clear-stats
admin igmp shub mcast-src vlan-id(IGMP CAC feature)
admin ip vrf-stats interface user bridgeport
admin shdsl-seg unit-id
admin session id disconnect
admin system syslog
admin system security ssh generate-key
configure alarm custom-profile(REM feature)
configure bridge shub mac-learning
configure cpe-management vlan-id proxy-mode
configure cpe-management manager
configure cpe-management session
configure cpe-management shub
configure igmp shub bundle
configure mcast shub src vlan-id
configure qos-dsl-ctrl-pkt-policer
configure qos shdsl-port
configure system id-syntax(atm/eth based id)
configure system syslog(security system log feature)
configure xdsl spectrum-profile adsl2-plus cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl cust-rx-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-rx-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 v-noise-psd-pt-down(PSD fct)
Removed Commands
admin ip traceroute(replaced by traceroute)
configure cpeproxy proxy-mode
configure system security ssh key-regen(replaced by admin system
security ssh generate-key) not backward compatible
show cpeproxy
show ip traceroute(replaced by traceroute)
configure system management vlan host-ip-address
show tech-support
configure ima
configure voice sip
show shdsl
show ima
show alarm current ima-group
show alarm current ima-link
show alarm current shdsl
show alarm current shdsl-isam
show alarm current custom-ext-alarm
show alarm current sip-app-server
show alarm current sip-plugin-unit
show alarm current sip-termination
show alarm current sip-user-agent
show alarm log ima-group
show alarm log ima-link
show alarm log shdsl
show alarm log shdsl-isam
show alarm log sip-app-server
show alarm log sip-plugin-unit
show alarm log sip-termination
show alarm log sip-user-agent
show alarm snap-shot ima-group
show alarm snap-shot ima-link
show alarm snap-shot shdsl
show alarm snap-shot shdsl-isam
show alarm snap-shot sip-app-server
show alarm snap-shot sip-plugin-unit
show alarm snap-shot sip-termination
show alarm snap-shot sip-user-agent
show ima
show shdsl
show voice
New Commands
admin igmp shub bundle(IGMP CAC feature)
admin igmp shub clear-stats
admin igmp shub mcast-src vlan-id(IGMP CAC feature)
admin ip vrf-stats interface user bridgeport
admin shdsl-seg unit-id
admin session id disconnect
admin system syslog
admin system security ssh generate-key
configure alarm custom-profile(REM feature)
configure bridge shub mac-learning
configure cpe-management vlan-id proxy-mode
configure cpe-management manager
configure cpe-management session
configure cpe-management shub
configure igmp shub bundle
configure l2cp
configure mcast shub src vlan-id
Removed Commands
admin ip traceroute(replaced by traceroute)
configure cpeproxy proxy-mode
configure system security ssh key-regen(replaced by admin system
security ssh generate-key) not backward compatible
show alarm entry
show alarm shub entry
show cpeproxy
show ip traceroute(replaced by traceroute)
show tech-support
New Commands
admin ip vrf-stats interface user bridgeport
admin shdsl-seg
configure cpe-management
configure cpe-management shub
configure ima
configure qos shdsl-port
configure shdsl segment
configure shdsl span
configure shdsl unit
show alarm current ima-group
show alarm current ima-link
show alarm current plugin-unit-ext
show alarm current shdsl
show alarm current shdsl-isam
show alarm log ima-group
show alarm log ima-link
show alarm log plugin-unit-ext
show alarm log shdsl
show alarm log shdsl-isam
show alarm snap-shot ima-group
show alarm snap-shot ima-link
show alarm snap-shot plugin-unit-ext
show alarm snap-shot shdsl
show alarm snap-shot shdsl-isam
show cpe-management
show cpe-management ipproxy-statistic
show equipment capab-profile
show ima group
show ima group counters
show ima group state
show ima link
show ima link counters
show ima link state
show qos shdsl-bandwidth
show shdsl
show shdsl inventory
show shdsl segment-counters
show shdsl segment-status
Deleted Commands
show tech-support
Command delta R2.4.11 (FGN 3.0.02) versus R2.4 (FGN 3.0) and
Command delta R2.4.11 (FGN 3.0.02) versus R2.4.10 (FGN3.0.01)
Modified Commands
configure system shub entry ip
configure system shub filter ip-filter port-filter
configure system shub filter ip-filter icmp
configure system shub filter ip-filter tcp
configure system shub filter ip-filter udp
configure xdsl spectrum-profile vdsl
configure xdsl spectrum-profile vdsl2
New Commands
configure ospf area extern-aggr-addr
configure l2cp
show l2cp
configure system management vlan
show dhcp-relay bridgeport
show interface shub statistics
show xdsl link-up-changes
show xdsl linkup-record
show vlan qos-cvlan-list
Deleted Commands
show alarm entry
show alarm entry shub
environment
New Commands
configure system clock-mgmt
configure system security default-profile
configure system security notify-profile filter
configure system security snmp view
configure system security snmp notify-view
show igmp package-to-src
show mcast active-groups
show system clock-mgmt
show tech-support
Deleted Commands
show vlan qos-cvlan-list
show dhcp-relay bridgeport
configure vlan
configure vlan shub
configure xdsl service-profile
configure xdsl spectrum-profile
configure xdsl line
environment
show mcast shub igs-vlan-grp
show security radius
show vlan fdb
New Commands
configure cluster
configure equipment external-link-host
configure mcast shub
configure cluster
configure qos shub dscp-map-dot1p
configure system security ssh
configure xdsl line (if-index) local-loop
show alarm current llu-relay
show alarm current sfp
show alarm log llu-relay
show alarm log sfp
show alarm snap-shot llu-relay
show alarm snap-shot sfp
show cluster
show dhcp-relay bridgeport
show equipment external-link-host
show equipment external-link-remote
show mcast shub active-streams
show qos profile-usage
show security ssh
show tranport snmp engine
show tranport snmp protocol-stats
show vlan shub-nr-mcast-entries
Deleted Commands
configure ip interface
configure system shub entry software
1.2 Preface
Scope
This user guide describes the Command Line Interface (CLI) commands supported by the Alcatel 7302 ISAM and
7330 ISAM FTTN. These commands are used for installation, configuration, management and troubleshooting.
User Profile
The guide is intended for operating personnel (sometimes called craft persons).
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.
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).
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)
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 cross #, a space, a tab, a carriage return, or a new line. The \ is 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:
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]
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.
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.
1.6 Filters
The language provides filters to manipulate the output of commands.
The available filters are discussed in detail in a separate chapter.
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.
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.
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.
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
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).
%! : 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 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
| timeout : <Sec::InactivityTimeout> ) the terminal
Possible values:
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
- [no] visible4
- [no] audible4
- [no] polarity4
- [no] severity4
- [no] mnemonic5
- [no] description5
- [no] visible5
- [no] audible5
- [no] polarity5
- [no] severity5
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::alarmSeverity> 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::alarmSeverity> optional parameter
Format: set minimum severity level to
( indeterminate report non itf alarms
| warning
| minor
| major
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
| 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-fe-los
| xdsl-fe-lof
| xdsl-fe-lpr
| xdsl-fe-lol
| xdsl-fe-lom
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
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: action in case indeterminate 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
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
( fan
| power-fan
| db-restore
| reboot
| sntp-comm
| eth-link-down
| mac-conflict
| no-arp-reply
| ospf-itf-err
| ospf-auth-err
| ospf-rx-bad-err
| ospf-lsdb-oflow-90
| ospf-lsdb-oflow
| ospf-nhbr-statchg
| ospf-itf-statchg
| rip-config-err
| rip-auth-fail
| rip-rcv-bad-pkt
| uplink-down )
Possible values:
- fan : shub fan failure
- power-fan : shub power fan failure
- db-restore : shub DB restore
- reboot : shub reboot from emergency boot package
- sntp-comm : shub SNTP communication
- eth-link-down : shub ethernet link down status
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
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.
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
- range: [a-zA-Z0-9-_.]
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] init-started-trap
- [no] lic-key-chg-occr
- [no] topology-chg
- [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] max-per-window
- [no] window-size
- [no] max-queue-size
- [no] min-interval
- [no] min-severity
----shub
----[no] manager
- (address)
- [no] cold-start-trap
- [no] auth-fail-trap
- [no] change-trap
- [no] community-string
- [no] snmp-version
- [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
| init-started
| lic-key-chg-occr
| topology-chg )
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
- auth-failure : authentication failure
- change-occured : a configuration or operational change
occurred
- init-started : the node is initializing, IP connectivity is
established
- lic-key-chg-occr : the number of license keys changed
- topology-chg : topology changed (scope of cluster
management)
Table 4.2-2 "Trap Definition Configuration Command" Command Parameters
Parameter Type Description
priority Parameter type: <Trap::Priority> optional parameter
Format: the trap priority
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,critica
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 ]
init-started-trap ] [ [ no ] lic-key-chg-occr ] [ [ no ] topology-chg ] [ [ 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 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::alarmSeverity> ] )
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
Parameter Type Description
[no] priority Parameter type: <Trap::Priority> optional parameter with default
Format: value: "medium"
Command Description
This command allows the operator to configure an SNMP manager of the SHub.
Clarification regarding 'entry-status': If a failure occurs during the configuration of the SNMP manager of the
SHub, please check if the SNMP manager was created and if the corresponding entry-status is valid. If not, please
delete and re-create the SNMP manager.
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 shub ( no manager (address) ) | ( manager (address) [ [ no ] cold-start-trap ] [ [ no ] auth-fail-trap ]
[ [ no ] change-trap ] [ no community-string | community-string <Snmp::SHubCommunityName> ] [ no
snmp-version | snmp-version <Snmp::SHubVersion> ] [ no min-severity | min-severity
<Snmp::SHubAlarmSeverity> ] )
Command Parameters
Table 4.4-1 "SHub Trap Manager Configuration Command" Resource Parameters
Resource Identifier Type Description
(address) Format: 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.4-2 "SHub Trap Manager Configuration Command" Command Parameters
Parameter Type Description
[no] cold-start-trap Parameter type: boolean optional parameter
enable sending cold start trap
[no] auth-fail-trap Parameter type: boolean optional parameter
enable sending authentication
failure trap
[no] change-trap Parameter type: boolean optional parameter
enable sending of change occured
trap
[no] community-string Parameter type: <Snmp::SHubCommunityName> optional parameter with default
Format: value: "public"
- a printable string the community string to be used
Command Output
Table 4.4-3 "SHub Trap Manager Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Transport::WaitRowStatusTrapTable> the status of SNMP manager of
( valid the SHub
| corrupted This element is only shown in
| corrupted ) detail mode.
Possible values:
- valid : SNMP manager configuration is ok
- corrupted : SNMP manager configuration is not
operational(not-in-service)
- corrupted : SNMP manager configuration is not
operational(not-ready)
Description
This chapter gives an overview of nodes that are handled by "Equipment Configuration Commands".
Command Tree
----configure
----equipment
----slot
- (index)
- [no] planned-type
- [no] power-down
- [no] unlock
- [no] alarm-profile
- capab-profile
----applique
- (index)
- [no] planned-type
----protection-group
- (index)
- [no] admin-status
- [no] eps-quenchfactor
----protection-element
- (index)
- [no] redcy-ctrl-status
----external-link-host
- (faceplate-number)
- [no] direction
----external-link-assign
- (sfp-index)
- [no] remote
----isam
- [no] description
----rack
- (index)
- [no] description
----shelf
- (index)
- [no] class
- [no] planned-type
- [no] unlock
- [no] lock
- [no] extended-lt-slots
- [no] description
----envbox
- [no] enable-supervise
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 thelocked 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.
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.For BCM based boards default capab-profile is "default"
for Intel based 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.2-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
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
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.3-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::SlotId> )
Possible values:
- iont : an nt applique slot
- lp : an lt applique slot
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::SlotId>
- the LT slot number
Table 5.3-2 "Applique Configuration Command" Command Parameters
Parameter Type Description
[no] planned-type Parameter type: <Equipm::AppliqueType> optional parameter with default
Format: value: "not-planned"
Data driven field type type of applique intended to be in
Possible values are depending on the actual configuration this position
Command Description
This command allows the operator to configure a protection group.
The protection group is identified by the eqptProtGroupId attribute. The value 1 is reserved for the extension chain
protection group which is always present and cannot be deleted.
The protection group is identified by an index, the value 1 is reserved for the extension chain protection
group,which is always present and cannot be deleted.
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 "Protection Group Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: Index in eqpt Prot Group Table
- index of protection group
Table 5.4-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, 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.5-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.5-2 "Protection Element Configuration Command" Command Parameters
Command Description
This command allows the operator to configure the traffic direction of the two 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.6-1 "External-link-host Configuration Commands" Resource Parameters
Resource Identifier Type Description
(faceplate-number) Format: the faceplate number of the
- the faceplate number of the configurable external link configurable external-link
- range: [6...7]
Table 5.6-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
| remote-lt )
Possible values:
- network : the connection direction is from the network
- remote-lt : the connection direction is to the remote line
termination card
Command Description
This command allows the operator to configure the association between a host shelf SFP 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.7-1 "Host Shelf SFP Configuration Commands" Resource Parameters
Resource Identifier Type Description
(sfp-index) Format: host shelf SFP number on the
- host SFP faceplate number faceplate
- range: [2...17]
Table 5.7-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
Field type <Eqpt::ExpShelf>
- physical nbr of expansion shelf within expansion rack
Field type <Eqpt::ExpSlot>
- the physical number of the slot within expansion shelf
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.8-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 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.9-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.9-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.
unlock: 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 ] unlock ] [ [ no ] lock ] [ [ no ] extended-lt-slots ] [ no description | description
<Description-127> ]
Command Parameters
Table 5.10-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.10-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 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.11-2 "Environment Monitoring Configuration Command" Command Parameters
Parameter Type Description
[no] enable-supervise Parameter type: boolean optional parameter
enable environment monitoring
relay
Description
This chapter gives an overview of nodes that are handled by "xDSL Configuration Commands".
Command Tree
----configure
----xdsl
----[no] service-profile
- (index)
- name
- (scope)
- version
- [no] ra-mode-down
- [no] ra-mode-up
- [no] min-bitrate-down
- [no] min-bitrate-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] 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
- (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-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-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] 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
- [no] proprietary-feat
- [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
----re-adsl
- [no] proprietary-feat
- [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
- [no] proprietary-feat
- [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
----cust-psd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----vdsl
- [no] proprietary-feat
- [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
- [no] pbo-mode-down
- [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
----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
----vdsl2
- [no] proprietary-feat
- [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
----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
----line
- (if-index)
- [no] service-profile
- [no] spectrum-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-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-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] carrier-data-mode
- [no] admin-up
- [no] bonding-mode
- [no] transfer-mode
----tca-line-threshold
- [no] enable
- [no] es-nearend
- [no] ses-nearend
- [no] uas-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
----local-loop
- [no] unbundle
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 ofwhat 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 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 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 6.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...256]
Table 6.2-2 "xDSL Common Service Profile Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <AsamProfileName> mandatory parameter
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 configure 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 ofwhat 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-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-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 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::RFBand> ] [ no
power_mgnt_mode | power_mgnt_mode <Xdsl::LinePowerMgtMode> ] [ no l0-time | l0-time
<Xdsl::LineL0Time> ] [ no l2-time | l2-time <Xdsl::LineL2Time> ] [ no l2-agpow-red-tx | l2-agpow-red-tx
Command Parameters
Table 6.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 6.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-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
G.992.3 POTS non-overlapped
spectrum US mask 2
[no] g992-3-am Parameter type: boolean optional parameter
Command Description
This node 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. A number of 2 to 32 Artificial Noise PSD points can be specified downstream.
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. If all PSD points
are configured with a frequency of 0 and an invalid PSD of -167,5 dBm/Hz (entered value: 255), no artificial noise
shall be used.
The successive PSD points must have increasing (>/=) frequencies. If one point is marked as unused, all successive
points will be marked as unused too. 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 6.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: the name of the operator
- psd point
- range: [1...32]
Table 6.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
- frequency psd frequency
- unit: khz
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 6.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 6.5-2 "xDSL Spectrum Profile for ADSL/ADSL2 Configuration Command" Command
Parameters
Parameter Type Description
[no] proprietary-feat Parameter type: boolean optional parameter
enable proprietary features of the
modem
[no] max-agpowlev-down Parameter type: <Xdsl::PowerLevel> optional parameter with default
Format: value: 255
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 6.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 6.6-2 "xDSL Spectrum Profile for RE-ADSL2 Configuration Command" Command
Parameters
Parameter Type Description
[no] proprietary-feat Parameter type: boolean optional parameter
enable proprietary features of the
modem
[no] max-agpowlev-down Parameter type: <Xdsl::PowerLevel> optional parameter with default
Format: value: 255
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 6.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 6.7-2 "xDSL Spectrum Profile for ADSL2 Plus Configuration Command" Command
Parameters
Parameter Type Description
[no] proprietary-feat Parameter type: boolean optional parameter
enable proprietary features of the
modem
[no] max-agpowlev-down Parameter type: <Xdsl::PowerLevel> optional parameter with default
Command Description
This node allows the operator to configure custom psd shape
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.
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::CustomAdsl2Psd> ]
Command Parameters
Table 6.8-1 "ADSL2-plus Custom PSD shape" 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 6.8-2 "ADSL2-plus Custom PSD shape" 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::CustomAdsl2Psd> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]
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.
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 6.9-1 "xDSL Spectrum Profile for VDSL Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
Table 6.9-2 "xDSL Spectrum Profile for VDSL Configuration Command" Command Parameters
Command Description
This node 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 6.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 6.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 node allows the operator to configure custom psd shape
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.
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::CustomAdsl2Psd> ]
Command Parameters
Table 6.11-1 "VDSL Custom PSD shape" 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 6.11-2 "VDSL Custom PSD shape" 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...30000]
[no] psd Parameter type: <Xdsl::CustomAdsl2Psd> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]
Command Description
This node allows the operator to configure custom rx-psd shape
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.
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::CustomAdsl2Psd> ]
Command Parameters
Table 6.12-1 "VDSL Custom PSD shape" 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 6.12-2 "VDSL Custom PSD shape" 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...30000]
[no] psd Parameter type: <Xdsl::CustomAdsl2Psd> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]
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.
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 6.13-1 "xDSL Spectrum Profile for VDSL2 Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
Command Description
This node allows the operator to configure 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.
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::CustomAdsl2Psd> ]
Command Parameters
Table 6.14-1 "VDSL2 Custom PSD shape Downstream" 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 6.14-2 "VDSL2 Custom PSD shape Downstream" 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...30000]
[no] psd Parameter type: <Xdsl::CustomAdsl2Psd> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]
Command Description
This node allows the operator to configure Custom PSD shape in Downstream
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.
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::CustomAdsl2Psd> ]
Command Parameters
Table 6.15-1 "VDSL2 Custom PSD shape Upstream" 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 6.15-2 "VDSL2 Custom PSD shape Upstream" 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...30000]
[no] psd Parameter type: <Xdsl::CustomAdsl2Psd> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]
Command Description
This node allows the operator to configure custom rx-psd shape Upstream
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.
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::CustomAdsl2Psd> ]
Command Parameters
Table 6.16-1 "VDSL2 Custom PSD shape" 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 6.16-2 "VDSL2 Custom PSD shape" 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...30000]
[no] psd Parameter type: <Xdsl::CustomAdsl2Psd> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]
Command Description
This node allows the operator to configure virtual noise in Downstream
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.
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 6.17-1 "VDSL2 Virtual Noise Downstream" 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 6.17-2 "VDSL2 Virtual Noise Downstream" 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...30000]
[no] psd Parameter type: <Xdsl::CustPsdVdsl2VtNoise> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2*(40+PSD level in dBm/Hz)
- range: [0...200,255]
Command Description
This node allows the operator to configure virtual noise in Upstream
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.
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 6.18-1 "VDSL2 Virtual Noise Upstream" 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 6.18-2 "VDSL2 Virtual Noise Upstream" 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...30000]
[no] psd Parameter type: <Xdsl::CustPsdVdsl2VtNoise> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2*(40+PSD level in dBm/Hz)
- range: [0...200,255]
Command Description
This command allows the operator to configure the xDSL line.
For the configuration one should associate a spectrum and a service profile to the line. The op-mode controls the
operational modes allowed on the line. It can be used to disable an operational mode that is enabled in the
spectrum profile but is not allowed on the line. It uses the same bitmap coding as op-mode in the xDSL
spectrum-profile.'0' is used as special value to indicate that all the modes supported by the line are allowed.
The modes which are not supported by the line must be disabled.
An operational mode is allowed on the line when it is enabled in the op-mode of the line configuration and the
op-mode in the xDSL spectrum-profile.
The configuration of the TCA line threshold is part of the XDSL line configuration. This can be configured by the
following command: configure xdsl line (if-index) tca-line-threshold.
To deconfigure a line the service-profile and spectrum-profile has to be put to 0.
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 6.19-1 "xDSL 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
Command Output
Table 6.19-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.
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 6.20-1 "xDSL 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 6.20-2 "xDSL 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 XDSL line
[no] es-nearend Parameter type: <Xdsl::IntervalTcaThreshold> optional parameter with default
Command Description
This command allows the operator to configure Local Loop Unbundling.
Local Loop Unbundling enables handing over narrowband (POTS) services or broadband (Data, High Speed
Internet, 3-Play) services to another operator. For an ILEC (Incumbent Local Exchange Carrier), Local Loop
Unbundling hands over the broadband services to a CLEC (Competitive Local Exchange Carrier). For a CLEC,
Local Loop Unbundling hands over the narrowband services to an ILEC. Two situations exist : 1) No Local Loop
Unbundling : In this case, both broadband and narrowband services are offered by one operator, ILEC or CLEC.
2) Local Loop Unbundling : In this case, the ILEC operator enables the CLEC to make use of the existing
infrastructure to provide broadband services to the customers, while the ILEC keeps the narrowband. The CLEC
operator enables the ILEC to make use of the existing infrastructure to provide narrowband services to the
customers, while the CLEC keeps the broadband.
The Local Loop Unbundling is a function introduced in the splitter of the XD combo 300 equipment practice (7302
ISAM Voice Package). For an ILEC, it allows to bypass the broadband circuits (DSL modem and low pass filter),
and connect the line to the broadband circuits (DSL modem and Low Pass Filter) of the CLEC. For a CLEC, it
allows to bypass the narrowband circuits (internal POTS), and connect the line to the narrowband circuits or local
exchanges of the ILEC.
In case of ILEC, the narrowband service remains accessible irrespective of whether Local Loop Unbundling is
enabled or disabled. In case of CLEC, the broadband service remains accessible irrespective of whether Local
Loop Unbundling is enabled or 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 6.21-1 "xDSL Local Loop Unbundling 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>
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
----[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
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
automatic:ppp is used for auto-detection between llc-snap, vc-mux-bridged-8023, llc-nlpid, and vc-mux-pppoa
automatic:pppoa is used for auto-detection between llc-nlpid and vc-mux-pppoa
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 7.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
<Eqpt::PortId> : <Eqpt::VpiMandatoryId> :
<Eqpt::VciMandatoryId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
Command Description
This node 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 ip privileges, and executed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 7.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 7.3-2 "IPOA X-connect L2 interworking port Configuration Command" Command
Parameters
Parameter Type Description
cpe Parameter type: <Ip::V4AddressHex> optional parameter
Format: IP address for cpe
- IPv4-address
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
- [no] link-updown-trap
- [no] link-state-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] unnumbered-as
- (borrowed-index)
----port
- (network-port)
- [no] mode
- [no] port-type
- [no] admin-status
- [no] mc-flooding
----[no] group
- (group-id)
- [no] threshold
----[no] 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 8.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>
| 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>
| 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>
/ <Eqpt::PortId>
| shdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| ima-group : <Eqpt::RackId> / <Eqpt::ShelfId> /
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 8.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 8.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 8.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 )
Possible values:
- xdsl-line : xdsl line
- ethernet-line : ethernet line
- shdsl-line : shdsl line
Table 8.4-2 "Interface Alarm Configuration Command" Command Parameters
Parameter Type Description
[no] default-severity Parameter type: optional parameter with default
<Itf::asamIfExtAlmReportingSeverityDefault> value: "major"
Format: default severity to be reported
( indeterminate
| warning
| minor
| major
| critical )
Possible values:
- indeterminate : not a definite known severity
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
Command Description
This command allows the operator to configure parameters related to SHub interface 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:
> 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 8.5-1 "SHub Management Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
Table 8.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
- MTU for interface as shown to higher interface sub-layer MTU for the vlan interface
- range: [90...9100]
[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 node 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 8.6-1 "SHub IP Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
Table 8.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 node 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 8.7-1 "SHub ICMP Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
Table 8.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 node 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:
Command Parameters
Table 8.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]
Command Description
This node 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 8.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 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 all privileges, and executed by operators with all 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 8.10-1 "SHub Port Control Configuration Command" Resource Parameters
Resource Identifier Type Description
(network-port) Format: identifier of the port interface
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Table 8.10-2 "SHub Port Control Configuration Command" Command Parameters
Parameter Type Description
[no] mode Parameter type: <Sys::PortCtrlMode> optional parameter with default
Format: value: "automatic"
( automatic negotiation mode of the port
| 10mbps : full interface parameters
| 10mbps : half
| 100mbps : full
| 100mbps : half
| 1gbps : full
| 1gbps : half )
Possible values:
- automatic : determine the parameters of interface
Command Description
This node allows the user to configure parameters related to uplink group configuration of an interface.
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 interface shub ( no group (group-id) ) | ( group (group-id) [ no threshold | threshold <Itf::Threshold> ] )
Command Parameters
Table 8.11-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 8.11-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 node 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 all privileges, and executed by operators with all privileges.
Command Syntax
The command has the following syntax:
> configure interface shub group (group-id) ( no port (port) ) | ( port (port) )
Command Parameters
Table 8.12-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
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
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 9.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
- contact-person
- [no] en-snmp-auth-trap
- [no] ether-shape-rate
- mgnt-vlan-id
- system-mac
- [no] single-public-ip
- [no] port-num-in-proto
----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
----loop-id-syntax
- [no] atm-based-dsl
- [no] efm-based-dsl
----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)
----[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
----[no] shub-manager
- (index)
- src-ip-addr
----entry
----ip
- [no] ip-cfg-mode
----id
- [no] contact
- [no] location
----vlan
- ext-vlan-id
----status
- [no] http-access
----clock-mgmt
- [no] priority-scheme
- [no] ext-source
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 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 all privileges, and executed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 10.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: [a-zA-Z0-9-_./]
- 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
- a printable string
- length: x<=255
contact-person Parameter type: <Transport::sysContact> optional parameter
Format: info about the contact person for
Command Description
This command allows the operator to configure the IP address of 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 10.3-2 "System Management Host IP Address 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]
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 10.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 10.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]
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 transport privileges, and executed by operators with transport
privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 10.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 all privileges, and executed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 10.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...780]
Command Description
This command allows the operator to configure the SHub 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".
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 :
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.
Port to specify the port number.
VPI to specify the vpi.
VCI to specify the vci.
Q-VID to specify the vlan identifier.
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 10.7-2 "SHub System Loop ID Syntax Configuration Command" Command Parameters
Parameter Type Description
[no] atm-based-dsl Parameter type: <PrintableString-0-64> optional parameter with default
Format: value: "Access_Node_ID atm
- a printable string Rack/Frame/Slot/Port : VPI.VCI"
- length: x<=64 define the syntax of loop Id for
atm based dsl lines
[no] efm-based-dsl Parameter type: <PrintableString-0-64> optional parameter with default
Format: value: "Access_Node_ID eth
- a printable string Rack/Frame/Slot/Port"
- length: x<=64 defines the syntax of loop Id for
efm based dsl lines
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.
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 all privileges, and executed by operators with all 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::NetworkAddressAndIpMaskFull> ] [ no src-ip-addr | src-ip-addr
<Ip::NetworkAddressAndIpMaskFull> ] [ 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 10.8-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 10.8-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::NetworkAddressAndIpMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> destination IP address to be
Field type <Ip::V4Address> matched with the packet
Command Output
Table 10.8-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 all privileges, and executed by operators with all 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 10.9-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
<Shub::NetworkPort>
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 all privileges, and executed by operators with all 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 10.10-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> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
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
Field type <Shub::NoExtLink>
- unassigned external SFP port
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.
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 all privileges, and executed by operators with all 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 10.11-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 10.11-2 "SHub System TCP 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::NetworkAddressAndIpMaskFull> optional parameter with default
Command Output
Table 10.11-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 all privileges, and executed by operators with all 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 10.12-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
<Shub::NetworkPort>
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 all privileges, and executed by operators with all 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 10.13-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> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
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
Field type <Shub::NoExtLink>
- unassigned external SFP port
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.
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 all privileges, and executed by operators with all 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 10.14-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 10.14-2 "SHub System UDP 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::NetworkAddressAndIpMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
Command Output
Table 10.14-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
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
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 all privileges, and executed by operators with all 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 10.15-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
<Shub::NetworkPort>
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 all privileges, and executed by operators with all 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 10.16-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> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
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
Field type <Shub::NoExtLink>
- unassigned external SFP 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.
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.
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 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 10.17-1 "SHub System Other Protocol Filter 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
Format:
( network : <Shub::NetworkPort>
| all )
Possible values:
- network : network port
- all : apply to all ports
Field type <Shub::NetworkPort>
- network port on Shub
Table 10.17-2 "SHub System Other Protocol Filter Configuration Command" Command
Parameters
Parameter Type Description
[no] protocol Parameter type: <Sys::RestrictedProtocol> optional parameter with default
Format: value: "any"
( igmp type of protocol to be checked
| ggp against the packet
| ip
| egp
| igp
| nvp
| irtp
| idrp
| rsvp
| msrp
| igrp
| ospf
| any )
Possible values:
- igmp : check the packet for igmp
- ggp : check the packet for ggp
- ip : check the packet for ip
- egp : check the packet for egp
- igp : check the packet for igp
- nvp : check the packet for nvp
- irtp : check the packet for irtp
- idrp : check the packet for idrp
- rsvp : check the packet for rsvp
- msrp : check the packet for msrp
- igrp : check the packet for igrp
- ospf : check the packet for ospf
- any : check the all packets
[no] action-drop Parameter type: boolean optional parameter
the packet will be discarded
[no] dst-ip-addr Parameter type: <Ip::NetworkAddressAndIpMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> destination IP address to be
Field type <Ip::V4Address> matched with the packet
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] src-ip-addr Parameter type: <Ip::NetworkAddressAndIpMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> source IP address to be matched
Field type <Ip::V4Address> with the packet
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] vlan-id Parameter type: <Vlan::VlanFilterIndex> optional parameter with default
Format: value: "any"
( any vlan to be filtered, zero means
| <Vlan::VlanFilterIndex> ) wildcard for vlan
Possible values:
- any : defaul vlan-id
Field type <Vlan::VlanFilterIndex>
- vlan id
Command Output
Table 10.17-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
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.
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 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 10.18-1 "SHub System Other Protocol Filter 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 network port
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| all )
Possible values:
- lt : port of the line board
- network : network port
Command Output
Table 10.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
This command allows the operator to configure the management VLAN filter IP address.
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 shub filter ( no shub-manager (index) ) | ( shub-manager (index) src-ip-addr <Ip::V4Address> )
Command Parameters
Table 10.19-1 "SHub System VLAN Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index number of the SrcIp
- index(1..100)
- range: [1...100]
Table 10.19-2 "SHub System VLAN Filter Configuration Command" Command Parameters
Parameter Type Description
src-ip-addr Parameter type: <Ip::V4Address> mandatory parameter
Format: MgmtVlan filter IP address to be
- IPv4-address matched with the packet
Command Description
This command allows the operator to configure the IP related parameter.
The default IP address is used when manual mode is selected or when the system fails to obtain an IP address
dynamically. The default IP address, subnet mask and default gateway will only take effect when the configuration
is stored and restored.
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 10.20-2 "SHub System IP Group Configuration Command" Command Parameters
Parameter Type Description
[no] ip-cfg-mode Parameter type: <Sys::DefIpAddr> optional parameter with default
Format: value: "manual"
( manual specifies how the system get the
| dynamic ) IP address
Possible values:
- manual : ip address got from the system
- dynamic : ip address got through dynamic IP address
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 all privileges, and executed by operators with all 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 10.21-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 all privileges, and executed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 10.22-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 HTTP access to the SHub system.
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 10.23-2 "SHub System HTTP Configuration Command" Command Parameters
Parameter Type Description
[no] http-access Parameter type: boolean optional parameter
enable http access for the users
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 10.24-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 Scheme
| 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: "khz2048"
( e1 select the external clock type E1
| ds1 or DS1 or 2048Khz
| khz2048 )
Possible values:
- e1 : select ETSI Source
- ds1 : select DS1 Source
- khz2048 : select 2048KHz Source
Description
This chapter gives an overview of nodes that are handled by "Security Configuration Commands".
Command Tree
----configure
----system
----security
- [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] security
----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] security
----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
----shub
----[no] community
- (index)
- name
- [no] privilege
- [no] ip-addr
----[no] ip-addr-pool
- (name)
- vrf-index
- start-addr
- [no] size
- [no] admin-down
----[no] reserve-address
- (ip-address)
----radius
- [no] relay
- [no] auth-super-user
- [no] operator-policy
----[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] ip-pool
- (name)
- vrf-index
- priority
----[no] user
- (name)
- password
----[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
----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] server
- (serverid)
- user-name
- password
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 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 11.2-2 "Security Banner Configuration Commmand" Command Parameters
Parameter Type Description
[no] login-banner Parameter type: <Sec::Banner> optional parameter with default
Format: value: ""
- a banner to be shown to the operator banner to be shown before the
- length: x<=480 operator enters its name
[no] welcome-banner Parameter type: <Sec::Banner> optional parameter with default
Format: value: ""
- a banner to be shown to the operator the banner to be shown when the
- length: x<=480 operator logged in
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).
%! : 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, 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::Password> [ no prompt | prompt <Sec::Prompt> ] [ no description | description <Sec::OperatorDesc> ] [ [ no
] more ] )
Command Parameters
Table 11.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 11.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::Password> mandatory parameter
Format: the password needed to log in
( prompt
| plain : <Sec::PlainPassword>
| 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::PlainPassword>
- the password in plain text
- 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
filter
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).
%! : 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.
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 security | security <Sec::Security> ] )
Command Parameters
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.
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 11.5-2 "Default 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: 0
- specify the inactivity timeout of the terminal the maximum time a terminal
- unit: minutes may be inactive
- range: [0...120]
[no] slot-numbering Parameter type: <Sec::SlotDesc> optional parameter with default
Format: value: "legacy-based"
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 11.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 11.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 11.7-1 "Security SNMP Community Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: the name of the community
- the community name
- 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 11.7-2 "Security SNMP Community Configuration Command" Command Parameters
Parameter Type Description
[no] context Parameter type: <Transport::Context> optional parameter with default
Format: value: "nt"
( nt the context allowed for this
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::ViewName> ] [ no write-view | write-view <Snmp::ViewName> ] [ no notify-view |
notify-view <Snmp::ViewName> ] )
Command Parameters
Table 11.8-1 "Security SNMPv3 Group Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of snmpV3 group
- name of the snmpv3 group
- 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
| single : shub
| single : epon
| all )
Command Output
Table 11.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 11.9-1 "Security SNMPv3 User Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the user
- snmpv3 user name
- length: 1<=x<=32
Table 11.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::PlainPassword>
| sha1 : plain : <Sec::PlainPassword>
| md5 : encrypted : <Snmp::AuthEncryptedKey>
| sha1 : encrypted : <Snmp::AuthEncryptedKey> )
Possible values:
- none : no authentication
- md5 : md5 based authentication
- sha1 : sha1 based authentication
Possible values:
Command Output
Table 11.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
operational(not-ready)
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::GroupName> )
Command Parameters
Table 11.10-1 "Security SNMPv3 User-Group Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the snmpV3 user
- snmpv3 user name
- length: 1<=x<=32
Table 11.10-2 "Security SNMPv3 User-Group Configuration Command" Command Parameters
Parameter Type Description
group-name Parameter type: <Snmp::GroupName> mandatory parameter
Format: name of the snmpV3 group
- name of the snmpv3 group
- length: 1<=x<=32
Command Output
Table 11.10-3 "Security SNMPv3 User-Group Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Transport::WaitRowStatusMapUser> the status of mapping an
( valid SNMPv3 user to an SNMPv3
| corrupted group
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 11.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 11.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 11.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 11.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 11.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 11.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 11.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 11.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 ] )
Command Parameters
Table 11.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 11.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
enable storing in nt
Command Output
Table 11.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 the operator to configure community names.
There can be many entries with the same community name or IP address.
SNMP uses community names as a kind of password without user name to verify if a request may be executed.
It is possible to allow only a limited number of IP addresses to use a given community name.
User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
The community used by the command line interface (CLI) can not be deleted nor modified.
Clarification regarding 'entry-status': If a failure occurs during the configuration of SNMP community names,
please check if the names were created and if the corresponding entry-status is valid. If not, please delete and
re-create the entire SNMP community names configuration.
Command Syntax
The command has the following syntax:
> configure system security snmp shub ( no community (index) ) | ( community (index) name
<Snmp::SHubCommunityName> [ no privilege | privilege <Snmp::SHubCommunityPrivilege> ] [ no ip-addr |
ip-addr <Ip::V4Address> ] )
Command Parameters
Table 11.15-1 "SHub Security SNMP Community Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: number of the entry in the
- number of the entry in the community table community table
- range: [1...10]
Table 11.15-2 "SHub Security SNMP Community Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <Snmp::SHubCommunityName> mandatory parameter
Format: the name of the community
- a printable string
- length: x<=255
[no] privilege Parameter type: <Snmp::SHubCommunityPrivilege> optional parameter with default
Format: value: "read-only"
( read-only the privileges we have when we
Command Output
Table 11.15-3 "SHub Security SNMP Community Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Transport::WaitRowStatusCommunity> the status of SNMP community
( valid names
| corrupted This element is only shown in
| corrupted ) detail mode.
Possible values:
- valid : SNMP community names configuration is ok
- corrupted : SNMP community names configuration is not
operational(not-in-service)
- corrupted : SNMP community names configuration is not
operational(not-ready)
Command Description
This is a (conceptual) table for local IP address allocation for PPP users ONLY. Two IP pools in the same VRF
should not contain overlapping IP address spaces. The IP address space is determined by start and size. An Ip pool
row in this table can be deleted only when, no domains use this pool and no Ip addresses are allocated to user
sessions from this pool. When a row is deleted in this table, the corresponding rows in the IP address pool reserve
and status are also removed.
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 ip-addr-pool (name) vrf-index <Aaa::IpVrfIndex> ) | ( ip-addr-pool (name)
vrf-index <Aaa::IpVrfIndex> start-addr <Ip::AddressAndMask> [ no size | size <Aaa::IpAddressPoolSize> ] [ [ no
] admin-down ] )
Command Parameters
Table 11.16-1 "Security IP Address Pool Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the IP address pool
- name of IP address pool
- length: 1<=x<=64
vrf-index Parameter type: <Aaa::IpVrfIndex> vrf associated with this pool
Format:
- vrf index
- range: [1...127]
Table 11.16-2 "Security IP Address Pool Configuration Command" Command Parameters
Parameter Type Description
start-addr Parameter type: <Ip::AddressAndMask> mandatory parameter
Format: The parameter is not visible
<Ip::V4Address> / <Ip::PrefixLength> during modification.
Field type <Ip::V4Address> first address from where
- IPv4-address allocation of IP address starts
Field type <Ip::PrefixLength>
- IP address prefix length
- range: [0...30]
[no] size Parameter type: <Aaa::IpAddressPoolSize> optional parameter with default
Format: value: 0
Command Description
This command allows the operator to configure the security IP address pool reserve address. A conceptual table is
used for reserving and unreserving an IP address from the specified pool. A entry can only be created when the
corresponding entry in the table (with the same IP address index) is created. An IP address can be reserved only
when the IP address is not allocated to any user session. After the row has been created in this table, the value for
IP address pool status changes to locally reserved. To unreserve an IP address, the corresponding entry should be
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:
Command Parameters
Table 11.17-1 "Security IP Address Pool Reserve Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the IP address pool
- name of IP address pool
- length: 1<=x<=64
vrf-index Parameter type: <Aaa::IpVrfIndex> vrf associated with this pool
Format:
- vrf index
- range: [1...127]
(ip-address) Format: IP addess to be
- IPv4-address reserved/unreserved.
Command Description
This command enables or disables relay functionality on the SHub and, configures the superuser authentication
type and the operator's RADIUS 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 11.18-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 operator RADIUS policy name
| name : <Aaa::IgnoredRadiusPolicyName> )
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
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.
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
<Aaa::Password> [ 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 11.19-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 11.19-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
- UDP port to which RADIUS auth messages should be sent UDP port to which RADIUS auth
- range: [0...65535] messages should be sent
secret Parameter type: <Aaa::Password> mandatory parameter
Format: secret string used between
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.
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
<Aaa::Password> [ 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 11.20-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 11.20-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
- UDP port to which RADIUS auth messages should be sent UDP port to which RADIUS
- range: [0...65535] accounting messages be sent
secret Parameter type: <Aaa::Password> mandatory parameter
Format: secret string used between
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.
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 <Aaa::Password> [ [ no ] admin-down ] )
Command Parameters
Table 11.21-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 11.21-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: <Aaa::Password> mandatory parameter
Format: secret string used between
- password string hidden from users RADIUS server and client
- length: 6<=x<=64
[no] admin-down Parameter type: boolean optional parameter
adminstrative state down
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 11.22-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 11.22-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 6 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.
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 11.23-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 11.23-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
vrf-index-auth Parameter type: <Aaa::VrfIndex> mandatory parameter
Format: vrf to which the RADIUS auth
- a vrf index server belongs
- range: [0...127]
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 11.24-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 11.24-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 define the domain IP pool.
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 domain (name) ( no ip-pool (name) vrf-index <Aaa::VrfIndex> ) | ( ip-pool (name)
vrf-index <Aaa::VrfIndex> priority <SignedInteger> )
Command Parameters
Table 11.25-1 "Security Domain IP Pool Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the domain
- name of the domain
- length: 1<=x<=64
(name) Format: name of the IP address pool
- name of IP address pool
- length: 1<=x<=64
vrf-index Parameter type: <Aaa::VrfIndex> vrf associated with this pool
Format:
- a vrf index
- range: [0...127]
Table 11.25-2 "Security Domain IP Pool Configuration Command" Command Parameters
Parameter Type Description
priority Parameter type: <SignedInteger> mandatory parameter
Format: priority associated with this IP
- a signed integer pool
Command Description
This command allows the operator to configure the security domain for a user. A conceptual table lists the
configurable parameters for a user of a particular domain. This table is used for authenticating users locally. If a
domain is deleted, all users of the domain are deleted from the table.
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 domain (name) ( no user (name) ) | ( user (name) password <Aaa::Password> )
Command Parameters
Table 11.26-1 "Security Domain User Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the domain
- name of the domain
- length: 1<=x<=64
(name) Format: name of the user of a particular
- a description domain
- length: 1<=x<=64
Table 11.26-2 "Security Domain User Configuration Command" Command Parameters
Parameter Type Description
password Parameter type: <Aaa::Password> mandatory parameter
Format: user password, minimum 6
- password string hidden from users characters
- length: 6<=x<=64
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 11.27-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 11.27-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 11.28-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 11.29-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 11.30-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> )
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 11.30-2 "Security 802.1x Port Authentication Configuration Command" Command
Parameters
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 11.31-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> )
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 11.31-2 "Security 802.1x Extension, Port Authentication Configuration Command"
Command Parameters
Parameter Type Description
[no] authentication Parameter type: boolean optional parameter
enable 802.1x authentication
[no] init-authreq-off Parameter type: boolean optional parameter
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 11.32-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> )
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 11.32-2 "Security 802.1x Port Configuration Command" Command Parameters
Parameter Type Description
[no] initialize Parameter type: boolean optional parameter
initalize this port
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 11.33-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: [0...20]
[no] mixed-case Parameter type: <Sec::MixCase> optional parameter with default
Format: value: "not-mandatory"
( mandatory both upper and lower case
| not-mandatory ) charactersre 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 11.34-2 "File Transfer Configure Command" Command Parameters
Parameter Type Description
[no] protocol Parameter type: <SwMngt::Protocol> 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
Command Description
This command configure 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 <SwMngt::Password> )
Command Parameters
Table 11.35-1 "file Transfer server Configure Commands" Resource Parameters
Resource Identifier Type Description
(serverid) Format: (IP address) of the file transfer
- IPv4-address server
Table 11.35-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: <SwMngt::Password> mandatory parameter
Format: the password used to access the
- the password used to access the file server file server
- length: 1<=x<=32
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] ftp
- [no] protocol
- [no] cli
- [no] tl1
----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 12.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 12.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<=9
Table 12.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<=725
Command Description
This command allows the operator to enable or disable the access to the channels like SFTP, TL1 over SSH, CLI
over SSH.
Enabling of the channels can be done via any CLI sessions, i.e., CLI over TELNET or CLI over SSH
Disabling of the channels can be done only through CLI over SSH
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 ftp | ftp <SSH::ChannelFTP> ] [ no protocol | protocol
<SwMngt::Protocol> ] [ no cli | cli <SSH::ChannelCLISSH> ] [ no tl1 | tl1 <SSH::ChannelTL1SSH> ]
Command Parameters
Table 12.4-2 "Secure Shell Access Configuration Command" Command Parameters
Parameter Type Description
[no] ftp Parameter type: <SSH::ChannelFTP> obsolete parameter replaced by
Format: parameter "protocol"
( sftp specifies whether to select tftp or
| tftp ) sftp
Possible values:
- sftp : enable the sftp application
- tftp : enable the tftp application
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 12.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> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <SSH::SftpPassword>
- sftp password
- length: 6<=x<=32
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 13.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: [0,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] 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 (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 ]
)
Command Parameters
Table 14.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 14.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>
| 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
- 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
Field type <Sys::ServName>
- filename in which logs to be stored
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=12
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 14.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 )
Possible values:
- all : messages of any type
- authentication : authentication messages
- cli-config-chgs : cli configuration change messages
- tl1-config-chgs : tl1 configuration change messages
- cli-msgs : cli messages
- tl1-msgs : tl1 messages
- tracing1 : protocol tracing messages
- tracing2 : protocol tracing messages
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
- download-set
- 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.
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.
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 15.2-1 "Software Management Overall Software Package Configuration Command"
Resource Parameters
Resource Identifier Type Description
(index) Format: index to the swm oswp table
- id of one of the two oswps
- range: [1...2]
Table 15.2-2 "Software Management Overall Software Package Configuration Command"
Command Parameters
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 15.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
----ip
- default-ttl
----shub
----[no] mac-filter
- (index-num)
- [no] protocol-type
- filter
- vlan-id
- [no] action-drop
----[no] in-port
- (port)
----rate-limit
- (ctrl-index)
- [no] lookup-enabled
- [no] bcast-pkt-enabled
- [no] mcast-pkt-enabled
- max-nbr-pkts
Command Description
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 16.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
This command allows the operator to configure a MAC filter.
The MAC filter by default applies to any incoming SHub port, either network or LT. To apply the filter only to
specific ports, use the subsequent command to configure the incoming ports. Refer to section "SHub Ethernet MAC
Filter Port List Configuration Command".
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 16.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 16.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 - <Sys::MacAddr> matched with the packet
| <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
Possible values:
Command Description
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 all privileges, and executed by operators with all privileges.
Command Syntax
The command has the following syntax:
> configure transport shub mac-filter (index-num) ( no in-port (port) ) | ( in-port (port) )
Command Parameters
Table 16.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> )
Possible values:
- lt : line board
- network : network port
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 allows the operator to configure the rate limit.
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 16.5-1 "SHub Ethernet Rate Configuration Command" Resource Parameters
Resource Identifier Type Description
(ctrl-index) Format: control index of the rate
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Table 16.5-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: limiting value for the maximum
- max nbr of packets transmitted on this interface number of packets
- range: [1...65535]
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
----tc-map-dot1p
- (index)
- queue
----dsl-ctrl-pkt-policer
- [no] sustained-rate
- [no] burst-size
----dscp-map-dot1p
- (index)
- dot1p-value
----profiles
----[no] queue
- (name)
- (bac-complex-type)
----[no] scheduler
- (name)
- wfq-q1-weight
----[no] cac
- (name)
- res-voice-bandwidth
- max-mcast-bandwidth
- res-data-bandwidth
----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
- [no] alignment
----codepoint
- (codepoint)
- [no] dscp-value
----[no] d1p-dscp
- (name)
- default-dscp
- default-dot1p
----[no] d1p-alignment
- (name)
- (alignment)
----[no] policer
- (name)
- committed-info-rate
- committed-burst-size
----[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] dst-ip-addr
- [no] src-ip-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] up-policy
- (name)
----[no] down-policy
- (name)
----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
----dsl-port
- (index)
- scheduler-profile
- cac-profile
----queue
- (queue)
- queue-profile
----shdsl-port
- (index)
- scheduler-profile
- cac-profile
----queue
- (queue)
- queue-profile
----interface
- (index)
- scheduler-profile
- cac-profile
----queue
- (queue)
- queue-profile
----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
- (old-type)
- [no] type
----[no] policer
- (port-id)
- flow
- meter
----[no] meter
- (index)
- [no] name
- max-ingress-rate
- burst-size
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 17.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 by efm layer value to estimate bndwdth
- unit: % ovrhead inserted by efm layer
- range: [1...100]
[no] enable-alignment Parameter type: boolean optional parameter
DSCP to P-bit alignment for all
forwarded L3 traffic
[no] cac-mode Parameter type: <Qos::CacMode> optional parameter with default
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, 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.
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 17.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 17.3-2 "QoS 802.1P Class-to-Queue Mapping Configuration Command" Command
Parameters
Parameter Type Description
queue Parameter type: <Qos::Queues> optional parameter
Format: output dsl port queue number
- output dsl port queue number
- range: [0...3]
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.
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 17.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]
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 17.5-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 17.5-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:
Command Parameters
Table 17.6-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 17.6-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> )
Possible values:
- tail-drop : tail drop algorithm
- red : random early detection algorithm
Field type <Qos::MinThreshold>
- minimum threshold value of green frames per packet
- range: [1...512]
Field type <Qos::MaxThreshold>
- maximum threshold value of green frames per packet
- range: [2...512]
Field type <Qos::DiscardProbability>
- maximum discard probability of green frames
- unit: %
- range: [0...100]
Command Description
This command allows the operator to configure a QoS scheduler profile. The scheduler profiles contain
configuration settings for the data plane schedulers. These scheduler profiles are applicable to downstream
schedulers on the L3 line cards. The scheduler settings on the service hub can be modified separately.
On the L2 line cards, the schedulers have static settings.
There are two queues with WFQ scheduling method, so the only parameter to tune is the weight of the second
queue (also known as the controlled load queue), while the weight for the first queue is auto-adjusted to yield a sum
of 100%.
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 (name) ) | ( scheduler (name) wfq-q1-weight <Qos::WfqQ1Weight> )
Command Parameters
Table 17.7-1 "QoS Scheduler 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 17.7-2 "QoS Scheduler Profile Configuration Command" Command Parameters
Parameter Type Description
wfq-q1-weight Parameter type: <Qos::WfqQ1Weight> mandatory parameter
Format: weight of DSL link WFQ
- weight of DSL link WFQ scheduler for Queue one scheduler for Queue one
- range: [0...100]
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 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> )
Command Parameters
Table 17.8-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 17.8-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
Format: maximum allowed bandwidth for
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 17.9-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 17.9-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 17.10-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 17.10-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 17.11-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 17.11-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 17.12-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 17.12-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 17.13-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 17.13-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 optional parameter
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 17.14-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 17.14-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 17.15-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 17.15-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) )
Command Parameters
Table 17.16-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 17.16-2 "QoS Dot1P Alignment Marker Configuration Command" Command Parameters
Parameter Type Description
(alignment) Format: mandatory parameter
enable enable dot1p alignment
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 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.
The policer granularity on the L3 line cards units is8 kb/s. Values specified with 1-kb/s granularity are always
rounded upwards. A valid range is from8 kb/s to 64 Mb/s, with a fixed granularity of8 kb/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:
> configure qos profiles ( no policer (name) ) | ( policer (name) committed-info-rate <Qos::CommittedInfoRate>
committed-burst-size <Qos::CommittedBurstSize> )
Command Parameters
Table 17.17-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 17.17-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: [8...65536]
committed-burst-size Parameter type: <Qos::CommittedBurstSize> mandatory parameter
Format: committed burst size of a policer
- committed burst size of a policer
- unit: bytes
- range: [64...262144]
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 17.18-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 17.18-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.
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 dst-ip-addr | dst-ip-addr
<Ip::AddressAndMaskFull> ] [ no src-ip-addr | src-ip-addr <Ip::AddressAndMaskFull> ] [ 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 17.19-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 17.19-2 "QoS L3 Filter Profile Configuration Command" Command Parameters
Parameter Type Description
[no] dst-ip-addr Parameter type: <Ip::AddressAndMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> destination ip address to be
Field type <Ip::V4Address> matched with the packet
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] src-ip-addr Parameter type: <Ip::AddressAndMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> source ip address to be matched
Field type <Ip::V4Address> with the packet
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] min-dst-port Parameter type: <Qos::L4PortNumber> optional parameter with default
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::QosProfileName> ] )
Command Parameters
Table 17.20-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 17.20-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::QosProfileName> ] )
Command Parameters
Table 17.21-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 17.21-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
Field type <Qos::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64
Field type <Qos::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64
[no] precedence Parameter type: <Qos::PolicyPrecedence> optional parameter with default
Format: value: 10L
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.
The scope of a QoS session profile is always a user logical interface (for example, a session or Service Access
Point(SAP)). The following "logical interface" or "logical flow" types are supported:
Generic - any defined logical flow.
PVC - all frames on a PVC.
802.1X session - all frames on a PVC except (port based)PPP frames.
PVC.VLAN - all frames on a .1D port with the same VLAN ID.
PPP - all frames in a terminated PPP session/interface.
IP - all frames in a terminated IP session/interface.
IPoE VLAN CC - all IPoE frames in a VLAN CC interface.
PPPoE VLAN CC - all PPPoE frames in a VLAN CC interface.
IPoA CC - all IPoA frames in a IPoA CC interface.
PPPoA CC - all PPPoA frames in a PPPoA CC interface.
IPoE I-Bridge - all IPoE frames in I-Bridge interface.
PPPoE I-Bridge - all PPPoE frames in I-Bridge interface.
PPPoA Relay - all PPPoA frames in PPPoA relay interface.
IPoE IP Aware Bridge - all IPoE frames in IP Aware Bridge interface.
IPoA IP Aware Bridge - all IPoA frames in IP Aware Bridge interface.
The logical flow type will constrain the usage of a session profile to the intended interface type.However, if the
logical flow type is generic the session profile can be attached to any interface, and unsupported settings for the
target hardware are silently ignored by the system. Operators must always create specific profiles for specific
interface types to avoid incorrect configurations.
QoS session profiles are supported on the L3 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:
> configure qos profiles ( no session (name) ) | ( session (name) logical-flow-type <Qos::LogicalFlowType> [ no
up-policer | up-policer <Qos::QosProfileName> ] [ no down-policer | down-policer <Qos::QosProfileName> ] [ no
up-marker | up-marker <Qos::QosProfileName> ] )
Command Parameters
Table 17.22-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 17.22-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
| pvc
| dot-1x-session
| pvc-vlan-combination
| ppp-session
| ip-session
| ipoe-vlan-cc
| pppoe-vlan-cc
| ipoa-cc
| pppoa-cc
| ipoe-ibridge
| pppoe-ibridge
| pppoa-relay
| pppoe-relay
| ipoe-ip-aware-bridge
| ipoa-ip-aware-bridge )
Possible values:
- generic : any defined logical flow
- pvc : all frames on a pvc
- dot-1x-session : frames on a pvc except ppp frames
- pvc-vlan-combination : frames on dot-1D port with the
same vlan-id
- ppp-session : all frames on a ppp session
- ip-session : all frames in an IP session or interface
- ipoe-vlan-cc : all ipoe frames in a vlan cc interface
- pppoe-vlan-cc : all pppoe frames in a vlan cc interface
- ipoa-cc : all ipoa frames in a ipoa cc interface
- pppoa-cc : all pppoa frames in a pppoa cc interface
- ipoe-ibridge : all ipoe frames in i-bridge interface
- pppoe-ibridge : all pppoe frames in i-bridge interface
- pppoa-relay : pppoa frames in pppoa relay interface
- pppoe-relay : all pppoe frames in pppee relay with mac
concentration interface
- ipoe-ip-aware-bridge : ipoe frames in ip aware bridge
interface
- ipoa-ip-aware-bridge : all ipoa frames in ip aware bridge
interface
[no] up-policer Parameter type: <Qos::QosProfileName> optional parameter with default
Format: value: "none"
( none policer profile name applicable
| name : <Qos::IgnoredQosProfileName> ) on this session upstream
Possible values:
- none : no profile name to associate
Command Description
This command allows the operator to configure a list of upstream policies in a QoS session profile. The maximum
number of upstream policy rules is 16 per 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:
> configure qos profiles session (name) ( no up-policy (name) ) | ( up-policy (name) )
Command Parameters
Table 17.23-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.
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 17.24-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 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 17.25-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 17.25-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 17.26-1 "QoS Queue Threshold Crossing Alarm Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: physical port of a dsl 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 Parameter type: <Qos::TcaQueues> the queue with in the scope of
Format: one dsl link of tca
- output dsl port queue number
- range: [0...3]
Table 17.26-2 "QoS Queue Threshold Crossing Alarm Configuration Command" Command
Parameters
Parameter Type Description
[no] tca-enable Parameter type: boolean optional parameter
each queue statistic TCA of this
queue
[no] load-thresh Parameter type: <Qos::PercentThresh> optional parameter with default
Format: value: 0
- Percentage of the QoS Thresh The threshold of queue traffic
- range: [0...100] load.
[no] dis-frame-th Parameter type: optional parameter with default
<Qos::QosQueueStatsDiscFramesTcaThreshold> value: 0
Format: The threshold of discarded
- Qos thresh frames of this queue.
- range: [0...2147483647]
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 17.27-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 17.27-2 "QoS DSL Link Configuration Command" Command Parameters
Parameter Type Description
scheduler-profile Parameter type: <Qos::QosProfileName> optional parameter
Format: name of scheduler profile to be
( none mapped on this subscriber
| name : <Qos::IgnoredQosProfileName> ) interface.
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <Qos::IgnoredQosProfileName>
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 17.28-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 port queue number line-interface-module
- range: [0...3]
Table 17.28-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 17.29-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 17.29-2 "QoS ShdSL Link Configuration Command" Command Parameters
Parameter Type Description
scheduler-profile Parameter type: <Qos::ProfileName> optional parameter
Format: name of scheduler profile to be
name : <Qos::IgnoredQosProfileName> mapped on this dsl link
Possible values:
- name : enter profile name to be associated
Field type <Qos::IgnoredQosProfileName>
- name of the QoS profile
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 17.30-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 port queue number line-interface-module
- range: [0...3]
Table 17.30-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 or an Ethernet Line. For each Interface the operator can apply scheduling and CAC
settings.
A scheduler profile is used to configure egress scheduler settings for each egress Interface. A CAC profile is used
to configure CAC 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 17.31-1 "QoS Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: physical port of a user-port
<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 17.31-2 "QoS Interface Configuration Command" Command Parameters
Parameter Type Description
scheduler-profile Parameter type: <Qos::ProfileName> optional parameter
Format: the name of the scheduler profile
name : <Qos::IgnoredQosProfileName> to be mapped on this user-port
Possible values: Interface
- name : enter profile name to be associated
Field type <Qos::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64
cac-profile Parameter type: <Qos::ProfileName> optional parameter
Format: the name of the cac profile to be
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) 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.
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 17.32-1 "QoS Interface Queue Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: physical port of a user-port
<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 user-port
- output dsl port queue number Interface on a
- range: [0...3] line-interface-module
Table 17.32-2 "QoS Interface Queue Configuration Command" Command Parameters
Parameter Type Description
queue-profile Parameter type: <Qos::QosQueueProfileName> optional parameter
Format: name of the queue profile
name : <Qos::IgnoredQosProfileName>
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 17.33-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 17.33-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 17.34-1 "SHub QoS Queue Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: the unique id for the port
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Table 17.34-2 "SHub QoS Queue Configuration Command" Command Parameters
Parameter Type Description
[no] queue0-weight Parameter type: <Qos::ShubQueueWeight1> optional parameter with default
Format: value: 1
- the weight for the queue queue zero weight
- range: [1...15]
[no] queue1-weight Parameter type: <Qos::ShubQueueWeight1> optional parameter with default
Format: value: 2
- the weight for the queue queue one weight
- range: [1...15]
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 17.35-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 17.35-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 801.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::DisplayString> ] [ (old-type) ] [ no
type | type <Qos::FlowType> ] )
Command Parameters
Table 17.36-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 17.36-2 "SHub QoS Flow 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 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...4096]
Field type <Qos::VlanId>
- vlan id to detect the flow
- range: [0...4096]
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 17.37-1 "SHub QoS Policer Configuration Command" Resource Parameters
Resource Identifier Type Description
(port-id) Format: shub qos port index
<Shub::NetworkPort>
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 17.37-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 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.
The values 1 and 2 cannot be used as a meter index to configure a meter. If these values are used, the system
returns a "bad-value" 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:
> 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 17.38-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: [3...64]
Table 17.38-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...16383]
burst-size Parameter type: <Qos::MeterBurstSize> mandatory parameter
Format: max ingress burst size allowed
- ingress policer's burst tolerance
- range: [0...7]
Description
This chapter gives an overview of nodes that are handled by "VLAN Configuration Commands".
Command Tree
----configure
----vlan
- [no] broadcast-frames
- priority-policy
- pvid-usage
----[no] id
- (vlanid)
- [no] name
- mode
- [no] priority
- [no] broadcast-frames
- [no] protocol-filter
- [no] pppoe-relay
- [no] pppoe-relay-tag
- [no] dhcp-opt-82
- [no] circuit-id
- [no] circuit-id-dhcp
- [no] remote-id
- [no] remote-id-dhcp
- [no] dhcp-linerate
- [no] pppoe-linerate
- [no] circuit-id-pppoe
- [no] remote-id-pppoe
----[no] unicast-mac
- (unicast-mac)
- vlan-id
- forward-port
----[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] egress-port
- (port)
----[no] untag-port
- (port)
----[no] unicast-mac
- (unicast-mac)
- vlan-id
- forward-port
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. It 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 18.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 ethernet priority policy
( vlan-specific of upstream frames
| port-default )
Possible values:
- vlan-specific : the priority of the vlan
- port-default : the default priority of the port
pvid-usage Parameter type: <Vlan::PvidUsage> obsolete parameter that will be
Format: ignored
( c-vlan-translation multi-vlan service supports
| standard ) c-vlan translation
Possible values:
- c-vlan-translation : enable cvlan translation
- standard : disable cvlan translation
Command Description
This command allows the operator to specify a VLAN and its attributes. The following combination is not
allowed:pppoe-relay-tag=configurable, while circuit-id-pppoe and remote-id-pppoe are both notadd or
addcustomerid.
- broadcast-frames: 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 prioritypolicy at node level is
vlan-specific.
The vlan numbering space is the concatenation of an 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:
- 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)
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 18.3-1 "VLAN Configuration Command" Resource Parameters
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.
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 18.4-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: <Vlan::StackedVlan> vlan id
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
Table 18.4-2 "VLAN Filtering Database Configuration Command" Command Parameters
Parameter Type Description
forward-port Parameter type: <Itf::AtmInterfaceVpiVci> mandatory parameter
Command Description
For protocol-based VLANs, this node 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 18.5-1 "VLAN Protocol-based Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. atm PVC,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / EFM port,...)
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
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 18.6-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::AdminString> ] mode
<Shub::SystemMode> [ [ no ] mac-move-allow ] )
Command Parameters
Table 18.7-1 "SHub VLAN Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlanid) Format: vlan id
- vlan id
- range: [1...4093]
Table 18.7-2 "SHub VLAN Configuration Command" Command Parameters
Parameter Type Description
[no] name Parameter type: <Vlan::AdminString> 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
- layer2-term-nwport : layer2 terminated vlan on network
Command Output
Table 18.7-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 18.8-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> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
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
Field type <Shub::NoExtLink>
- unassigned external SFP port
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 18.9-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>
Possible values:
- network : network port
Field type <Shub::NetworkPort>
- network port on Shub
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 18.10-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 18.10-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 )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
Field type <Eqpt::RackId>
Description
This chapter gives an overview of nodes that are handled by "Bridge Configuration Commands".
Command Tree
----configure
----bridge
- ageing-time
----[no] port
- (port)
- [no] pvid
- [no] default-priority
- [no] mac-learn-off
- [no] max-unicast-mac
- [no] accept-frame-type
- [no] qos-profile
- [no] prio-regen-prof
----[no] vlan-id
- (index)
- (old-tag)
- [no] tag
- [no] network-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
----shub
- ageing-time
----port
- (network-port)
- [no] default-priority
- [no] pvid
- [no] accept-frame-type
- [no] enable-dual-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 19.2-2 "Bridge General Configuration Command" Command Parameters
Parameter Type Description
ageing-time Parameter type: <Vlan::AgingTime> optional parameter
Format: ageing timeout for dynamic mac
- ageing time entries
- unit: sec
- 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 : the system
accepts all values but no mac learning will be done.
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 <Vlan::StackedVlan> ] [ no default-priority |
default-priority <Vlan::Priority> ] [ [ no ] mac-learn-off ] [ no max-unicast-mac | max-unicast-mac
<Vlan::MaxMac> ] [ no accept-frame-type | accept-frame-type <Vlan::VlanFrameTypes> ] [ no qos-profile |
qos-profile <Vlan::QosProfileName> ] [ no prio-regen-prof | prio-regen-prof <Vlan::PrioRegenProfile> ] )
Command Parameters
Table 19.3-1 "Bridge Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. atm PVC,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / EFM port, ...)
<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>
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) [ (old-tag) ] [ no tag | tag
<Vlan::PortUntagStatus> ] [ no network-vlan | network-vlan <Vlan::StackedVlan> ] [ no vlan-scope | vlan-scope
<Vlan::VlanScope> ] [ no qos | qos <Vlan::QosPolicy> ] [ no qos-profile | qos-profile <Vlan::QosProfileName> ] [
[ 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 ] )
Command Parameters
Table 19.4-1 "Bridge Port to VLAN Association Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. atm PVC,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / EFM port, ...)
<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
(index) Format: vlan id
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
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 19.5-2 "SHub Bridge Configuration Command" Command Parameters
Parameter Type Description
ageing-time Parameter type: <Shub::AgingTime> optional parameter
Format: program ageing timeout for
- ageing time dynamic mac entries
- unit: sec
- 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 ] enable-pbit-mode ]
Command Parameters
Table 19.6-1 "SHub Bridge Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(network-port) Format: the network port
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Table 19.6-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]
[no] accept-frame-type Parameter type: <Shub::VlanFrameTypes> optional parameter with default
Format: value: "all"
( all accept frame types
| tagged )
Possible values:
- all : admit all frame types
- tagged : admit only vlan tagged
[no] enable-dual-tag Parameter type: boolean optional parameter
enable dual tag
[no] enable-pbit-mode Parameter type: boolean optional parameter
copy pbit mode
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 19.7-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 20.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. Note that a 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 port number
within the group, provided the operational state of the link is UP.
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 20.3-1 "Link Aggregation Group Configuration Command" Resource Parameters
Resource Identifier Type Description
(network-port) Format: interface index of network port
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Table 20.3-2 "Link Aggregation Group Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <Shub::AggName> optional parameter
Format: aggregate name
- char string
- length: x<=20
[no] link-up-down-trap Parameter type: boolean optional parameter
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 21.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 21.3-1 "SHub MSTP Instance configuration Command" Resource Parameters
Resource Identifier Type Description
(instance) Format: MSTP instance
- MSTP Instance
- range: [1...16]
Table 21.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 21.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 21.5-1 "SHub MSTP Port configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: isam network port
<Shub::MstpNetworkPort>
Field type <Shub::MstpNetworkPort>
- Network Port on Shub
Table 21.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
path-cost Parameter type: <Shub::MstpPathCost> optional parameter
Format: port path cost
- port path cost
- range: [1...200000000]
[no] edge-port Parameter type: boolean optional parameter
port state enabled for the MSTP
[no] admin-p2p Parameter type: <Shub::MstpAdminP2PPort> optional parameter with default
Format: value: "auto"
( force-true admin p2p status of the LAN
| force-false segment attached to the port
| auto )
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 21.6-1 "SHub MSTP Port-Instance configuration Command" Resource Parameters
Resource Identifier Type Description
(network-port) Format: isam network port
<Shub::MstpNetworkPort>
Field type <Shub::MstpNetworkPort>
- Network Port on Shub
instance Parameter type: <Shub::MstpInstance> mstp instance
Format:
- MSTP Instance
- range: [1...16]
Table 21.6-2 "SHub MSTP Port-Instance 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
path-cost Parameter type: <Shub::MstpPathCost> optional parameter
Format: port path cost
- port path cost
- range: [1...200000000]
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] 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] routing-option
----[no] route-map
- (dest-ip)
- source-proto
- (export)
- dest-proto
----preference
----route-type
- (index)
- value
----[no] route-dest
- (dest)
- next-hop
- vlan-id
- [no] metric
----arp
- [no] cache-timeout
- [no] cache-pending
- [no] cache-refresh
- [no] cache-retry-time
- [no] max-retry-itvl
- [no] max-retries
----vlan
- (vlanid)
- [no] gratuitous-arp
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 22.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 22.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 22.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 22.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 22.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::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
Table 22.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
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 22.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::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
(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 22.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
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 <Vlan::QosProfileName> ] )
Obsolete command, replaced by configure ip vrf (index) user-itf port.
Command Parameters
Table 22.7-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 22.7-2 "IP Interface User Bridge Port Configuration Command" Command Parameters
Parameter Type Description
[no] qos-profile Parameter type: <Vlan::QosProfileName> optional parameter with default
Format: value: "none"
( none qos profile name
| name : <Vlan::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <Vlan::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64
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 22.8-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 22.9-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) )
Command Parameters
Table 22.10-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 22.10-2 "IP SHub VRF Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <Vrf::ShubVrfName> mandatory 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 some help
| fast-path-mode : dis-user-user-com
| 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
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 22.11-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 22.11-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
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> ]
Command Parameters
Table 22.12-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 22.12-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 22.13-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 22.13-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 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 22.14-2 "IP SHub ARP Configuration Command" Command Parameters
Parameter Type Description
[no] cache-timeout Parameter type: <Ip::ArpCacheTimeOut> optional parameter with default
Format: value: 7200
- time after which the entry in cache is removed time after which the entry in
- range: [30...86400] cache is removed
[no] cache-pending Parameter type: <Ip::ArpCachePendingTime> optional parameter with default
Format: value: 30
- time an unresolved entry will be held in cache time an unresolved entry will be
- range: [30...3000] held in cache
[no] cache-refresh Parameter type: <Ip::ArpCacheRefreshTime> optional parameter with default
Format: value: 90
- refresh interval for next hop ARP cache entries. refresh interval for next hop ARP
- range: [30...3600] cache entries
[no] cache-retry-time Parameter type: <Ip::ArpCacheRetryTime> optional parameter with default
Format: value: 1
- retry time for next hop ARP cache entries retry time for next hop ARP
- range: [1...60] cache entries
[no] max-retry-itvl Parameter type: <Ip::ArpCacheMaxRetryTime> optional parameter with default
Format: value: 3600
- max retry time for next hop ARP cache entries max retry time for next hop ARP
- range: [600...18000] cache entries
[no] max-retries Parameter type: <Ip::ArpMaxRetries> optional parameter with default
Format: value: 3
- 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 22.15-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 22.15-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
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] cac-disable
- [no] ip-anti-spoof-dis
- [no] igmp-version
----[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
----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
- 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
----response-timer
- (vlan-id)
- [no] leave-rsp-timer
----[no] vlan-router-port
- (vlan-id)
- network-port
- [no] state
----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
Command Description
This command allows the operator to configure pre-configured IGMP source 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 23.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> )
Possible values:
- vlan : vlan port
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 IGMP channel permission package members.
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.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> )
Possible values:
- vlan : vlan port
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 the IGMP channel preview package members.
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 "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> )
Possible values:
- vlan : vlan port
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 IGMP package bitmaps. The package is intended primarily for use
by a network/element manager, such as an AWS, 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 23.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 23.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 23.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
- unit: 1/10 sec advertised in queries 1/10 sec
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 23.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 intermediate CDR generation
- unit: min period
- range: [0...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 23.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 23.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 23.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> optional parameter
Format: specifies what will be traced
- a signed integer
[no] router-purge-intv Parameter type: <Igmp::RouterInterval> optional parameter with default
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 23.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 23.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 23.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:
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Table 23.11-2 "SHub IGMP Router Port Configuration Command" Command Parameters
Parameter Type Description
[no] state Parameter type: <Igmp::VlanRouterPortConfigStatus> optional parameter with default
Format: value: "static"
static config status of the vlan router
Possible values: port
- static : configure static port
Command Description
This command allows the operator to configure the VLAN filter status to enable or disable IGMP snooping on that
specific 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 23.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 23.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
[no] igmp-version Parameter type: <Igmp::VlanVersion> optional parameter with default
Format: value: "3"
(2 version of IGMP protocol for
|3) Vlan
Possible values:
- 2 : IGMPv2 of the vlan
- 3 : IGMPv3 of the vlan
[no] operation-mode Parameter type: <Igmp::VlanMode> optional parameter with default
Format: value: "proxyreorting"
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 23.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 23.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 23.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 23.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
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
----[no] src
- (class-d-addr)
- [no] dis-fast-change
- [no] pkg-mem-bitmap
- [no] name
- [no] guaranteed-serv
- [no] atm-peak-bit-rate
- [no] eth-peak-bit-rate
- [no] atm-sus-bit-rate
- [no] eth-sus-bit-rate
- vlan-id
- [no] service-name
- [no] preview-duration
- [no] preview-number
- [no] preview-blackout
----[no] packagemember
- (package)
----shub
- [no] 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 24.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 :
- a binary string ff"
- length: 8 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]
[no] mean-bit-rate Parameter type: <Igmp::GeneralMcastMeanBitRate> optional parameter with default
Format: value: 2500
- reasonable mean bitrate in ATM level for upstream reasonable downstream mean
- 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 vlan privileges, and executed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 24.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 24.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 no of grps the system supports in
- range: [0...1024] 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 no of uncfg grps the system
- range: [0...128] 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
This command allows the operator to configure 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 24.5-1 "Multicast Sources Configuration Command" Resource Parameters
Resource Identifier Type Description
(class-d-addr) Format: mcast src address in network-byte
- multicast-address (range: 224.0.0.3....239.255.255.255) order(big-endian)
Table 24.5-2 "Multicast Sources 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"
- length: 8 indicates to which package(s) a
class D address belongs
[no] name Parameter type: <Igmp::multicastSrcName> optional parameter with default
Format: value: ""
- a printable string name of the source
- length: x<=32
[no] guaranteed-serv Parameter type: boolean optional parameter
enable guaranteed service
[no] atm-peak-bit-rate Parameter type: <Igmp::McastSrcAtmPeakBitRate> obsolete parameter replaced by
Format: parameter "eth-peak-bit-rate"
Command Description
This command allows the operator to configure the multicast source package members.
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 24.6-1 "Multicast Sources Package Members Configuration Command" Resource Parameters
Resource Identifier Type Description
(class-d-addr) Format: mcast src address in network-byte
- multicast-address (range: 224.0.0.3....239.255.255.255) order(big-endian)
(package) Format: package member
- the package number
- range: [1...1024]
Command Description
This command displays the egress ports to which the traffic related to the specified multicast IP address is to be
forwarded. The command applies to dynamic and static-dynamic multicast streams.
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 24.7-2 "SHub Dynamic and Static-Dynamic Multicast Egress Port Show Command"
Command Parameters
Parameter Type Description
[no] active-streams Parameter type: <Igmp::MaxMcastLearn> optional parameter with default
Format: value: 0
- 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 24.8-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 24.9-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>
| unassigned-link : <Shub::NoExtLink> )
Possible values:
- lt : line board
- network : network port
- unassigned-link : unassigned external link
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
Field type <Shub::NoExtLink>
- unassigned external SFP port
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 24.10-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 24.10-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] max-payload-tag
- [no] name
- [no] lock
- [no] service-name
----[no] monitor
----[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 ppoe privileges, and executed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 25.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
- maximum age of PPP cross-connection maximum age of PPP cross
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 ppoe privileges, and executed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 25.3-1 "PPPoX Cross-connect Engine Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan identity
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
Table 25.3-2 "PPPoX Cross-connect Engine Configuration Command" Command Parameters
Parameter Type Description
[no] max-payload-tag Parameter type: <PPPoX::MaxPayLoadTag> optional parameter with default
Format: value: "no-insert"
( insert insert:add tag holding the MRU
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 ppoe privileges, and executed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 25.4-1 "PPPoX Cross-connect Engine Monitoring Configuration Command" Resource
Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan identity
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
Command Description
This command allows the operator to specify the PPP cross-connect client port.
User Level
The command can be accessed by operators with ppoe privileges, and executed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect ( no client-port (port) ) | ( client-port (port) vlan-id <Vlan::StackedVlan>
default-priority <PPPoX::DefaultPriority> [ no max-cc | max-cc <PPPoX::MaxNumPppCc> ] [ no qos-profile |
qos-profile <PPPoX::QosProfileName> ] )
Command Parameters
Table 25.5-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> )
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 25.5-2 "PPPoX Cross-connect Client Port Configuration Command" Command Parameters
Parameter Type Description
vlan-id Parameter type: <Vlan::StackedVlan> mandatory parameter
Format: The parameter is not visible
( <Vlan::UVlanIndex> during modification.
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> ) associates client port to cc-engine
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 ppoe privileges, and executed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 25.6-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> )
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
Description
This chapter gives an overview of nodes that are handled by "PPPoE Configuration Commands".
Command Tree
----configure
----pppoe
- server-name
- [no] enable-server
----[no] ppp-profile
- (index)
- [no] auth-type
- [no] keep-alive-intvl
----[no] pppox-interface
- (port)
- [no] max-num-session
- [no] ppp-profile-name
Command Description
This command allows the operator to configure the PPPoE access concentrator and admin state.
The access concentrator (server name) is used to send the AC_NAME tag in the PADO that is sent to the host. The
default AC name is set to AlcatelPppoeServer.
The server admin state, when disabled, locks the PPPoE server and no more new PPPoE sessions are established.
When the server admin state is set to disabled from the enabled state, the existing PPPoE sessions are not torn
down.
User Level
The command can be accessed by operators with ppoe privileges, and executed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.2-2 "PPPoE Server Configuration Command" Command Parameters
Parameter Type Description
server-name Parameter type: <PPPoE::ServerName> optional parameter
Format: name of the access server
- name of the access server
- length: 1<=x<=32
[no] enable-server Parameter type: boolean optional parameter
enable PPPoE server
Command Description
This command allows the operator to configure PPP profile parameters.
User Level
The command can be accessed by operators with ppoe privileges, and executed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.3-1 "PPPoE Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: name of the profile
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Table 26.3-2 "PPPoE Profile Configuration Command" Command Parameters
Parameter Type Description
[no] auth-type Parameter type: <PPPoE::pppProfileAuthenType> optional parameter with default
Format: value: "chap"
( pap the type of PPP authentication
| chap used
| pap-chap
| chap-pap )
Possible values:
- pap : only PAP negotiation
- chap : only CHAP negotiation
- pap-chap : negotiate PAP first, if it fails, attempt CHAP
- chap-pap : negotiate CHAP first, if it fails, attempt PAP
[no] keep-alive-intvl Parameter type: <PPPoE::ProfileKeepAliveInterval> optional parameter with default
Format: value: 30
- timeout value for echo req pkt keepalive timeout value, after
- unit: sec sending echo request pckt
- range: [0...65535]
Command Description
This command allows the operator to configure PPP sessions.
Note:Configuring max-num-sessions to -1 means, maximum PPPoE sessions as allowed by the system can be
established.
User Level
The command can be accessed by operators with ppoe privileges, and executed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 26.4-1 "PPPoX Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: configure the pppox interafce
( bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<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::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> )
Possible values:
- bridge-port : bridge port
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Description
This chapter gives an overview of nodes that are handled by "DHCP Relay Configuration Commands".
Command Tree
----configure
----dhcp-relay
----agent
- (vrfid)
- bcast-vlan
- [no] option-82
- [no] circuit-id
- [no] remote-id
- [no] client-hw-address
- [no] dhcp-linerate
----shub
- [no] relaying
----[no] server
- (index)
- ip-addr
- server-name
----agent
- (index)
- [no] enable-relaying
- [no] secs-threshold
- [no] hops-threshold
- [no] context-lifetime
- [no] agent-ip-addr
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 27.2-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 27.2-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 27.3-2 "DHCP Relay SHub Configuration Command" Command Parameters
Parameter Type Description
[no] relaying Parameter type: boolean optional parameter
enable relay agent
Command Description
This command allows the operator to configure the list of DHCP relay servers 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:
> configure dhcp-relay shub ( no server (index) ip-addr <Ip::V4Address> ) | ( server (index) ip-addr
<Ip::V4Address> server-name <Dhcp::RelayServerName> )
Command Parameters
Table 27.4-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 given to this interface
Format:
- IPv4-address
Table 27.4-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 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 27.5-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 27.5-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
- relay hops 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: [1...16] go through
[no] context-lifetime Parameter type: <Dhcp::ContextLife> optional parameter with default
Format: value: 30
- application context life-time for this vrf availability of application context
- unit: seconds
- range: [1...120]
[no] agent-ip-addr Parameter type: <Ip::V4Address> optional parameter with default
Format: value: "0.0.0.0"
Description
This chapter gives an overview of nodes that are handled by "OSPF Configuration Commands".
Command Tree
----configure
----ospf
- [no] enable
- router-id
- [no] as-border-router
- [no] enable-opaque-lsa
- [no] overflow-state-it
- [no] dis-rfc1583-comp
- [no] abr-type
- [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
- 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
- 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
- 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 28.2-2 "OSPF Parameters Configuration Command" Command Parameters
Parameter Type Description
[no] enable Parameter type: boolean optional parameter
enables OSPF on the SHub
router-id Parameter type: <Ip::V4Address> optional parameter
Format: uniquely identifying the Shub in
- IPv4-address 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: 0
- interval the router is in overflow state time the router attempts to leave
- unit: sec the overflow state
- range: [0...65535]
[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
- ibm : ibm 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 28.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 28.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 28.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 interface as 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
- point-point : point to point
- point-multipoint : point to multi point
[no] authentication Parameter type: <Ospf::AuthType> optional parameter with default
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 28.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 28.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 28.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...5]
Table 28.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::Key> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Ospf::Key>
- authentication key
- length: x<=8
[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 28.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 [ value <Ospf::Metric> ]
Command Parameters
Table 28.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 28.7-2 "OSPF Interface Metric Configuration Command" Command Parameters
Parameter Type Description
value Parameter type: <Ospf::Metric> optional parameter
Format: the value for the metric
- metric dependent on TOS
- 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 28.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 28.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.
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 28.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 28.9-2 "OSPF External Aggregate Configuration Command" Command Parameters
Parameter Type Description
[no] advertise Parameter type: <Ospf::ExtAggregateEffect> optional parameter with default
Format: value: "advertise"
( enable advertisement of the indicated
| disable aggregate
| allow-all
| deny-all )
Possible values:
- enable : advertise the aggregate information of the subnet
- disable : do not advertise the aggregate information of the
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 28.10-1 "OSPF Stub Area Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
Table 28.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
Possible values: default route
- ospf : ospf metric
[no] metric Parameter type: <Ospf::StubMetric> optional parameter with default
Format: value: 0
- metric value at the indicated TOS metric value at the indicated TOS
- 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 28.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 28.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 interface as 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
- point-point : point to point
- point-multipoint : point to multi point
[no] authentication Parameter type: <Ospf::AuthType> optional parameter with default
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 28.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 28.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 28.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...5]
Table 28.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::Key> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Ospf::Key>
- authentication key
- length: x<=8
[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 28.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 [ value <Ospf::Metric> ]
Command Parameters
Table 28.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 28.14-2 "OSPF Interface Metric Configuration Command" Command Parameters
Parameter Type Description
value Parameter type: <Ospf::Metric> optional parameter
Format: the value for the metric
- metric dependent on TOS
- 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 28.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 28.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::NSSAMetricType> ] )
Command Parameters
Table 28.16-1 "OSPF NSSA Area Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
Table 28.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::NSSAMetricType> 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 28.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 28.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 interface as 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
- point-point : point to point
- point-multipoint : point to multi point
[no] authentication Parameter type: <Ospf::AuthType> optional parameter with default
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 28.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 28.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 28.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...5]
Table 28.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::Key> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Ospf::Key>
- authentication key
- length: x<=8
[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 28.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 [ value <Ospf::Metric> ]
Command Parameters
Table 28.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 28.20-2 "OSPF Interface Metric Configuration Command" Command Parameters
Parameter Type Description
value Parameter type: <Ospf::Metric> optional parameter
Format: the value for the metric
- metric dependent on TOS
- range: [1...65535]
Command Description
This command allows the operator to configure an OSPF NSSA 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:
> 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 28.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 28.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.
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 28.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 28.22-2 "OSPF External Aggregate Configuration Command" Command Parameters
Parameter Type Description
[no] advertise Parameter type: <Ospf::ExtAggregateEffect> optional parameter with default
Format: value: "advertise"
( enable advertisement of the indicated
| disable aggregate
| allow-all
| deny-all )
Possible values:
- enable : advertise the aggregate information of the subnet
- disable : do not advertise the aggregate information of the
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 28.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 28.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 28.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
----rip
- [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
----timers
- [no] update-timer
- [no] route-age-out
- [no] junk-collection
----[no] md5-key
- (index)
- key
- starts
- expires
----[no] aggregation
- (ip-addr)
----[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 29.2-2 "RIP Common Configuration Command" Command Parameters
Parameter Type Description
[no] max-peer Parameter type: <Rip::Rip2Peer> optional parameter with default
Format: value: 25
- 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 29.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...6] 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> ] )
Command Parameters
Table 29.4-1 "RIP Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: interface IP address
- IPv4-address
Table 29.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: The parameter is not visible
- default metric during modification.
- range: [0...15] metric used for default route in
RIP updates
[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 29.5-1 "RIP Interface Timers Configuration Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: interface IP address
- IPv4-address
Table 29.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 29.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: [1...5]
Table 29.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
| <Rip::MD5startDelay> )
Possible values:
- now : the key will be used from now on
Field type <Rip::MD5startDelay>
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 29.7-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
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 ] )
Command Parameters
Table 29.8-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 29.8-2 "RIP Route Map Command" Command Parameters
Parameter Type Description
ip-addr Parameter type: <Ip::AddressAndIpMaskFull> mandatory parameter
Format: IP address of subnet that can be
<Ip::V4Address> / <Ip::PrefixLengthFull> allowed/disallowed
Field type <Ip::V4Address>
- IPv4-address
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 Direction in which the RIP routes
Possible values: are advertised.
- transmit : route map in transmitting direction
[no] deny Parameter type: boolean optional parameter
deny route map
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 node 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 30.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 namer 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 node 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 30.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 node 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 30.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 node 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 30.5-1 "Cluster Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) Format: index of a port
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Table 30.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] active
----group
- (bonding-group-idx)
- [no] group-profile
- [no] admin-up
- [no] admin-status
----[no] link
- (bonding-link-id)
Command Description
This node provides the provisioning of the bonding group assembly timeout. Default value is zero ('0'), and is
interpreted as disabling the timer.
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 31.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
Command Description
This node 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::Bitrate> ] [ no min-bitrate-down |
min-bitrate-down <Xdsl::Bitrate> ] [ no plan-bitrate-up | plan-bitrate-up <Xdsl::Bitrate> ] [ no plan-bitrate-down |
plan-bitrate-down <Xdsl::Bitrate> ] [ no max-bitrate-up | max-bitrate-up <Xdsl::Bitrate> ] [ no max-bitrate-down |
max-bitrate-down <Xdsl::Bitrate> ] [ 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::SignedIntegerSYMBOL> ] [ no imp-noise-prot-up | imp-noise-prot-up <Xdsl::SignedIntegerSYMBOL> ] [
[ no ] active ] )
Command Parameters
Table 31.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 31.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-_.]
- length: 1<=x<=32
(scope) Format: mandatory parameter
Command Description
This node allows to configure a bonding group, which consists of assigning a predefined bonding group profile.
Configuring bonding group will fail if ATM PVCs are configured on any of the DSL lines in 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 31.4-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 31.4-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>
- bonding group profile index
- range: [0...100]
Field type <PrintableString>
Command Output
Table 31.4-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.
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 31.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
(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
Description
This chapter gives an overview of nodes that are handled by "CPE Remote Configuration Commands".
Command Tree
----configure
----cpe-management
- [no] proxy-mode
- [no] vlan-id
----[no] manager
- (address)
----[no] session
- (dslport)
- [no] connection
----shub
----[no] vlan-id
- (vlan-id)
Command Description
This node 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 32.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
| ip )
Possible values:
- snmp : this mode is relaying SNMP messages
- none : disables the cpeproxy
- ip : enables the ipproxy mode
[no] vlan-id Parameter type: <CpeProxy::VlanIndex> optional parameter with default
Format: value: "0"
- 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 32.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
This command allows to configure a ipproxy session.
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 32.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 32.4-2 "CPE IPProxy Session Configuration Command " Command Parameters
Parameter Type Description
[no] connection Parameter type: optional parameter with default
<CpeProxy::cpeIpProxySessionProtocolPort> value: 0
Format: protocol port for ipproxy session.
- 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 32.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
----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.
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 33.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>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 33.2-2 "SHDSL Span Configuration Command" Command Parameters
Parameter Type Description
[no] active Parameter type: boolean optional parameter
set the span-profile active
[no] admin-up Parameter type: boolean optional parameter
admin status is up
[no] repeaters Parameter type: <Shdsl::SpanConfNumRepeaters> optional parameter with default
Format: value: 0
- the number of SRUs to be configured for this span number of repeaters
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 33.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 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
Table 33.3-2 "SHDSL Unit Configuration Command" Command Parameters
Parameter Type Description
[no] loop-attenuation Parameter type: <Shdsl::UnitLoopAttenThreshold> optional parameter with default
Format: value: 0
- a loop attenuation threshold value for an SHDSL unit the loop attenuation threshold
- unit: db value
- range: [0...127]
[no] snr-margin Parameter type: <Shdsl::UnitSnrMarginThreshold> optional parameter with default
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 33.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 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
side Parameter type: <Shdsl::SegmentSide> the particular side of an SHDSL
Format: unit in an SHDSL segment
( network
| customer )
Possible values:
- network : the network side
- customer : the customer side
Table 33.4-2 "SHDSL Segment Configuration Command" Command Parameters
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 34.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 34.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 34.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 34.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 "L2CP Configuration Commands".
Command Tree
----configure
----l2cp
----[no] session
- (index)
- bras-ip-address
- [no] gsmp-version
- [no] gsmp-sub-version
- [no] encap-type
- [no] topo-discovery
- [no] layer2-oam
- [no] alive-timer
- [no] port-reprt-shaper
- [no] aggr-reprt-shaper
- [no] tcp-retry-time
- [no] gsmp-retry-time
- [no] dslam-name
- [no] window-size
- [no] tcp-port
- [no] vrf-id
Command Description
This command allows the operator to configure the L2CP session parameters for a given session id.
In current version, ISAM supports L2CP only on top of TCP/IP; as result of this command, ISAM shall start a TCP
connection to a BRAS identified by a configured IP address. Then depending on the setting of the GSMP Retry
Timer, the ISAM shall start the GSMP Adjacency Protocol to setup a L2CP session with that BRAS.
This means:
if TCP Retry Timer is zero, ISAM shall not start the TCP connection. If TCP Retry Timer is not zero, ISAM
shall start the setup of a TCP connection to a BRAS whose IP address must be configured too. In no way the
ISAM accepts that a (unknown) BRAS tries to start a TCP connection
if GSMP Retry Timer is zero, ISAM shall not start the GSMP Adjacency Protocol but instead be prepared to
handle GSMP Adjacency Protocol messages from that BRAS. If GSMP Retry Timer is not zero, ISAM shall start
the GSMP Adjacency Protocol in addition to being prepared to handle GSMP Adjacency Protocol messages
from that BRAS
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 l2cp ( no session (index) ) | ( session (index) bras-ip-address <L2cp::InetAddress> [ no gsmp-version |
gsmp-version <L2cp::Version> ] [ no gsmp-sub-version | gsmp-sub-version <L2cp::SubVersion> ] [ no encap-type
| encap-type <L2cp::EncapType> ] [ no topo-discovery | topo-discovery <L2cp::AccessTopologyDiscovery> ] [ no
layer2-oam | layer2-oam <L2cp::Layer2OAM> ] [ no alive-timer | alive-timer <L2cp::AliveTimer> ] [ no
port-reprt-shaper | port-reprt-shaper <L2cp::ReportShaper> ] [ no aggr-reprt-shaper | aggr-reprt-shaper
<L2cp::AggrReportShaper> ] [ no tcp-retry-time | tcp-retry-time <L2cp::TcpRetryTimer> ] [ no gsmp-retry-time |
gsmp-retry-time <L2cp::GsmpRetryTimer> ] [ no dslam-name | dslam-name <L2cp::DslamName> ] [ no
window-size | window-size <L2cp::WindowSize> ] [ no tcp-port | tcp-port <L2cp::InetPortNumber> ] [ no vrf-id |
vrf-id <L2cp::VrfIndex> ] )
Command Parameters
Table 35.2-1 "L2CP Session Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index to the l2cp session table
- identity of the l2cp session
- range: [1...255]
Table 35.2-2 "L2CP Session Configuration Command" Command Parameters
Parameter Type Description
bras-ip-address Parameter type: <L2cp::InetAddress> mandatory parameter
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
- [no] address
- [no] port
- [no] server_type
----[no] user-agent-dhcp
- (name)
- associated-slot
- associated-proxyserver
- associated-regserver
- associated-dialplan
- [no] user-agent-domain
- [no] admin-status
- [no] port
- vlan-id
- [no] signal-dscp
- [no] signal-pbits
- [no] rtp-dscp
- [no] rtp-pbits
----[no] user-agent-manual
- (name)
- associated-slot
- associated-proxyserver
- associated-regserver
- associated-dialplan
- [no] user-agent-domain
- [no] admin-status
- ip-address
- prefix-length
- gateway-ip
- domain-server
- [no] port
- vlan-id
- [no] signal-dscp
- [no] signal-pbits
- [no] rtp-dscp
- [no] rtp-pbits
----[no] dialplan
- (name)
- [no] pre-activated
- [no] static-prefix
- [no] static-suffix
----[no] digitmap
- (name)
- type
- rule
- [no] access-type
----[no] termination
- (termination)
- user-agent
- directory-number
- [no] user-name
- [no] uri
- [no] direct-uri
- [no] line-feed
- [no] md5-realm
- [no] md5-password
- [no] admin-status
----local-loop
- [no] unbundle
Command Description
This command allows the operator to manage the Voice Sip Server 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:
> configure voice sip ( no server (name) ) | ( server (name) [ no admin-status | admin-status
<Sip::ServerAdminStatus> ] [ no address | address <Sip::ServerAddr> ] [ no port | port <Sip::ServerPort> ] [ no
server_type | server_type <Sip::ServerType> ] )
Command Parameters
Table 36.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: 1<=x<=32
Table 36.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
[no] address Parameter type: <Sip::ServerAddr> optional parameter with default
Format: value: "ipv4"
( ipv4 : <Ip::V4Address> The address(ipv4 or dns) of this
| dns : <Sip::ServerAddr> ) sip server
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>
- address of this voice server
- length: 7<=x<=64
[no] port Parameter type: <Sip::ServerPort> optional parameter with default
Format: value: 5060
Command Description
This command allows the operator to manage the Voice Sip user agent profile by dhcp.
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 "Voice Sip User Agent Configuration Commands by dhcp" Resource Parameters
Resource Identifier Type Description
(name) Format: uniquely identify of this user
- uniquely identifies the User Agent agent
- length: x<=32
Table 36.3-2 "Voice Sip User Agent Configuration Commands by dhcp" Command Parameters
Parameter Type Description
associated-slot Parameter type: <Equipm::LtSlotIndex> mandatory parameter
Format: slot associated with this user
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> agent
| <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
associated-proxyserver Parameter type: <Sip::Server> mandatory parameter
Format: sip proxy server name that
( none associated with this user agent
| name : <Sip::ServerName> )
Command Output
Table 36.3-3 "Voice Sip User Agent Configuration Commands by dhcp" Display parameters
Specific Information
name Type Description
mode Parameter type: <Sip::ConfigMode> The config mode of the sip user
( dhcp agent
| manual ) This element is only shown in
Possible values: detail mode.
- dhcp : sip user agent config mode is dhcp
- manual : sip user agent config mode is manual
Command Description
This command allows the operator to manage the Voice Sip user agent profile by manual.
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.4-1 "Voice Sip User Agent Configuration Commands by Manual" Resource Parameters
Resource Identifier Type Description
(name) Format: uniquely identify of this user
- uniquely identifies the User Agent agent
- length: x<=32
Table 36.4-2 "Voice Sip User Agent Configuration Commands by Manual" Command Parameters
Parameter Type Description
associated-slot Parameter type: <Equipm::LtSlotIndex> mandatory parameter
Format: slot associated with this user
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> agent
| <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
associated-proxyserver Parameter type: <Sip::Server> mandatory parameter
Format: sip proxy server name that
( none associated with this user agent
Command Output
Table 36.4-3 "Voice Sip User Agent Configuration Commands by Manual" Display parameters
Specific Information
name Type Description
mode Parameter type: <Sip::ConfigMode> The config mode of the sip user
( dhcp agent
| manual ) This element is only shown in
Possible values: detail mode.
- dhcp : sip user agent config mode is dhcp
- manual : sip user agent config mode is manual
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 xdsl privileges, and executed by operators with xdsl 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> ] )
Command Parameters
Table 36.5-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 36.5-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
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 xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 36.6-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<=32
Table 36.6-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 xdsl privileges, and executed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 36.7-1 "Voice Sip Termination Configuration Commands" Resource Parameters
Resource Identifier Type Description
(termination) 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 36.7-2 "Voice Sip Termination Configuration Commands" Command Parameters
Parameter Type Description
user-agent Parameter type: <Sip::UserAgentName> mandatory parameter
Format: The parameter is not visible
- uniquely identifies the User Agent during modification.
- length: x<=32 sip user agent name associated
with this termination
directory-number Parameter type: <Sip::TermDnumber> mandatory parameter
Format: identify the domain number of
- identify the DN of the subscriber line the subscriber line
Command Description
This command allows the operator to configure voice SIP port Local Loop Unbundling.
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.8-1 "voice sip Local Loop Unbundling Configuration Command" Resource Parameters
Resource Identifier Type Description
(termination) 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 36.8-2 "voice sip Local Loop Unbundling Configuration Command" Command Parameters
Parameter Type Description
[no] unbundle Parameter type: boolean optional parameter
Enable LLU Relay
Description
This chapter gives an overview of nodes that are handled by "Debug Configuration Commands".
Command Tree
----configure
----debug
----[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.
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 37.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> : <Debug::VpiId> :
<Debug::VciId>
| shdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Debug::PortId>
| ethernet-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Debug::PortId> )
Possible values:
- dsl-line : the xDSL line
- atm-pvc : the PVC of the ADSL line
- shdsl-line : a static shdsl line interface
- ethernet-line : an ethernet line interface
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Debug::PortId>
- the portId
Field type <Debug::VpiId>
- the virtual path id
Field type <Debug::VciId>
Description
This chapter gives an overview of nodes that are handled by "Ethernet User Ports Configuration Commands".
Command Tree
----configure
----ethernet
----line
- (if-index)
----tca-line-threshold
- [no] enable
- [no] los
- [no] fcs
- [no] los-day
- [no] fcs-day
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 38.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
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:
Command Parameters
Table 38.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 38.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::IntervalTcaThreshold> optional parameter with default
Format: value: 0
- the tca threshold for errored second, 0 - disable loss of signal error in 15 minute
- range: [0...900]
[no] fcs Parameter type: <ETHITF::IntervalTcaThreshold> optional parameter with default
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)
----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 only.
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 Printed Board Assembly code of the unit.
inventory-fpba: provides the Alcatel 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 39.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
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
Command Output
Table 39.2-2 "Slot Status Command" Display parameters
Specific Information
name Type Description
planned-type Parameter type: <Equipm::BoardType> 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::BoardType> 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
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 39.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 39.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 Printed Board Assembly code of the applique.
inventory-fpba: provides the Alcatel 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 39.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::SlotId> )
Possible values:
- iont : an nt applique slot
- lp : an lt applique slot
Field type <Eqpt::RackId>
- the rack number
Command Output
Table 39.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
| unknown-error )
Possible values:
- no-error :
- type-mismatch :
- board-missing :
- no-installation :
- no-planned-board :
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 39.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 39.5-2 "Shelf Summary Status Command" Display parameters
Specific Information
name Type Description
changes Parameter type: <Counter> Number of configuration or status
- 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 39.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 39.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 39.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 39.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 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 39.8-1 "External-link-host Status Commands" Resource Parameters
Resource Identifier Type Description
(faceplate-number) Format: the external-link faceplate
- the external link faceplate number number
- range: [2...17]
Command Output
Table 39.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
- the shub port which the host external link is connected to external link is connected to
- range: [1...24] 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 )
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 39.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 39.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 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 39.10-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 )
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)
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 )
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)
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 39.11-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 39.11-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 39.12-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 39.12-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 "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 40.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 40.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)
----plug-in-unit
- (index)
----atm
- (index)
----ether-itf
- (index)
----sw-mgmt
- (index)
----xdsl
----misc
- (index)
----near-end
- (index)
----far-end
- (index)
----xdsl-tca
- (index)
----eo-conversion
- (index)
----authentication
- (index)
----bonding-group
- (index)
----ipox
- (index)
----redundancy
- (index)
----custom
- (index)
----sfp
- (index)
----llu-relay
- (index)
----custom-ext-alarm
- (index)
----plug-in-unit-ext
- (index)
----sip-user-agent
- (index)
----sip-plugin-unit
- (index)
----sip-termination
- (index)
----shdsl
- (index)
----shdsl-isam
- (index)
----ima-group
- (index)
----ima-link
- (index)
----ether-tca
- (index)
----ether-sfp
- (index)
----qos-slot
- (index)
----qos-queue
- (index)
----filetransfer
- (index)
----l2forward
- (index)
----external-device
- (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 41.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 41.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
| plugin-unit
| atm
| custom
| ima-group
| ima-link
| redundancy
| shdsl
| ether-itf
| traffic-overflow
| queue-counter
| temporal
| spatial
| software-mngt
| xdsl
| xdsl-tca
| eo-conv
| authentication
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 41.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 41.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
nt-disk Parameter type: <Alarm::ntDiskSpace> current status of nt disk space is
( ( ninty-perc-full | 90%-full ) 90% full or less than that
| ( less-than-ninty-perc | less-than-90% ) ) This element is only shown in
Possible values: detail mode.
- ninty-perc-full : NT disk space is 90% full
- 90%-full : NT disk space is 90% full
- less-than-ninty-perc : NT disk space usage less that 90%
- less-than-90% : NT disk space usage less that 90%
prev-status Parameter type: <Alarm::ntDiskSpace> status of nt disk space with its
( ( ninty-perc-full | 90%-full ) previous logged value.
| ( less-than-ninty-perc | less-than-90% ) ) This element is only shown in
Possible values: detail mode.
- ninty-perc-full : NT disk space is 90% full
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 41.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 41.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 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 41.5-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 41.5-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: <Equipm::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.
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
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 41.6-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 41.6-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 41.7-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 41.7-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 41.8-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 41.8-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.
nt-position Parameter type: <Equipm::NtSlotIndex> identifies the physical position of
( nt-a the slot
| nt-b ) This element is only shown in
Possible values: detail mode.
- nt-a : nt-a slot
- nt-b : nt-b slot
Only Show Details: current and previous alarm log status
name Type Description
sw-rollback Parameter type: <Alarm::SwRollback> specifies implicit software
( yes rollback is performed or not.
| no ) This element is only shown in
Possible values: detail mode.
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 41.9-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 41.9-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 41.10-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 41.10-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 41.11-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 41.11-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 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 41.12-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 41.12-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: <Equipm::PortIndex> 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 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 41.13-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 41.13-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 41.14-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 41.14-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
vrf-assignment Parameter type: <Alarm::VRFassignment> specifies whether VRF for a user
short name: vrf-assign ( failed session is assigned or failed
| successful ) This element is only shown in
Possible values: detail mode.
- failed : failure to assign a VRF for a user session
- successful : assigned a VRF for a user session
prev-status Parameter type: <Alarm::VRFassignment> status of vrf-assignment with its
( failed previous logged value.
| successful ) This element is only shown in
Possible values: detail mode.
- failed : failure to assign a VRF for a user session
- successful : assigned a VRF for a user session
vlan-assignment Parameter type: <Alarm::VLANassignment> specifies whether a VLAN for a
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 41.15-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 41.15-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 group
( reached-threshold upstream planned bit rate is
Command Description
This command displays the IPoX 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 41.16-1 "IPoX 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 41.16-2 "IPoX Alarm Log Status Command" Display parameters
Specific Information
name Type Description
ip-addr-pool Parameter type: <Alarm::IPAddrPoolPreempt> specifies whether the ip addr pool
( preempted on the DHCP server and the local
| no-preempt ) pool are preempted or not
Possible values: This element is only shown in
- preempted : the ip addr pool on the DHCP server and the detail mode.
local pool are preempted
- no-preempt : the ip addr pool on the DHCP server and the
local pool are not preempted
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 41.17-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 41.17-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-swo-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
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 41.18-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 41.18-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.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 41.19-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 41.19-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: <SignedInteger> this is the host sfp faceplate
- a signed integer number for host alarms or it is the
equipment slot id for expansion
shelf alarms
This element is only shown in
detail mode.
alarm index 2 Parameter type: <SignedInteger> this is the lanx port id for host
- a signed integer alarms. this index is not used for
expansion shelf alarms
This element is only shown in
detail mode.
Only Show Details: host shelf alarms
name Type Description
host-sfp-los Parameter type: <Alarm::hostSFPLOS> current status host downlink SFP
( failing loss of signal
Command Description
This command displays the LLU relay 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 41.20-1 "LLU Relay 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 41.20-2 "LLU Relay 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.
slot-id Parameter type: <Equipm::FullLtSlotIndex> identify where the alarm has
lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
Possible values: This element is only shown in
- lt : lt-slot detail mode.
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Only Show Details: current and previous alarm log status
name Type Description
wrong-or-no-applq Parameter type: <Alarm::relayNotSet> current status specifing that relay
( yes not set
| no ) This element is only shown in
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 41.21-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 41.21-2 "Custom External 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 always shown.
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 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 41.22-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 41.22-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 always shown.
board-position Parameter type: <Equipm::SlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is always shown.
| nt-b
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- ext-a : nt-a slot in an extension shelf
Command Description
This command displays the SIP user agent 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 41.23-1 "SIP User Agent 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 41.23-2 "SIP User Agent 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 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 41.24-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 41.24-2 "SIP Slot Alarm Log Status Commands" Display parameters
Only Show Details: current and previous alarm log status
name Type Description
inval-cdefile Parameter type: <Alarm::invalidCDEFile> specifies the CDE file is invalid
( yes or valid.
| no ) This element is only shown in
Possible values: detail mode.
- yes : invalid CDE file
- no : correct CDE file
prev-status Parameter type: <Alarm::invalidCDEFile> status of specifies cde file with its
( yes previous logged value
| no ) This element is only shown in
Possible values: detail mode.
- yes : invalid CDE file
- no : correct CDE file
short-res Parameter type: <Alarm::shortResource> sepcifies the call resource short
( yes or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : short call resource
- no : have call resource
prev-status Parameter type: <Alarm::shortResource> status of specifies call resources
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 41.25-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 41.25-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 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 41.26-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 41.26-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
lnk-dev 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 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 41.27-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 41.27-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: <Equipm::PortIndex> 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
lnk-dev 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 41.28-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 41.28-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 41.29-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 41.29-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 41.30-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 41.30-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: <Equipm::PortIndex> 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 41.31-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 41.31-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 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 41.32-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 41.32-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::SlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is always shown.
| nt-b
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
Field type <Eqpt::RackId>
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 41.33-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 41.33-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::XdslLine> identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId> This element is always shown.
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 Parameter type: <SignedInteger> identify where the alarm has
- a signed integer occurred.
This element is always shown.
Only Show Details: current and previous alarm log status
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 41.34-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 41.34-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
- file transfer protocol type 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 detail mode.
- available : file transfer server available
prev-status Parameter type: <Alarm::relayNotSet> status of relay with its previous
( yes logged value
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 41.35-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 41.35-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: <Itf::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> )
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 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 41.36-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 41.36-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
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)
----plug-in-unit
- (index)
----atm
- (index)
----ether-itf
- (index)
----sw-mgmt
- (index)
----xdsl
- (index)
----xdsl-tca
- (index)
----eo-conversion
- (index)
----authentication
- (index)
----bonding-group
- (index)
----ipox
- (index)
----redundancy
- (index)
----custom
- (index)
----sfp
- (index)
----llu-relay
- (index)
----custom-ext-alarm
- (index)
----plug-in-unit-ext
- (index)
----sip-user-agent
- (index)
----sip-plugin-unit
- (index)
----sip-termination
- (index)
----shdsl
- (index)
----shdsl-isam
- (index)
----ima-group
- (index)
----ima-link
- (index)
----ether-tca
- (index)
----ether-sfp
- (index)
----qos-slot
- (index)
----qos-queue
- (index)
----filetransfer
- (index)
----l2forward
- (index)
----external-device
- (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 42.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 42.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
| plugin-unit
| atm
| custom
| ima-group
| ima-link
| redundancy
| shdsl
| ether-itf
| traffic-overflow
| queue-counter
| temporal
| spatial
| software-mngt
| xdsl
| xdsl-tca
| eo-conv
| authentication
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 42.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 42.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
nt-disk Parameter type: <Alarm::ntDiskSpace> current status of nt disk space is
( ( ninty-perc-full | 90%-full ) 90% full or less than that
| ( less-than-ninty-perc | less-than-90% ) ) This element is only shown in
Possible values: detail mode.
- ninty-perc-full : NT disk space is 90% full
- 90%-full : NT disk space is 90% full
- less-than-ninty-perc : NT disk space usage less that 90%
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 42.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 42.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 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 42.5-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 42.5-2 "Plug-in Unit Current Alarm Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::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.
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
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 42.6-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 42.6-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 42.7-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 42.7-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 42.8-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 42.8-2 "Software Management Current Alarm Status Command" Display parameters
Specific Information
name Type Description
nt-position Parameter type: <Equipm::NtSlotIndex> identifies the physical position of
( nt-a the slot
| nt-b ) This element is only shown in
Possible values: detail mode.
- nt-a : nt-a slot
- nt-b : nt-b slot
sw-rollback Parameter type: <Alarm::SwRollback> specifies implicit software
( yes rollback is performed or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : implicit software rollback performed
- no : no implicit software rollback
db-rollback Parameter type: <Alarm::DbRollback> specifies implicit database
( yes rollback is performed or not.
| no ) This element is only shown in
Possible values: detail mode.
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 42.9-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 42.9-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 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 42.10-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 42.10-2 "TCA xDSL Current Alarm Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Equipm::PortIndex> 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 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 42.11-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 42.11-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 42.12-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 42.12-2 "Authentication Current Alarm Status Command" Display parameters
Specific Information
name Type Description
vrf-assign Parameter type: <Alarm::VRFassignment> specifies whether VRF for a user
( failed session is assigned or failed
| successful ) This element is only shown in
Possible values: detail mode.
- failed : failure to assign a VRF for a user session
- successful : assigned a VRF for a user session
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
ip-pool-assign Parameter type: <Alarm::IPaddrPoolAssign> specifies whether IP address pool
( failed for a user session is assigned or
| successful ) failed
Possible values: This element is only shown in
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 42.13-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 42.13-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 upstream
( reached-threshold planned bit rate is reached
| not-reached ) threshold or not
Possible values: This element is only shown in
- reached-threshold : upstream planned bitrate threshold detail mode.
Command Description
This command displays the IPoX 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 42.14-1 "IPoX Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm current table index
- index of a current alarm entry
Command Output
Table 42.14-2 "IPoX Current Alarm Status Command" Display parameters
Specific Information
name Type Description
ip-addr-pool Parameter type: <Alarm::IPAddrPoolPreempt> specifies whether the ip addr pool
( preempted on the DHCP server and the local
| no-preempt ) pool are preempted or not
Possible values: This element is only shown in
- preempted : the ip addr pool on the DHCP server and the detail mode.
local pool are preempted
- no-preempt : the ip addr pool on the DHCP server and the
local pool are not preempted
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 42.15-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 42.15-2 "Redundancy Current Alarm Status Command" Display parameters
Specific Information
name Type Description
loss-swo-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
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 42.16-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 42.16-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 42.17-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 42.17-2 "SFP Current Alarm Status Command" Display parameters
Specific Information
name Type Description
alarm index 1 Parameter type: <SignedInteger> this is the host sfp faceplate
- a signed integer number for host alarms or it is the
equipment slot id for expansion
shelf alarms
This element is only shown in
detail mode.
alarm index 2 Parameter type: <SignedInteger> this is the lanx port id for host
- a signed integer alarms. this index is not used for
expansion shelf alarms
This element is only shown in
detail mode.
Only Show Details: host shelf alarms
name Type Description
host-sfp-los Parameter type: <Alarm::hostSFPLOS> current status of SFP alarm, Host
( failing downlink SFP loss of signal
| ok ) This element is only shown in
Possible values: detail mode.
- failing : host downlink SFP loss of signal
- ok : host downlink SFP signal ok
Command Description
This command displays the LLU relay 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 42.18-1 "LLU Relay Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 42.18-2 "LLU Relay Current Alarm Status Command" Display parameters
Specific Information
name Type Description
slot-id Parameter type: <Equipm::FullLtSlotIndex> identify where the alarm has
lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
Possible values: This element is only shown in
- lt : lt-slot detail mode.
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
wrong-or-no-applq Parameter type: <Alarm::relayNotSet> current status specifing that relay
( yes not set
| no ) This element is only shown in
Possible values: detail mode.
- yes : wrong appliq
- no : right appliq
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 42.19-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 42.19-2 "Custom External Current Alarm 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 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 42.20-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 42.20-2 "Plug In Unit Extended Current Alarm Status Command" Display parameters
Specific Information
name Type Description
fan-alarm Parameter type: <Alarm::pluginFan> current status specifying fan
( yes alarm is present or not
| no ) This element is always shown.
Possible values:
- yes : fan alarm
- no : no fan alarm
dc-a-alarm Parameter type: <Alarm::plugin-dc-a> current status specifying dc-a
( yes failure alarm is present or not
| no ) This element is always shown.
Possible values:
- yes : dc a failure alarm
- no : no dc a failure alarm
dc-b-alarm Parameter type: <Alarm::plugin-dc-b> current status specifying dc-b
( yes failure alarm is present or not
| no ) This element is always shown.
Possible values:
Command Description
This command displays the SIP user agent 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 42.21-1 "SIP User Agent Current Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 42.21-2 "SIP User Agent Current Alarm 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.
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 42.22-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 42.22-2 "SIP Slot Current Alarm Status Command" Display parameters
Specific Information
name Type Description
inval-cdefile Parameter type: <Alarm::invalidCDEFile> specifies the CDE file is invalid
( yes or valid.
| no ) This element is only shown in
Possible values: detail mode.
- yes : invalid CDE file
- no : correct CDE file
short-res Parameter type: <Alarm::shortResource> sepcifies the call resource short
( yes or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : short call resource
- no : have call resource
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 42.23-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 42.23-2 "SIP Termination Current Alarm Status Command" Display parameters
Specific Information
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
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 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 42.24-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 42.24-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
lnk-dev 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 42.25-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 42.25-2 "Shdsl Current Alarm Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Equipm::PortIndex> 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
lnk-dev Parameter type: <Alarm::LinkDeviceValues> identify where the alarm has
- a signed integer occurred
This element is only shown in
detail mode.
loss-syn-net Parameter type: <Alarm::LossSyncWordNetwork> current status of loss of sync
( yes word at the network side on each
| no ) pair
Possible values: This element is only shown in
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 42.26-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 42.26-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 42.27-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 42.27-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 42.28-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 42.28-2 "Alarm Current Ether-Tca Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Equipm::PortIndex> 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 42.29-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 42.29-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 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 42.30-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 42.30-2 "Alarm Current Qos Slot Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::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.
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
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 42.31-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 42.31-2 "Alarm Current Qos Queue 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
queue Parameter type: <SignedInteger> identify where the alarm has
- a signed integer occurred.
This element is only shown in
detail mode.
queue-discard-overflow Parameter type: <Alarm::queue-discard-overflow> check the corresponding queue
( yes Load.
| no ) This element is only shown in
Possible values: detail mode.
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 42.32-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 42.32-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
- file transfer protocol type 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 detail mode.
- available : file transfer server available
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 42.33-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 42.33-2 "Alarm L2 Forward Status Command" Display parameters
Specific Information
name Type Description
bridgeport Parameter type: <Itf::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> )
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
vlan-id Parameter type: <Vlan::StackedVlanSigned> identify the vlan id where the
( <Vlan::UVlanIndex> alarm has occurred.
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 42.34-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 42.34-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
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)
----plug-in-unit
- (index)
----atm
- (index)
----ether-itf
- (index)
----sw-mgmt
- (index)
----xdsl
- (index)
----xdsl-tca
- (index)
----eo-conversion
- (index)
----authentication
- (index)
----bonding-group
- (index)
----ipox
- (index)
----redundancy
- (index)
----custom
- (index)
----sfp
- (index)
----llu-relay
- (index)
----custom-ext-alarm
- (index)
----plug-in-unit-ext
- (index)
----sip-user-agent
- (index)
----sip-plugin-unit
- (index)
----sip-termination
- (index)
----shdsl
- (index)
----shdsl-isam
- (index)
----ima-group
- (index)
----ima-link
- (index)
----ether-tca
- (index)
----ether-sfp
- (index)
----qos-slot
- (index)
----qos-queue
- (index)
----filetransfer
- (index)
----l2forward
- (index)
----external-device
- (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 43.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 43.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 43.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 43.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
nt-disk Parameter type: <Alarm::ntDiskSpace> current status of nt disk space is
( ( ninty-perc-full | 90%-full ) 90% full or less than that
| ( less-than-ninty-perc | less-than-90% ) ) This element is only shown in
Possible values: detail mode.
- ninty-perc-full : NT disk space is 90% full
- 90%-full : NT disk space is 90% full
- less-than-ninty-perc : NT disk space usage less that 90%
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 43.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 43.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 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 43.5-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 43.5-2 "Plug-in Unit Alarm Log Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::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.
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
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 43.6-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 43.6-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 43.7-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 43.7-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 43.8-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 43.8-2 "Alarm Snapshot Software Management Status Command" Display parameters
Specific Information
name Type Description
nt-position Parameter type: <Equipm::NtSlotIndex> identifies the physical position of
( nt-a the slot
| nt-b ) This element is only shown in
Possible values: detail mode.
- nt-a : nt-a slot
- nt-b : nt-b slot
sw-rollback Parameter type: <Alarm::SwRollback> specifies implicit software
( yes rollback is performed or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : implicit software rollback performed
- no : no implicit software rollback
db-rollback Parameter type: <Alarm::DbRollback> specifies implicit database
( yes rollback is performed 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 43.9-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 43.9-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 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 43.10-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 43.10-2 "TCA xDSL Alarm Log Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Equipm::PortIndex> 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 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 43.11-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 43.11-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 43.12-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 43.12-2 " Authentication Alarms for Snapshot Status Command" Display parameters
Specific Information
name Type Description
vrf-assignment Parameter type: <Alarm::VRFassignment> specifies whether VRF for a user
( failed session is assigned or failed
| successful ) This element is only shown in
Possible values: detail mode.
- failed : failure to assign a VRF for a user session
- successful : assigned a VRF for a user session
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
ip-addr-pool-assign Parameter type: <Alarm::IPaddrPoolAssign> specifies whether IP address pool
( failed for a user session is assigned or
| successful ) failed
Possible values: This element is only shown in
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 43.13-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 43.13-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 group
( reached-threshold upstream planned bit rate is
| not-reached ) reached threshold or not
Possible values: This element is only shown in
- reached-threshold : upstream planned bitrate threshold detail mode.
Command Description
This command displays the snapshot IPoX 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 43.14-1 "Alarm IPoX 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 43.14-2 "Alarm IPoX Snapshot Status Command" Display parameters
Specific Information
name Type Description
ip-addr-pool Parameter type: <Alarm::IPAddrPoolPreempt> specifies whether the ip addr pool
( preempted on the DHCP server and the local
| no-preempt ) pool are preempted or not
Possible values: This element is only shown in
- preempted : the ip addr pool on the DHCP server and the detail mode.
local pool are preempted
- no-preempt : the ip addr pool on the DHCP server and the
local pool are not preempted
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 43.15-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 43.15-2 "Alarm Redundancy Snapshot Status Command" Display parameters
Specific Information
name Type Description
loss-swo-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
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 43.16-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 43.16-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 43.17-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 43.17-2 "Alarm SFP Snapshot Status Command" Display parameters
Specific Information
name Type Description
alarm index 1 Parameter type: <SignedInteger> this is the host sfp faceplate
- a signed integer number for host alarms or it is the
equipment slot id for expansion
shelf alarms
This element is only shown in
detail mode.
alarm index 2 Parameter type: <SignedInteger> this is the lanx port id for host
- a signed integer alarms. this index is not used for
expansion shelf alarms
This element is only shown in
detail mode.
Only Show Details: host shelf alarms
name Type Description
host-sfp-los Parameter type: <Alarm::hostSFPLOS> current status host downlink SFP
( failing loss of signal
| ok ) This element is only shown in
Possible values: detail mode.
- failing : host downlink SFP loss of signal
- ok : host downlink SFP signal ok
Command Description
This command displays the alarm snapshot of the LLU relay.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 43.18-1 "Alarm Snapshot LLU Relay Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm snap shot table index
- index of a current alarm entry
Command Output
Table 43.18-2 "Alarm Snapshot LLU Relay Status Command" Display parameters
Specific Information
name Type Description
slot-id Parameter type: <Equipm::FullLtSlotIndex> identify where the alarm has
lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
Possible values: This element is only shown in
- lt : lt-slot detail mode.
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
wrong-or-no-applq Parameter type: <Alarm::relayNotSet> current status specifing that relay
( yes not set
| no ) This element is only shown in
Possible values: detail mode.
- yes : wrong appliq
- no : right appliq
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 43.19-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 43.19-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 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 43.20-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 43.20-2 "Alarm Plug In Unit Extended Snap Shot Status Command" Display parameters
Specific Information
name Type Description
fan-alarm Parameter type: <Alarm::pluginFan> current status specifying fan
( yes alarm is present or not
| no ) This element is always shown.
Possible values:
- yes : fan alarm
- no : no fan alarm
dc-a-alarm Parameter type: <Alarm::plugin-dc-a> current status specifying dc-a
( yes failure alarm is present or not
| no ) This element is always shown.
Possible values:
- yes : dc a failure alarm
- no : no dc a failure alarm
dc-b-alarm Parameter type: <Alarm::plugin-dc-b> current status specifying dc-b
( yes failure alarm is present or not
| no ) This element is always shown.
Possible values:
Command Description
This command show the alarm snap-shot of SIP User Agent
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 43.21-1 "Alarm Snap-shot SIP User Agent Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: alarm type
- index of a current alarm entry
Command Output
Table 43.21-2 "Alarm Snap-shot SIP User Agent 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.
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 43.22-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 43.22-2 "Alarm Snap-shot SIP Slot Status Command" Display parameters
Specific Information
name Type Description
inval-cdefile Parameter type: <Alarm::invalidCDEFile> specifies the CDE file is invalid
( yes or valid.
| no ) This element is only shown in
Possible values: detail mode.
- yes : invalid CDE file
- no : correct CDE file
short-res Parameter type: <Alarm::shortResource> sepcifies the call resource short
( yes or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : short call resource
- no : have call resource
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 43.23-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 43.23-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 Shdsl
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 43.24-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 43.24-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
lnk-dev 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 43.25-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 43.25-2 "Alarm Snap-shot Shdsl Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Equipm::PortIndex> 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
lnk-dev Parameter type: <Alarm::LinkDeviceValues> identify where the alarm has
- a signed integer occurred
This element is only shown in
detail mode.
loss-syn-net Parameter type: <Alarm::LossSyncWordNetwork> snap shot of loss of sync word at
( yes the network side on each pair
| no ) This element is only shown in
Possible values: 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 43.26-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 43.26-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 43.27-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 43.27-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 43.28-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 43.28-2 "Alarm Snap-shot Ether-Tca Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Equipm::PortIndex> 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 43.29-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 43.29-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 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 43.30-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 43.30-2 "Alarm Snap-shot SIP Termination Status Command" Display parameters
Specific Information
name Type Description
board-position Parameter type: <Equipm::SlotIndex> identify where the alarm has
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> occurred.
| nt-a This element is always shown.
| nt-b
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
Field type <Eqpt::RackId>
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 43.31-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 43.31-2 "Alarm Snap-shot SIP Termination 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 always shown.
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 Parameter type: <SignedInteger> identify where the alarm has
- a signed integer occurred.
This element is always shown.
queue-discard-overflow Parameter type: <Alarm::queue-discard-overflow> Check the corresponding queue
( yes Load.
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 43.32-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 43.32-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
- file transfer protocol type 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 detail mode.
- available : file transfer server available
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 43.33-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 43.33-2 "Alarm L2 Forward Status Command" Display parameters
Specific Information
name Type Description
bridgeport Parameter type: <Itf::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> )
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
vlan-id Parameter type: <Vlan::StackedVlanSigned> identify the vlan id where the
( <Vlan::UVlanIndex> alarm has occurred.
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 43.34-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 43.34-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
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 common values related to the delta alarm log.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 44.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
- counter 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
- counter alarms with a severity level
indeterminate since startup.
This element is always shown.
warning Parameter type: <Counter> total number of changes of all
- counter alarms with a severity level
warning since startup.
This element is always shown.
minor Parameter type: <Counter> total number of changes of all
- counter alarms with a severity level
minor since startup.
This element is always shown.
major Parameter type: <Counter> total number of changes of all
- counter alarms with a severity level major
since startup.
This element is always shown.
critical Parameter type: <Counter> total number of changes of all
- counter alarms with a severity level
critical since startup.
This element is always shown.
Command Description
This command displays alarm values related to the indeterminate alarm delta log.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 44.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 44.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
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom
Command Description
This command displays alarm values related to the warning alarm delta log.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 44.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 44.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
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom
| xdsl-ne-ese
| xdsl-act-cfg-error
| xdsl-act-not-feas
| xdsl-up-br-reach
Command Description
This command displays alarm values related to the minor alarm delta log.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 44.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 44.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
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom
| xdsl-ne-ese
| xdsl-act-cfg-error
| xdsl-act-not-feas
| xdsl-up-br-reach
Command Description
This command displays alarm values related to the major alarm delta log.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 44.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 44.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
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom
| xdsl-ne-ese
| xdsl-act-cfg-error
| xdsl-act-not-feas
| xdsl-up-br-reach
Command Description
This command displays alarm values related to the critical alarm delta log.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 44.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 44.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
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom
| xdsl-ne-ese
| xdsl-act-cfg-error
| xdsl-act-not-feas
| xdsl-up-br-reach
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)
----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 45.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 45.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) This element is always shown.
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
| uplink-group )
Possible values:
- shub-gen : general shub related alarms
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 45.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 45.3-2 "SHub Alarm Equipment Snap-shot Status Command" Display parameters
Specific Information
name Type Description
fan Parameter type: <Alarm::ShubFanState> specifies whether the fan-unit is
( failed failed or not.
| working ) This element is only shown in
Possible values: detail mode.
- failed : fan unit falied
- working : fan unit OK
power-fan Parameter type: <Alarm::ShubPowerFanState> specifies whether the power fan
( failed unit is failed or not.
| working ) This element is only shown in
Possible values: detail mode.
- failed : power fan unit falied
- working : power fan unit OK
db-restore Parameter type: <Alarm::ShubDBrestore> specifies whether the DB restore
( failed is successful or not.
Command Description
This command displays whether the Ethernet interface link status is down. This command also displays the
previous status, which allows the operator to see whether the link has previously gone down.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 45.4-1 "SHub 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 45.4-2 "SHub Alarm Snapshot Ethernet Interface Status Command" Display parameters
Specific Information
name Type Description
port-number Parameter type: <Shub::NetworkPort> port number of the shub
<Shub::NetworkPort> This element is only shown in
Field type <Shub::NetworkPort> detail mode.
- network port on Shub
link-down Parameter type: <Alarm::ShubLinkDown> specifies whether the shub link is
( yes down or not.
| no ) This element is only shown in
Possible values: detail mode.
- yes : fan unit falied
- no : fan unit OK
mac-conflict Parameter type: <Alarm::ShubMACconflict> specifies whether there is a
( yes duplicate MAC address from the
| no ) ethernet port of LAN switch.
Possible values: This element is only shown in
- yes : duplicate MAC address from ethernet port of LAN detail mode.
Command Description
This command displays the SHub snapshot RIP 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 45.5-1 "SHub Alarm RIP 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 45.5-2 "SHub Alarm RIP Snapshot Status Command" Display parameters
Specific Information
name Type Description
vrf-id Parameter type: <SignedInteger> specifies where the alarm has
- a signed integer occurred.
This element is only shown in
detail mode.
config-err Parameter type: <Alarm::ShubConfigErr> RIP interface configuration error
( failed This element is only shown in
| ok ) detail mode.
Possible values:
- failed : configuration error occurred
- ok : configuration error not occurred
auth-fail Parameter type: <Alarm::ShubAuthFail> RIP interface authentication
( failed failure
| ok ) This element is only shown in
Possible values: detail mode.
- failed : authentication failed
- ok : authentication not failed
rcv-bad-pkt Parameter type: <Alarm::ShubRcvPkt> bad packet received on RIP
( yes interface
| no ) This element is only shown in
Command Description
This command displays the SHub snapshot OSPF status.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 45.6-1 "SHub Alarm OSPF 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 45.6-2 "SHub Alarm OSPF Snap-shot Status Command" Display parameters
Specific Information
name Type Description
vrf-id Parameter type: <SignedInteger> specifies where the alarm has
- a signed integer occurred.
This element is only shown in
detail mode.
config Parameter type: <Alarm::ShubConfigErr> interface configuration error
( failed This element is only shown in
| ok ) detail mode.
Possible values:
- failed : configuration error occurred
- ok : configuration error not occurred
authen Parameter type: <Alarm::ShubAuthFail> interface authentication failure
( failed This element is only shown in
| ok ) detail mode.
Possible values:
- failed : authentication failed
- ok : authentication not failed
Command Description
This command displays the SHub snapshot uplink group 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 45.7-1 "SHub Alarm Uplink Group 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 45.7-2 "SHub Alarm Uplink Group Snapshot Status Command" Display parameters
Specific Information
name Type Description
uplink-nbr Parameter type: <SignedInteger> specifies uplink group number
- a signed integer This element is only shown in
detail mode.
uplink-down Parameter type: <Alarm::ShubUplinkDown> uplink group down
( yes This element is only shown in
| no ) detail mode.
Possible values:
- yes : uplink group down
- no : no uplink group down
Command Description
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 45.8-2 "SHub Alarm Delta Log Changes Status Command" Display parameters
Specific Information
name Type Description
all Parameter type: <Counter> total number of changes of all
- counter alarms since startup.
This element is always shown.
indeterminate Parameter type: <Counter> the total number of changes of all
- counter alarms with severity level
indeterminate since startup.
This element is always shown.
warning Parameter type: <Counter> the total number of changes of all
- counter alarms with severity level
warning since startup.
This element is always shown.
minor Parameter type: <Counter> the total number of changes of all
- counter alarms with severity level minor
since startup.
This element is always shown.
major Parameter type: <Counter> the total number of changes of all
- counter alarms with severity level major
since startup.
This element is always shown.
critical Parameter type: <Counter> the total number of changes of all
- counter alarms with severity level critical
since startup.
This element is always shown.
Description
This chapter gives an overview of nodes that are handled by "ATM Status Commands".
Command Tree
----show
----atm
----interface
- (port)
----pvc
- (port-index)
----tc-int
- (port)
----tc-current-int
----fifteen-min
- (port)
----one-day
- (port)
----tc-15min-int
- (port)
- intvl-number
----tc-1day-int
- (port)
- intvl-number
Command Description
This command displays the ATM interface configuration table.
User Level
The command can be accessed by operators with atm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 46.2-1 "ATM Interface Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: ATM interface
<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 Output
Table 46.2-2 "ATM Interface Status Command" Display parameters
Specific Information
name Type Description
type Parameter type: <Atm::asamAtmItfType> type of ATM interface.
( not-specified This element is always shown.
| network-termination
| access-to-access
| user-to-access
| internal-server
| external-server )
Possible values:
- not-specified : not specified
- network-termination : network termination
- access-to-access : access to access interface
Command Description
This command displays the status of the PVC.
User Level
The command can be accessed by operators with atm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 46.3-1 "PVC Status Command" Resource Parameters
Resource Identifier Type Description
(port-index) Format: the ATM PVC
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiMandatoryId> :
<Eqpt::VciMandatoryId>
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::VpiMandatoryId>
- atm VPI
Field type <Eqpt::VciMandatoryId>
- atm VCI
Command Output
Table 46.3-2 "PVC Status Command" Display parameters
Specific Information
name Type Description
admin-status Parameter type: <Atm::adminStatus> specifies the desired
( admin-up administrative state of the VCL.
| admin-down ) This element is always shown.
Possible values:
- admin-up : enable traffic flow
- admin-down : disable traffic flow
Command Description
This command displays the TC adapter protocol interval status.
User Level
The command can be accessed by operators with atm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 46.4-1 "TC Adapter Protocol Interval Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: ATM interface index
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / (rack/shelf/slot/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 Output
Table 46.4-2 "TC Adapter Protocol Interval Status Command" Display parameters
Specific Information
name Type Description
valid-15-min-intervals Parameter type: <SignedInteger> the number of previous intervals
- a signed integer (maximum 192) for which valid
data has been stored. The value
of this object will be 192 unless
the device was brought online
within the last nx15 minutes, in
which case the value will be the
number of complete 15 minute
intervals the device has been
online
This element is always shown.
Command Description
This command displays the TC adapter protocol current quarter performance data.
User Level
The command can be accessed by operators with atm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 46.5-1 "TC Adapter Protocol Current Quarter Performance Data Command" Resource
Parameters
Resource Identifier Type Description
(port) Format: ATM interface
<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 Output
Table 46.5-2 "TC Adapter Protocol Current Quarter Performance Data Command" Display
parameters
Specific Information
name Type Description
ocd-far-end Parameter type: <Counter> the number of out of cell
- counter delineations anomalies for
incoming cells on a far end ATM
interface connected to this ATM
interface
Command Description
This command displays the TC adapter protocol current day performance data.
User Level
The command can be accessed by operators with atm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 46.6-1 "TC Adapter Protocol Current Day Performance Data Command" Resource
Parameters
Resource Identifier Type Description
(port) Format: ATM interface
<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 Output
Table 46.6-2 "TC Adapter Protocol Current Day Performance Data Command" Display
parameters
Specific Information
name Type Description
ocd-far-end Parameter type: <Counter> the number of out of cell
- counter delineations anomalies for
incoming cells on a far end ATM
interface connected to this ATM
interface
Command Description
This command displays the TC adapter protocol-monitoring 15-min interval data parameters.
User Level
The command can be accessed by operators with atm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 46.7-1 "TC Adapter Protocol Performance Data for Previous Quarter Intervals Command"
Resource Parameters
Resource Identifier Type Description
(port) Format: ATM interface
<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
intvl-number Parameter type: <Atm::AtmItvlNumber> interval for which statistics are
Format: available
- interval for which statistics is available
- range: [1...192]
Command Output
Table 46.7-2 "TC Adapter Protocol Performance Data for Previous Quarter Intervals Command"
Display parameters
Specific Information
name Type Description
ocd-near-end Parameter type: <Counter> the number of out of cell
Command Description
This command displays the TC adapter protocol-monitoring 1-day interval data parameters.
User Level
The command can be accessed by operators with atm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 46.8-1 "TC Adapter Protocol Performance Data for Previous Day Intervals Command"
Resource Parameters
Resource Identifier Type Description
(port) Format: ATM interface
<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
intvl-number Parameter type: <Atm::AtmItvlNo1day> interval for which statistics are
Format: available
- itvl for which statistics is available
- range: [1...2]
Command Output
Table 46.8-2 "TC Adapter Protocol Performance Data for Previous Day Intervals Command"
Display parameters
Specific Information
name Type Description
ocd-near-end Parameter type: <Counter> the number of out of cell
Description
This chapter gives an overview of nodes that are handled by "Bridge Status Commands".
Command Tree
----show
----bridge
----port
- (port)
----port-to-atm-pvc
- (bridge-port)
----shub-info
----network-port
- (port)
Command Description
This command displays the current settings for the bridge port. The initial configuration may be overruled by
dynamic data as a result of port authentication using RADIUS protocol. When any of the settings has been
overruled, the status parameter indicates 'dynamic'.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 47.2-1 "Bridge Port Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. atm PVC,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / EFM port,...)
<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
Command Output
Table 47.2-2 "Bridge Port Status Command" Display parameters
Specific Information
name Type Description
bridge-port Parameter type: <Vlan::BridgePort> the port identifier assigned by the
- bridge port system.A port identifier identifies
- range: [1...65536] uniquely a port of the
Command Description
This command displays the mapping between a bridge port and its ATM interface.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 47.3-1 "Bridge Port to ATM PVC Mapping Status Command" Resource Parameters
Resource Identifier Type Description
(bridge-port) Format: bridge port
- bridge port
- range: [1...65536]
Command Output
Table 47.3-2 "Bridge Port to ATM PVC Mapping Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::AtmInterfaceVpiVci> the atm static Interface with vpi
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / and vci
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> This element is always shown.
| <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
Command Description
This command displays global information regarding the bridge on the SHub.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 47.4-2 "SHub Bridge Status Command" Display parameters
Specific Information
name Type Description
mac-address Parameter type: <Vlan::MacAddr> the MAC address used by this
- mac address (aa:bb:cc:a1:02:03) bridge when it must be referred to
- length: 6 in a unique fashion
This element is always shown.
learnt-entry-discards Parameter type: <Vlan::Counter> the total number of Filtering
- an unsigned integer Database entries, which have
been or would have been learnt,
but have been discarded due to a
lack of space in the FDB. If this
Counter is increasing it indicates
that the Filtering Database is
regularly becoming full. This
event may be of temporary
nature.
This element is always shown.
Command Description
This command displays port related parameters for a bridge port on the SHub.
When detailed information is requested, statistics regarding frames received and transmitted on the bridge port are
displayed.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 47.5-1 "SHub Bridge Port Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: port number
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Command Output
Table 47.5-2 "SHub Bridge Port Status Command" Display parameters
Common Information:bridge parameters
name Type Description
mac-address Parameter type: <Vlan::MacAddr> the MAC address used by this
- mac address (aa:bb:cc:a1:02:03) bridge when it must be referred to
- length: 6 in a unique fashion
This element is always shown.
learned-entry-discards Parameter type: <Vlan::Counter> the total number of Filtering
- an unsigned integer Database entries, which have
been or would have been learnt,
but have been discarded due to a
lack of space in the FDB. If this
Counter is increasing it indicates
that the Filtering Database is
regularly becoming full. This
event may be of temporary
nature.
This element is always shown.
Specific Information
name Type Description
operation-status Parameter type: <Shub::PortOperStatus> the operational status of the port.
( down This status is only valid if the
| up ) administrative status of the
Possible values: corresponding interface is up.
- down : down This element is always shown.
- up : up
max-frame-info Parameter type: <Vlan::Integer> the maximum size of the INFO
- a signed integer (non-MAC) field that this port
will receive or transmit
This element is always shown.
traffic-class Parameter type: <Shub::TrafficClass> The number of egress traffic
- port priority classes supported on this port.
- range: [1...8] This element is always shown.
Only Show Details: frame stats
name Type Description
in-frames Parameter type: <Vlan::Counter> 32 bits counter holding the
- an unsigned integer number of frames that have been
received by this port from its
segment; only frames for a
protocol being processed by the
local bridging function are
counted
This element is only shown in
detail mode.
in-overflow-frames Parameter type: <Vlan::Counter> the high order 32 bits of a 64 bits
- an unsigned integer in-frames counter, in case of high
capacity interfaces
This element is only shown in
detail mode.
out-frames Parameter type: <Vlan::Counter> 32 bits counter holding the
- an unsigned integer number of frames that have been
transmitted by this port port to its
segment; only frames for a
protocol being processed by the
local bridging function are
counted
This element is only shown in
detail mode.
out-overflow-frames Parameter type: <Vlan::Counter> the high order 32 bits of a 64 bits
- an unsigned integer out-frames counter, in case of
high capacity interfaces
This element is only shown in
detail mode.
discard-valid-frames Parameter type: <Vlan::Counter> 32 bits counter holding the
- an unsigned integer number of valid frames received
which were discarded (i.e.,
filtered) by the Forwarding
Process
This element is only shown in
detail mode.
discard-valid-overflow Parameter type: <Vlan::Counter> the high order 32 bits of a 64 bits
- an unsigned integer discard-valid-frames counter, in
case of high capacity interfaces
This element is only shown in
detail mode.
delay-exceed-discards Parameter type: <Vlan::Counter> the number of frames discarded
Description
This chapter gives an overview of nodes that are handled by "VLAN Status Commands".
Command Tree
----show
----vlan
----global
----residential-bridge
- (vlan-id)
- bridge-port
----cross-connect
- (vlan-id)
- port
----stacked-vlan
- (s-vlanid)
- vlan-id
----stacked-qos-vlan
- (s-vlanid)
- vlan-id
----qos-cvlan-list
- (vlan-id)
----layer2-terminated
- (vlanid)
----name
- (name)
----fdb
- (vlan-id)
- mac
- bridge-port
----bridge-port-fdb
- (port)
- vlan-id
- mac
----port-vlan-map
- (port)
----priority-regen
- (profile-id)
----dup-mac-alarm
- (dup-port)
- dup-vlan-id
- dup-mac
----port-event
- (port)
----port-curr-15min-stats
- (port)
----port-curr-day-stats
- (port)
----port-15min-stats
- (port)
- interval-number
----port-prev-day-stats
- (port)
- interval-number
----current-15min-stats
- (vlanid)
- port
----current-day-stats
- (vlanid)
- port
----previous-15min-stats
- (vlanid)
- port
- interval-number
----vlan-day-stats
- (vlanid)
- port
- interval-number
----shub-port-vlan-map
- (port)
- vlan-id
----shub-vlan-name
- (name)
----shub-fdb
- (vlanid)
----shub-filter-entry
- (vlanid)
- unicast-mac
----shub-dup-mac-alarm
- (dup-vlan-id)
- dup-port
----shub-nr-mcast-entries
Command Description
This command displays information common to all VLANs.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 48.2-2 "Global VLAN Status Command" Display parameters
Common Information:vlan parameters
name Type Description
configured-vlans Parameter type: <Vlan::Gauge> current number of vlans that are
- an unsigned integer configured
This element is always shown.
management Parameter type: <Vlan::MgntVlanMode> specifies how the node is
( inband managed
| outband ) This element is always shown.
Possible values:
- inband : inband
- outband : outband
max-rb-vlan Parameter type: <Vlan::Gauge> maximum number of residential
- an unsigned integer bridge vlans that are supported
This element is always shown.
max-layer2-term-vlan Parameter type: <Vlan::Gauge> maximum number of layer2
- an unsigned integer terminated vlans that are
supported
This element is always shown.
Command Description
This command displays all parameters for a particular VLAN of the type residential bridge VLAN.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.3-1 "Residential Bridge VLAN Status Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- unstacked vlan identity
- range: [1...4093]
bridge-port Parameter type: <Itf::AtmInterfaceVpiVci> identity of a port(e.g. atm PVC,
Format: EFM port, ...)
( <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
Command Output
Table 48.3-2 "Residential Bridge VLAN Status Command" Display parameters
Specific Information
Command Description
This command displays all parameters for a particular VLAN of the type cross-connect VLAN.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.4-1 "Cross-connect VLAN Status Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
port Parameter type: <Itf::AtmInterfaceVpiVci> identity of a port(e.g. atm PVC,
Format: EFM port, ...)
( <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>
Command Output
Table 48.4-2 "Cross-connect VLAN Status Command" Display parameters
Specific Information
name Type Description
bridge-port Parameter type: <Vlan::Port> bridge port
- a bridge port This element is always shown.
fdb-id Parameter type: <Vlan::Gauge> identity of the filtering database
- an unsigned integer This element is always shown.
filter-entries Parameter type: <Vlan::Counter> number of entries in the filtering
- an unsigned integer database
This element is always shown.
qos-profile Parameter type: <Vlan::QosProfileName> QOS profile, dynamically or
( none statically (if no dynamic)
| name : <Vlan::IgnoredQosProfileName> ) assigned to a port
Possible values: This element is always shown.
- none : no profile name to associate
- name : enter profile name to be associated
Field type <Vlan::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64
status Parameter type: <Vlan::DataStatus> nature of the data shown. The
( static value true indicates that any or all
| dynamic ) of the displayed parameters is
Possible values: dynamic.
- static : data configured by operator This element is only shown in
- dynamic : dynamic data detail mode.
sub-vlan Parameter type: <Vlan::StackedVlan> the subscriber vlan associated to
( <Vlan::UVlanIndex> bridge port
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> ) This element is always shown.
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4094,4097]
Command Description
This command displays the stacked VLANs configured in the system.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.5-1 "Stacked VLAN Status Command" Resource Parameters
Resource Identifier Type Description
(s-vlanid) Format: vlan id
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
vlan-id Parameter type: <Vlan::StackedVlan> customer vlan
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
Command Description
This command displays the stacked VLANs configured in the system.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.6-1 "Stacked QoS VLAN Status Command" Resource Parameters
Resource Identifier Type Description
(s-vlanid) Format: vlan id
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
vlan-id Parameter type: <Vlan::StackedVlan> customer vlan
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
Command Description
This command shows the QOS CVlans configured in the system.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.7-1 "QoS C-VLAN Status Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: customer vlan
- a signed integer
Command Description
This command displays all parameters for a particular VLAN of the type Layer 2 terminated VLAN.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.8-1 "Layer-2 Terminated VLAN Status Command" Resource Parameters
Resource Identifier Type Description
(vlanid) Format: vlan id
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
Command Output
Table 48.8-2 "Layer-2 Terminated VLAN Status Command" Display parameters
Specific Information
name Type Description
fdb-id Parameter type: <Vlan::Gauge> identity of the filtering database
- an unsigned integer This element is always shown.
filter-entries Parameter type: <Vlan::Counter> number of entries in the filtering
- an unsigned integer database
This element is always shown.
network-ifindex Parameter type: <Vlan::Integer> interface index of the IpoE
- a signed integer interface related to this VLAN, at
Command Description
This command displays the VLAN identity that corresponds to a given VLAN name.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.9-1 "VLAN Name Mapping Status Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name used to identify the vlan
- char string
- length: x<=32
Command Output
Table 48.9-2 "VLAN Name Mapping Status Command" Display parameters
Specific Information
name Type Description
id Parameter type: <Vlan::StackedVlan> the vlan identity
( <Vlan::UVlanIndex> This element is always shown.
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4094,4097]
Command Description
This command displays, given a particular VLAN, a unicast MAC address and a bridge port, an entry of the
filtering database, if any. The filtering dabatase is used by the bridging function in determining how to propagate a
received frame.
The status parameter indicates what the trigger was for creation of the filtering database entry, that is, a filtering
entry can be configured or dynamically learned.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.10-1 "VLAN Filtering Database Status Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
mac Parameter type: <Vlan::MacAddr> mac address
Format:
- mac address (aa:bb:cc:a1:02:03)
- length: 6
bridge-port Parameter type: <Vlan::BridgePort> Identifies uniquely a port of the
Format: VLAN-Bridge within the system
- bridge port
- range: [1...65536]
Command Output
Command Description
This command displays all entries of the filtering database for a particular bridge port. The filtering database is
used by the bridging function in determining how to propagate a received frame.
The status parameter indicates what the trigger was for creation of the filtering database entry, that is, a filtering
entry can be configured or dynamically learned.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.11-1 "Bridge Port Filtering Database Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. atm PVC,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / EFM port, ...)
<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
vlan-id Parameter type: <Vlan::StackedVlan> vlan id
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
Command Output
Table 48.11-2 "Bridge Port Filtering Database Status Command" Display parameters
Specific Information
name Type Description
status Parameter type: <Vlan::FdbEntryStatus> the origin of the entry, unless
( other invalid
| invalid This element is always shown.
| learned
| self
| static )
Possible values:
- other : entry does not determine the forwarding of frames
- invalid : entry is being removed
- learned : entry has been learned dynamically
- self : entry represents one of the device's addresses
- static : entry has been configured by a manager
sub-vlan Parameter type: <Vlan::StackedVlan> the subscriber vlan associated to
( <Vlan::UVlanIndex> bridge port
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> ) This element is always shown.
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4094,4097]
Command Description
This command displays all VLANs associated with a given port.
Such association is either static, while it has been configured by the operator, or the association has been
established dynamically as a result of port authentication using RADIUS protocol.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.12-1 "Port VLAN Association Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. atm PVC,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / EFM port, ...)
<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
Command Output
Table 48.12-2 "Port VLAN Association Status Command" Display parameters
Specific Information
name Type Description
vlanid Parameter type: <Vlan::StackedVlan> vlan id
( <Vlan::UVlanIndex> This element is always shown.
Command Description
This command displays, for a given priority regeneration profile, the mapping of the external p-bit codepoints
versus the internal priority. Such a profile provides a mapping for both the upstream and the downstream direction.
These priority regeneration profiles and their contents are predetermined and cannot be changed by the operator.
A priority regeneration profile is assigned to a bridge port when configuring the bridge port.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.13-1 "VLAN Priority Regeneration Profile Status Command" Resource Parameters
Resource Identifier Type Description
(profile-id) Format: profile id
( trusted-port
| best-effort
| cl-all-prio-3
| cl-all-prio-4
| background
| be-cl-voice
| be-cl-1d-voice
| be-voice
| l2-vpn-3
| l2-vpn-4 )
Possible values:
- trusted-port : trusted port
- best-effort : best effort
- cl-all-prio-3 : controlled load, all priority 3 traffic
- cl-all-prio-4 : controlled load, all priority 4 traffic
- background : background
- be-cl-voice : best effort, controlled load, voice
- be-cl-1d-voice : best effort, controlled load, 802.Id Annex
G voice
- be-voice : best effort voice
- l2-vpn-3 : L2 VPN with 3 traffic classes
Command Output
Table 48.13-2 "VLAN Priority Regeneration Profile Status Command" Display parameters
Specific Information
name Type Description
name Parameter type: <Vlan::AdminString> name of the profile
- char string This element is always shown.
- length: x<=32
Only Show Details: priority regeneration for up stream
name Type Description
priority-0 Parameter type: <Vlan::NibbleMask_0> the regenerated priority for .1p
- nibble mask priority codepoint 0
This element is only shown in
detail mode.
priority-1 Parameter type: <Vlan::NibbleMask_1> the regenerated priority for .1p
- nibble mask priority codepoint 1
This element is only shown in
detail mode.
priority-2 Parameter type: <Vlan::NibbleMask_2> the regenerated priority for .1p
- nibble mask priority codepoint 2
This element is only shown in
detail mode.
priority-3 Parameter type: <Vlan::NibbleMask_3> the regenerated priority for .1p
- nibble mask priority codepoint 3
This element is only shown in
detail mode.
priority-4 Parameter type: <Vlan::NibbleMask_4> the regenerated priority for .1p
- nibble mask priority codepoint 4
This element is only shown in
detail mode.
priority-5 Parameter type: <Vlan::NibbleMask_5> the regenerated priority for .1p
- nibble mask priority codepoint 5
This element is only shown in
detail mode.
priority-6 Parameter type: <Vlan::NibbleMask_6> the regenerated priority for .1p
- nibble mask priority codepoint 6
This element is only shown in
detail mode.
priority-7 Parameter type: <Vlan::NibbleMask_7> the regenerated priority for .1p
- nibble mask priority codepoint 7
This element is only shown in
detail mode.
Only Show Details: priority regeneration for down stream
name Type Description
priority-0 Parameter type: <Vlan::NibbleMask_0> the regenerated priority for .1p
- nibble mask priority codepoint 0
This element is only shown in
detail mode.
priority-1 Parameter type: <Vlan::NibbleMask_1> the regenerated priority for .1p
- nibble mask priority codepoint 1
This element is only shown in
detail mode.
Command Description
This command is useful when a duplicate MAC alarm has occurred. A duplicate MAC alarm is raised when a new
MAC address could not be learned on a port because this MAC address already exists on another port for the same
VLAN, that is, within the same filtering database. The information displayed indicates the port where the MAC
address is assigned, that is, the original port.
The duplicate MAC alarm information is available as long as the alarm is on.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.14-1 "Duplicate MAC Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(dup-port) Format: identity of a port(e.g. atm PVC,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / EFM port, ...)
<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
dup-vlan-id Parameter type: <Vlan::StackedVlan> duplicate vlan id
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
Command Output
Table 48.14-2 "Duplicate MAC Alarm Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::BridgePort> identity of a port(e.g. atm PVC,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / EFM port, ...)
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> This element is always shown.
| <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
sub-vlan Parameter type: <Vlan::StackedVlan> the subscriber vlan associated to
( <Vlan::UVlanIndex> bridge port
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> ) This element is always shown.
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4094,4097]
Command Description
This command displays all the kinds of events that occurred on a given port. These events relate to error cases.
The display element no-mac-learn that indicates that not all mac addresses are learned, is not applicable for intel
boards.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.15-1 "Port Event Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. atm PVC,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / EFM port, ...)
<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
Command Output
Table 48.15-2 "Port Event Status Command" Display parameters
Specific Information
name Type Description
bridge-port Parameter type: <Vlan::BridgePort> bridge port
- bridge port This element is always shown.
Command Description
This command displays performance statistics for the current quarter for a particular port. Counters for upstream
and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE relayed and
PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.16-1 "Port Statistics for Current Quarter Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. atm PVC,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / EFM port, ...)
<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
Command Output
Table 48.16-2 "Port Statistics for Current Quarter Status Command" Display parameters
Specific Information
name Type Description
elapsed-time Parameter type: <Vlan::StatsTime> elapsed time in this interval, i.e.
- time for the current 15 minutes
- unit: sec interval; expressed in seconds
This element is always shown.
measure-time Parameter type: <Vlan::StatsTime> actually measured time in this
- time interval; expressed in seconds
- unit: sec This element is always shown.
Only Show Details: up stream counters
name Type Description
forward-frame Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
forward-byte Parameter type: <Vlan::OctetCounter> number of bytes forwarded in
- vlan counter upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
discard-frame Parameter type: <Vlan::OctetCounter> number of discarded frames in
- vlan counter upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
discard-byte Parameter type: <Vlan::OctetCounter> number of discarded bytes in
- vlan counter upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
Only Show Details: down stream counters
name Type Description
forward-frame Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
forward-byte Parameter type: <Vlan::OctetCounter> number of bytes forwarded in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
discard-frame Parameter type: <Vlan::OctetCounter> number of discarded frames in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
discard-byte Parameter type: <Vlan::OctetCounter> number of discarded bytes in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
Command Description
This command shows Performance Statistics for the current day for a particular port. Counters for upstream and
downstream traffic are displayed. These counters include all traffic on the port, including PPPoE Relayed and
PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.17-1 "Port Statistics for Current Day Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. atm PVC,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / EFM port, ...)
<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
Command Output
Table 48.17-2 "Port Statistics for Current Day Status Command" Display parameters
Specific Information
name Type Description
elapsed-time Parameter type: <Vlan::StatsTime> elapsed time in this interval, i.e.
- time for the current day interval;
- unit: sec expressed in seconds
This element is always shown.
measure-time Parameter type: <Vlan::StatsTime> actually measured time in this
- time interval; expressed in seconds
- unit: sec This element is always shown.
Only Show Details: up stream counters
name Type Description
forward-frame Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
forward-byte Parameter type: <Vlan::OctetCounter> number of bytes forwarded in
- vlan counter upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
discard-frame Parameter type: <Vlan::OctetCounter> number of discarded frames in
- vlan counter upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
discard-byte Parameter type: <Vlan::OctetCounter> number of discarded bytes in
- vlan counter upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
Only Show Details: down stream counters
name Type Description
forward-frame Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
forward-byte Parameter type: <Vlan::OctetCounter> number of bytes forwarded in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
discard-frame Parameter type: <Vlan::OctetCounter> number of discarded frames in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
discard-byte Parameter type: <Vlan::OctetCounter> number of discarded bytes in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
Command Description
This command displays performance statistics for the previous quarter intervals, for a particular port. Counters for
upstream and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE
relayed and PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.
The interval is specified. Interval number 1 identifies the most recent completed quarter interval. From there
onward, interval numbers are incremented by 1. Higher interval numbers relate to less recent intervals.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.18-1 "Port Statistics for Previous Quarter Intervals Status Command" Resource
Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. atm PVC,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / EFM port, ...)
<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
interval-number Parameter type: <Vlan::SignedInteger> interval number, where 1 is the
Command Output
Table 48.18-2 "Port Statistics for Previous Quarter Intervals Status Command" Display parameters
Specific Information
name Type Description
measure-time Parameter type: <Vlan::StatsTime> actually measured time in this
- time interval; expressed in seconds
- unit: sec This element is always shown.
Only Show Details: up stream counters
name Type Description
forward-frame Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
forward-byte Parameter type: <Vlan::OctetCounter> number of bytes forwarded in
- vlan counter upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
discard-frame Parameter type: <Vlan::OctetCounter> number of discarded frames in
- vlan counter upstream direction on a bridge
port, for the specified interval.
Frames are discarded as a result
of buffer acceptance or policing
This element is only shown in
detail mode.
discard-byte Parameter type: <Vlan::OctetCounter> number of discarded bytes in
- vlan counter upstream direction on a bridge
port, for the specified interval.
Discarding is a result of buffer
acceptance or policing
This element is only shown in
detail mode.
Only Show Details: down stream counters
name Type Description
forward-frame Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
forward-byte Parameter type: <Vlan::OctetCounter> number of bytes forwarded in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
discard-frame Parameter type: <Vlan::OctetCounter> number of discarded frames in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
Command Description
This command displays performance statistics for the previous day intervals for a particular port. Counters for
upstream and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE
relayed and PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.
The interval is specified. Interval number 1 identifies the most recent completed day interval. From there onward,
interval numbers are incremented by 1. Higher interval numbers relate to less recent intervals.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.19-1 "Port Statistics for Previous Day Intervals Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identity of a port(e.g. atm PVC,
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / EFM port, ...)
<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
interval-number Parameter type: <Vlan::SignedInteger> interval number
Format:
Command Output
Table 48.19-2 "Port Statistics for Previous Day Intervals Status Command" Display parameters
Specific Information
name Type Description
measure-time Parameter type: <Vlan::StatsTime> actually measured time in this
- time interval; expressed in seconds
- unit: sec This element is always shown.
Only Show Details: up stream counters
name Type Description
forward-frame Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
forward-byte Parameter type: <Vlan::OctetCounter> number of bytes forwarded in
- vlan counter upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
discard-frame Parameter type: <Vlan::OctetCounter> number of discarded frames in
- vlan counter upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
discard-byte Parameter type: <Vlan::OctetCounter> number of discarded bytes in
- vlan counter upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
Only Show Details: down stream counters
name Type Description
forward-frame Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
forward-byte Parameter type: <Vlan::OctetCounter> number of bytes forwarded in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
discard-frame Parameter type: <Vlan::OctetCounter> number of discarded frames in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
discard-byte Parameter type: <Vlan::OctetCounter> number of discarded bytes in
- vlan counter downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
Command Description
This command displays performance statistics for the current quarter for a particular VLAN and port. Counters for
upstream and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE
relayed and PPPoE terminated traffic.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.20-1 "VLAN Port Statistics for Current Quarter Status Command" Resource Parameters
Resource Identifier Type Description
(vlanid) Format: vlan id
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
port Parameter type: <Itf::AtmInterfaceVpiVci> identity of a port(e.g. atm PVC,
Format: EFM port, ...)
( <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
Command Output
Table 48.20-2 "VLAN Port Statistics for Current Quarter Status Command" Display parameters
Specific Information
name Type Description
elapsed-time Parameter type: <Vlan::StatsTime> elapsed time in this interval, i.e.
- time for the current 15 minutes
- unit: sec interval; expressed in seconds
This element is always shown.
measure-time Parameter type: <Vlan::StatsTime> actually measured time in this
- time interval; expressed in seconds
- unit: sec This element is always shown.
Only Show Details: up stream counters
name Type Description
forward-frame Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
forward-byte Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
discard-frame Parameter type: <Vlan::OctetCounter> number of discarded frames in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
discard-byte Parameter type: <Vlan::OctetCounter> number of discarded bytes in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
Only Show Details: down stream counters
name Type Description
forward-frame Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
Command Description
This command displays performance statistics for the current day for a particular VLAN and port. Counters for
upstream and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE
relayed and PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.21-1 "VLAN Port Statistics for Current Day Status Command" Resource Parameters
Resource Identifier Type Description
(vlanid) Format: vlan id
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
port Parameter type: <Itf::AtmInterfaceVpiVci> identity of a port(e.g. atm PVC,
Format: EFM port, ...)
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
Command Output
Table 48.21-2 "VLAN Port Statistics for Current Day Status Command" Display parameters
Specific Information
name Type Description
elapsed-time Parameter type: <Vlan::StatsTime> elapsed time in this interval, i.e.
- time for the current 15 minutes
- unit: sec interval; expressed in seconds
This element is always shown.
measure-time Parameter type: <Vlan::StatsTime> actually measured time in this
- time interval; expressed in seconds
- unit: sec This element is always shown.
Only Show Details: up stream counters
name Type Description
forward-frame Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
forward-byte Parameter type: <Vlan::OctetCounter> number of bytes forwarded in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
discard-frame Parameter type: <Vlan::OctetCounter> number of discarded frames in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
discard-byte Parameter type: <Vlan::OctetCounter> number of discarded bytes in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
Only Show Details: down stream counters
name Type Description
forward-frame Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter downstream direction per VLAN
Command Description
This command displays performance statistics for the previous quarter intervals for a particular VLAN and port.
Counters for upstream and downstream traffic are displayed. These counters include all traffic on the port,
including PPPoE relayed and PPPoE terminated traffic.
The interval is specified. Interval number 1 identifies the most recent completed quarter interval. From there
onward, interval numbers are incremented by 1. Higher interval numbers relate to less recent intervals.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.22-1 "VLAN Port Statistics for Previous Quarter Intervals Status Command" Resource
Parameters
Resource Identifier Type Description
(vlanid) Format: vlan id
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
port Parameter type: <Itf::AtmInterfaceVpiVci> identity of a port(e.g. atm PVC,
Format: EFM port, ...)
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
Command Output
Table 48.22-2 "VLAN Port Statistics for Previous Quarter Intervals Status Command" Display
parameters
Specific Information
name Type Description
measure-time Parameter type: <Vlan::StatsTime> actually measured time in this
- time interval; expressed in seconds
- unit: sec This element is always shown.
Only Show Details: up stream counters
name Type Description
forward-frame Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
forward-byte Parameter type: <Vlan::OctetCounter> number of bytes forwarded in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
discard-frame Parameter type: <Vlan::OctetCounter> number of discarded frames in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
discard-byte Parameter type: <Vlan::OctetCounter> number of discarded bytes in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
Command Description
This command displays performance statistics for the previous day intervals for a particular VLAN and port.
Counters for upstream and downstream traffic are displayed. These counters include all traffic on the port,
including PPPoE relayed and PPPoE terminated traffic.
The interval is specified. Interval number 1 identifies the most recent completed day interval. From there onward,
interval numbers are incremented by 1. Higher interval numbers relate to less recent intervals.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.23-1 "VLAN Port Statistics for Previous Day Intervals Status Command" Resource
Parameters
Resource Identifier Type Description
(vlanid) Format: vlan id
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
port Parameter type: <Itf::AtmInterfaceVpiVci> identity of a port(e.g. atm PVC,
Format: EFM port, ...)
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
Command Output
Table 48.23-2 "VLAN Port Statistics for Previous Day Intervals Status Command" Display
parameters
Specific Information
name Type Description
measure-time Parameter type: <Vlan::StatsTime> actually measured time in this
- time interval; expressed in seconds
- unit: sec This element is always shown.
Only Show Details: up stream counters
name Type Description
forward-frame Parameter type: <Vlan::OctetCounter> number of frames forwarded in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
forward-byte Parameter type: <Vlan::OctetCounter> number of bytes forwarded in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
discard-frame Parameter type: <Vlan::OctetCounter> number of discarded frames in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
discard-byte Parameter type: <Vlan::OctetCounter> number of discarded bytes in
- vlan counter upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
Command Description
This command displays all VLANs associated with a given port on the SHub. This association is configured, but
can be overruled as a result of authentication of the port using RADIUS protocol.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.24-1 "SHub Port VLAN Association Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: port
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
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
Field type <Shub::NoExtLink>
- unassigned external SFP port
vlan-id Parameter type: <Sys::VlanId> identity of the vlan
Format:
- vlan id
- range: [1...4093]
Command Description
This command displays the VLAN identity that corresponds to a given VLAN name, for a VLAN configured on the
SHub.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.25-1 "SHub VLAN Name Mapping Status Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name identifying the vlan
- char string
- length: x<=32
Command Output
Table 48.25-2 "SHub VLAN Name Mapping Status Command" Display parameters
Specific Information
name Type Description
vlan-id Parameter type: <Vlan::VlanNameIndex> vlan identity
- vlan id This element is always shown.
- range: [1...4093,4097]
Command Description
This command displays all entries of the filtering database given a particular VLAN on the SHub. The filtering
dabatase is used by the bridging function in determining how to propagate a received frame.
The status parameter indicates what the trigger was for creation of the filtering database entry, that is, a filtering
entry can be configured or dynamically learned.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.26-1 "SHub VLAN Filtering Database Status Command" Resource Parameters
Resource Identifier Type Description
(vlanid) Format: vlan id
- vlan id
- range: [1...4093]
Command Output
Table 48.26-2 "SHub VLAN Filtering Database Status Command" Display parameters
Specific Information
name Type Description
mac Parameter type: <Vlan::MacAddr> mac address
- mac address (aa:bb:cc:a1:02:03) This element is always shown.
- length: 6
bridge-port Parameter type: <Shub::Port> bridge port
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId> This element is always shown.
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
Command Description
This command displays one entry of the filtering database -if any- given a particular VLAN, a unicast MAC address
and a bridge port on the SHub. The filtering dabatase is used by the bridging function in determining how to
propagate a received frame.
The status parameter indicates what the trigger was for creation of the filtering database entry, that is, a filtering
entry can be configured or dynamically learned.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.27-1 "SHub Filtering Database Entry Status Command" Resource Parameters
Resource Identifier Type Description
(vlanid) Format: vlan id
- vlan id
- range: [1...4093]
unicast-mac Parameter type: <Vlan::MacAddr> mac address
Format:
- mac address (aa:bb:cc:a1:02:03)
- length: 6
Command Output
Table 48.27-2 "SHub Filtering Database Entry Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Shub::Port> port where the mac address was
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId> learnt
| network : <Shub::NetworkPort> This element is always shown.
| nt
| unassigned-link : <Shub::NoExtLink> )
Possible values:
- lt : port of the line board
Command Description
This command displays the status of a duplicate MAC alarm. This command is useful when a duplicate MAC alarm
has occurred. A duplicate MAC alarm is raised when a new MAC address could not be learned on a port of the
SHub because this MAC address already exists on another port of the SHub for the same VLAN, that is, within the
same filtering database.
When a duplicate MAC alarm is raised, it provides the port and VLAN identity where the alarm occurred, but it
does not carry the MAC address.
This command is helpful in displaying the list of duplicate MAC Addresses on the specific port and VLAN.
The duplicate MAC alarm information is available as long as the alarm is "on".
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 48.28-1 "SHub Duplicate MAC Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(dup-vlan-id) Format: duplicate vlan id
- vlan id
- range: [1...4093]
dup-port Parameter type: <Shub::Port> duplicate bridge port
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
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 Output
Table 48.28-2 "SHub Duplicate MAC Alarm Status Command" Display parameters
Specific Information
name Type Description
duplicate-mac Parameter type: <Vlan::MacAddr> duplicate mac address
- mac address (aa:bb:cc:a1:02:03) This element is always shown.
- length: 6
Command Description
This command displays the number of active multicast entries in the SHub.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 48.29-2 "SHub Number Of Active Multicast Entries Status Command" Display parameters
Specific Information
name Type Description
nrmcast-entries Parameter type: <Vlan::ActiveNrMcastEntries> number of active multicast
- a signed integer entries.
This element is always shown.
Description
This chapter gives an overview of nodes that are handled by "Link Aggregation Status Commands".
Command Tree
----show
----la
----aggregator-info
- (port)
----aggregate-list
- (network-port)
- participant-port
----network-port-info
- (port)
Command Description
This command displays information about a Link Aggregation Group configured on the SHub. The information
pertains to the Group. The operator identifies the group by means of the primary link or primary port.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 49.2-1 "Link Aggregation Group Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: interface index of the port
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Command Output
Table 49.2-2 "Link Aggregation Group Status Command" Display parameters
Specific Information
name Type Description
mac-address Parameter type: <Vlan::MacAddr> Specifies MAC address assigned
- mac address (aa:bb:cc:a1:02:03) to the Aggregator.
- length: 6 This element is shown in normal
mode.
aggregate Parameter type: <Shub::AggregateFlag> Specifies whether the aggregator
( ( aggregate | yes ) represents an aggregate or an
| ( individual | no ) ) individual link.
Possible values: This element is shown in normal
- aggregate : aggregate mode.
- yes : aggregate
- individual : individual
- no : individual
actor-oper-key Parameter type: <Shub::LacpKey> The current operational value of
short name: actor-key - link aggregate key the key for the aggregator.
- range: [0...65535] This element is shown in normal
mode.
Command Description
This command displays the list of ports that are members of a Link Aggregation Group.
The Link Aggregation Group should be identified by means of its primary link, otherwise, the list of ports will be
empty.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 49.3-1 "Link Aggregation Member List Status Command" Resource Parameters
Resource Identifier Type Description
(network-port) Format: port
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
participant-port Parameter type: <Shub::NetworkPort> participants in the aggregation
Format: group
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Command Description
This command displays information for a member of a Link Aggregation Group configured on the SHub. The
member link is identified by its port number.
Detailed information can be obtained on LACP protocol statistics and debugging information.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 49.4-1 "Link Aggregate Member Link Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: interface index of the network
<Shub::NetworkPort> port
Field type <Shub::NetworkPort>
- network port on Shub
Command Output
Table 49.4-2 "Link Aggregate Member Link Status Command" Display parameters
Specific Information
name Type Description
aggregate Parameter type: <Shub::AggregateFlag> specifies whether the aggregation
( ( aggregate | yes ) port is able to aggregate or only
| ( individual | no ) ) able to operate as an individual
Possible values: link.
- aggregate : aggregate This element is always shown.
- yes : aggregate
- individual : individual
- no : individual
standby Parameter type: <Shub::SbyStatus> specifies whether aggregation
( ( active | no ) port is in active or standby
| ( standby | yes ) ) This element is always shown.
Possible values:
- active : active
- no : active
- standby : standby
Description
This chapter gives an overview of nodes that are handled by "QOS Status Commands".
Command Tree
----show
----qos
----profile-usage
----session
- (name)
----marker
- (name)
----policer
- (name)
----queue
- (name)
----scheduler
- (name)
----cac
- (name)
----policy
- (name)
----l2-filter
- (name)
----l3-filter
- (name)
----policy-action
- (name)
----dsl-bandwidth
- (index)
----shdsl-bandwidth
- (index)
----ethernet-bandwidth
- (index)
----statistics
----buffer-overflow
----prev-15min
- (equip-slot)
- interval-num
----current-15min
- (equip-slot)
----prev-1day
- (equip-slot)
----current-1day
- (equip-slot)
----total
- (equip-slot)
----queue
----prev-15min
- (index)
- queue
- interval-num
----current-15min
- (index)
- queue
----ltcos
----prev-15min
- (equip-slot)
- traffic-class
- interval-num
----current-15min
- (equip-slot)
- traffic-class
----pre-1day
- (equip-slot)
- interval-num
----current-1day
- (equip-slot)
----shub
----meter
- (index)
----flow
- (index)
Command Description
This command displays the QoS session profile status. A QoS profile that is in use cannot be deleted, so the
operator can use this command to display the usage of QoS session profiles. The QoS session profile usage
represents the total user sessions (both for statically configured and dynamic sessions).
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.2-1 "QoS Session Profile Status 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 Output
Table 50.2-2 "QoS Session Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count Parameter type: <AsamProfileRefCount> Indicates the number of entities
- number of entities using this particular profile using this profile. If the reference
- range: [0...65535] count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.
Command Description
This command displays the QoS marker profile status. A QoS profile that is in use cannot be deleted, so the
operator can use this command to display the usage of QoS marker profiles. The QoS marker profile usage shows
the references from existing QoS session profiles because these profiles are not applied on their own.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.3-1 "QoS Marker Profile Status 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 Output
Table 50.3-2 "QoS Marker Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count Parameter type: <AsamProfileRefCount> Indicates the number of entities
- number of entities using this particular profile using this profile. If the reference
- range: [0...65535] count is greater than 0, then this
profile 'is in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.
Command Description
This command displays the QoS policer profile status. A QoS profile that is in use cannot be deleted, so the
operator can use this command to display the usage of QoS policer profiles. The QoS policer profile usage shows
the references from existing QoS session profiles because these profiles are not applied on their own.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.4-1 "QoS Policer Profile Status 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 Output
Table 50.4-2 "QoS Policer Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count Parameter type: <AsamProfileRefCount> Indicates the number of entities
- number of entities using this particular profile using this profile. If the reference
- range: [0...65535] count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.
Command Description
This command displays the QoS queue profile status. A QoS profile that is in use cannot be deleted, so the operator
can use this command to display the usage of QoS queue profiles. The QoS queue profile usage shows the
references from existing QoS session profiles because these profiles are not applied on their own.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.5-1 "QoS Queue Profile Status 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 Output
Table 50.5-2 "QoS Queue Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count Parameter type: <AsamProfileRefCount> indicates the number of entities
- number of entities using this particular profile using this profile. If the reference
- range: [0...65535] count is not 0, then this profile is
'in use', and can not be deleted. If
the value is 0, then this profile is
'not in use', and can be deleted.
This element is always shown.
Command Description
This command displays the QoS scheduler profile status. A QoS profile that is in use cannot be deleted, so the
operator can use this command to display the usage of QoS scheduler profiles. The QoS scheduler profile usage
shows the references from existing QoS session profiles because these profiles are not applied on their own.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.6-1 "QoS Scheduler Profile Status 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 Output
Table 50.6-2 "QoS Scheduler Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count Parameter type: <AsamProfileRefCount> Indicates the number of entities
- number of entities using this particular profile using this profile. If the reference
- range: [0...65535] count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.
Command Description
This command displays the QoS CAC profile status. A QoS profile that is in use cannot be deleted, so the operator
can use this command to display the usage of QoS CAC profiles. The QoS CAC profile usage displays the
references from existing QoS session profiles because these profiles are not applied on their own.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.7-1 "QoS CAC Profile Status 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 Output
Table 50.7-2 "QoS CAC Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count Parameter type: <AsamProfileRefCount> indicates the number of entities
- number of entities using this particular profile using this profile. If the reference
- range: [0...65535] count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.
Command Description
This command displays the QoS policy profile status. A QoS profile in use cannot be deleted. Use this command to
display the usage of QoS policy profiles. The QoS policy profile usage shows the references from existing QoS
session profiles because these profiles are not applied on their own.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.8-1 "QoS Policy Profile Status 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 Output
Table 50.8-2 "QoS Policy Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count Parameter type: <AsamProfileRefCount> indicates the number of entities
- number of entities using this particular profile using this profile. If the reference
- range: [0...65535] count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.
Command Description
This command displays the QoS L2 filter profile status. A QoS profile in use cannot be deleted. Use this command
to display the usage of QoS L2 filter profiles. The QoS L2 filter profile usage shows the references from existing
QoS session profiles because these profiles are not applied on their own.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.9-1 "QoS L2 Filter Profile Status 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 Output
Table 50.9-2 "QoS L2 Filter Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count Parameter type: <AsamProfileRefCount> indicates the number of entities
- number of entities using this particular profile using this profile. If the reference
- range: [0...65535] count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.
Command Description
This command displays the QoS L3 filter profile status. A QoS profile in use cannot be deleted. Use this command
to display the usage of QoS L3 Filter profiles. The QoS L3 filter profile usage shows the references from existing
QoS session profiles because these profiles are not applied on their own.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.10-1 "QoS L3 Filter Profile Status 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 Output
Table 50.10-2 "QoS L3 Filter Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count Parameter type: <AsamProfileRefCount> indicates the number of entities
- number of entities using this particular profile using this profile. If the reference
- range: [0...65535] count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.
Command Description
This command displays the QoS policy action profile status. A QoS profile in use cannot be deleted. Use this
command to display the usage of policy action profiles. The QoS policy action profile usage shows the references
from existing QoS session profiles because these profiles are not applied on their own.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.11-1 "QoS Policy Action Profile Status 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 Output
Table 50.11-2 "QoS Policy Action Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count Parameter type: <AsamProfileRefCount> indicates the number of entities
- number of entities using this particular profile using this profile. If the reference
- range: [0...65535] count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.
Command Description
This command displays the bandwidth allocation and usage for each DSL link.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.12-1 "QoS DSL Bandwidth Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: physical port of a dsl 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
Command Output
Table 50.12-2 "QoS DSL Bandwidth Status Command" Display parameters
Specific Information
name Type Description
frame-net-bw Parameter type: <SignedInteger> Represents an approximation of
- a signed integer the bandwidth available for
Ethernet frames. This
approximation is made by using
an appropriate overhead factor
(ATM, EFM, ..). The basis for
the calculus can be minimum
sync rate or actual sync rate, or
the native bandwidth for
non-xDSL interfaces.
This element is always shown.
Command Description
This command displays the bandwidth allocation and usage for each Shdsl link.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.13-1 "QoS Shdsl Bandwidth Status 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
Command Output
Table 50.13-2 "QoS Shdsl Bandwidth Status Command" Display parameters
Specific Information
name Type Description
frame-net-bw Parameter type: <SignedInteger> Represents the approximate
- a signed integer bandwidth available for Ethernet
frames, which is guaranteed to be
available by the physical layer.
This approximation is made by
the configurable ATM overhead
factor.
This element is always shown.
res-data-bw Parameter type: <SignedInteger> The portion the frame-net-bw that
- a signed integer is reserved for all data services
Command Description
This command displays the bandwidth allocation and usage for each Ethernet link.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.14-1 "QoS Ethernet Bandwidth Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: physical port of a ethernet 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
Command Output
Table 50.14-2 "QoS Ethernet Bandwidth Status Command" Display parameters
Specific Information
name Type Description
frame-net-bw Parameter type: <SignedInteger> Represents the approximate
- a signed integer bandwidth available for Ethernet
frames, which is guaranteed to be
available by the physical layer.
This approximation is made by
the configurable ATM overhead
factor.
This element is always shown.
res-data-bw Parameter type: <SignedInteger> The portion the frame-net-bw that
- a signed integer is reserved for all data services
Command Description
This command displays the buffer overflow for each unit applicable on dedicated buffer pools and not on individual
queues. These counters are supported on L3 units. Under normal working conditions, all these counters should
read zero.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.15-1 "QoS Total Buffer Overflow Statistics for Previous Quarter" Resource Parameters
Resource Identifier Type Description
(equip-slot) Format: physical position of the board
( 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
interval-num Parameter type: <Qos::CounterInterval> time interval interms of 15 min
Format:
- time interval interms of 15 mins
- range: [1...32]
Command Output
Table 50.15-2 "QoS Total Buffer Overflow Statistics for Previous Quarter" Display parameters
Specific Information
Command Description
This command displays the buffer overflow for each unit applicable on dedicated buffer pools and not on individual
queues. These counters are supported on L3 units. Under normal working conditions, all these counters should
read zero.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.16-1 "QoS Total Buffer Overflow Statistics for Current Quarter" Resource Parameters
Resource Identifier Type Description
(equip-slot) Format: physical position of the board
( 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
Command Output
Table 50.16-2 "QoS Total Buffer Overflow Statistics for Current Quarter" Display parameters
Specific Information
name Type Description
upstream Parameter type: <Counter> number of buffer overflows on an
- counter EBLT LIM module in the
upstream direction on a 15
Command Description
This command displays the buffer overflow for each unit applicable on dedicated buffer pools and not on individual
queues. These counters are supported on L3 units. Under normal working conditions, all these counters should
read zero.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.17-1 "QoS Total Buffer Overflow Statistics for Previous Day Command" Resource
Parameters
Resource Identifier Type Description
(equip-slot) Format: physical position of the board
( 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
Command Output
Table 50.17-2 "QoS Total Buffer Overflow Statistics for Previous Day Command" Display
parameters
Specific Information
name Type Description
upstream Parameter type: <Counter> the number of buffer overflows
Command Description
This command displays the buffer overflow for each unit applicable on dedicated buffer pools and not on individual
queues. These counters are supported on L3 units. Under normal working conditions, all these counters should
read zero.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.18-1 "QoS Total Buffer Overflow Statistics for Current Day" Resource Parameters
Resource Identifier Type Description
(equip-slot) Format: physical position of the board
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu 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 50.18-2 "QoS Total Buffer Overflow Statistics for Current Day" Display parameters
Specific Information
name Type Description
upstream Parameter type: <Counter> the number of buffer overflows
- counter on EBLT LIM modules in the
upstream direction on a one day
interval basis in the current
measurement period. The
upstream direction on the LIM is
non-blocking, hence this value
should read always zero under
normal working conditions.
This element is always shown.
upstream-obc Parameter type: <Counter> the number of buffer overflows
- counter on EBLT LIM modules for the
OBC-directed traffic upstream on
a one day interval basis in the
current measurement period. In
some special conditions such as
system startup or re-start packet
loss may occur here but under
normal circumstances this
counter should read zero.
This element is always shown.
downstream-obc Parameter type: <Counter> the number of buffer overflows
- counter on an EBLT LIM module for the
OBC-directed traffic downstream
on a one day interval basis in the
current measurement epoch.
under normal circumstances this
counter should always read zero.
This element is always shown.
downstream-unicast Parameter type: <Counter> a counter for the event of total
- counter buffer overflow of the
downstream unicast pool. Queue
fill-up and tail drop is a normal
condition for data traffic
(individual queues) but not for
voice and video on demand
services (individual queues). If
the total downstream pool is
filled, that means that QoS
un-aware packet loss will occur.
This element is always shown.
downstream-multicast Parameter type: <Counter> specifies number of times,
- counter current one day downstream
multicast total buffer pool
overflow - total buffer overflow
of the downstream multicast
pool. This even should be a rather
rare event. On the long term,
buffer overflow in the multicast
pool may occur a few times a day
(less than a few tens under heavy
Command Description
This command displays the buffer overflow for each unit applicable on dedicated buffer pools and not on individual
queues. The L3 units have four isolated buffer pools for upstream, downstream, multicast, and OBC-injected
traffic. Under normal working conditions, all these counters should read zero. Check these counters for QoS
problems, which can occur under heavy load conditions.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.19-1 "QoS Total Buffer Overflow Statistics Total Status Command" Resource Parameters
Resource Identifier Type Description
(equip-slot) Format: physical position of the board
( 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
Command Output
Table 50.19-2 "QoS Total Buffer Overflow Statistics Total Status Command" Display parameters
Specific Information
name Type Description
upstream Parameter type: <Counter> the number of buffer overflows
- counter per EBLT LIM module in the
Command Description
This command displays the interface-level QoS buffer overflow statistics of the previous 15 minute interval.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> show qos statistics queue prev-15min [ (index) [ queue <Qos::ExpandQueues> ] [ interval-num
<Qos::NumInterval> ] ]
Command Parameters
Table 50.20-1 "QoS Interface Buffer Overflow Statistics for Previous Quarter" Resource
Parameters
Resource Identifier Type Description
(index) Format: physical port of a dsl 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 Parameter type: <Qos::ExpandQueues> This object is used to index the
Format: queue within the scope of one
( all physical link on the LIM
| <Qos::ExpandQueues> )
Possible values:
- all : total physical line on the LIM
Field type <Qos::ExpandQueues>
- output dsl port expand queue number
- range: [0...3]
interval-num Parameter type: <Qos::NumInterval> time interval interms of 15 min
Format:
- time interval interms of 15 mins
- range: [1]
Command Output
Table 50.20-2 "QoS Interface Buffer Overflow Statistics for Previous Quarter" Display parameters
Specific Information
name Type Description
queue-load Parameter type: <Qos::WfqQ1Weight> Average queue load percentage
- weight of DSL link WFQ scheduler for Queue one This element is always shown.
- range: [0...100]
forward-byte Parameter type: <Qos::OctetCounter> number of bytes forwareded in
- qos counter this queue.
This element is always shown.
forward-frame Parameter type: <Qos::OctetCounter> number of frames forwared in
- qos counter this queue.
This element is always shown.
discard-byte Parameter type: <Counter> number of bytes discarded in this
- counter queue.
This element is always shown.
discard-frame Parameter type: <Counter> number of frames discarded in
- counter this queue.
This element is always shown.
measured-time Parameter type: <TimeTicks> The measured time interval since
- a timeout value the last measurement period
- unit: msec started.
This element is always shown.
Command Description
This command displays the interface-level QoS buffer overflow statistics of the current 15 minute interval.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.21-1 "QoS Interface Buffer Overflow Statistics for Current Quarter" Resource
Parameters
Resource Identifier Type Description
(index) Format: physical port of a dsl 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 Parameter type: <Qos::ExpandQueues> This object is used to index the
Format: queue within the scope of one
( all physical link on the LIM
| <Qos::ExpandQueues> )
Possible values:
- all : total physical line on the LIM
Field type <Qos::ExpandQueues>
- output dsl port expand queue number
- range: [0...3]
Command Output
Table 50.21-2 "QoS Interface Buffer Overflow Statistics for Current Quarter" Display parameters
Specific Information
name Type Description
queue-load Parameter type: <Qos::WfqQ1Weight> Average queue load percentage
- weight of DSL link WFQ scheduler for Queue one This element is always shown.
- range: [0...100]
forward-byte Parameter type: <Qos::OctetCounter> number of bytes forwareded in
- qos counter this queue.
This element is always shown.
forward-frame Parameter type: <Qos::OctetCounter> number of frames forwared in
- qos counter this queue.
This element is always shown.
discard-byte Parameter type: <Counter> number of bytes discarded in this
- counter queue.
This element is always shown.
discard-frame Parameter type: <Counter> number of frames discarded in
- counter this queue.
This element is always shown.
measured-time Parameter type: <TimeTicks> The measured time interval since
- a timeout value the last measurement period
- unit: msec started.
This element is always shown.
elapsed-time Parameter type: <TimeTicks> The measured time interval since
- a timeout value the last measurement period
- unit: msec started.
This element is always shown.
Command Description
This command shows the QoS Fan Out statistics of the previous 15 minute interval.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> show qos statistics ltcos prev-15min [ (equip-slot) [ traffic-class <Qos::TrafficClass> ] [ interval-num
<Qos::NumIntervalExpand> ] ]
Command Parameters
Table 50.22-1 "QoS Fan Out Statistics for Previous Quarter" Resource Parameters
Resource Identifier Type Description
(equip-slot) Format: physical position of the board
( 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
traffic-class Parameter type: <Qos::TrafficClass> This object is used to index the
Format: traffic class on the LIM
- value of traffic class, the received frame is mapped to
- range: [0...8]
interval-num Parameter type: <Qos::NumIntervalExpand> time interval interms of 15 min
Format:
- time interval interms of 15 mins
- range: [1...96]
Command Output
Table 50.22-2 "QoS Fan Out Statistics for Previous Quarter" Display parameters
Specific Information
Command Description
This command shows the QoS Fan Out statistics of the current 15 minutes interval.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.23-1 "QoS Fan Out Statistics for Current 15 minutes" Resource Parameters
Resource Identifier Type Description
(equip-slot) Format: physical position of the board
( 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
traffic-class Parameter type: <Qos::TrafficClass> This object is used to index the
Format: traffic class on the LIM
- value of traffic class, the received frame is mapped to
- range: [0...8]
Command Output
Table 50.23-2 "QoS Fan Out Statistics for Current 15 minutes" Display parameters
Specific Information
name Type Description
load Parameter type: <Qos::WfqQ1Weight> traffic class load percentage
Command Description
This command shows the QoS Fan Out statistics of the previous 1 day interval.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.24-1 "QoS Fan Out Statistics for Previous Day " Resource Parameters
Resource Identifier Type Description
(equip-slot) Format: physical position of the board
( 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
interval-num Parameter type: <Qos::NumInterval> time interval interms of one day
Format:
- time interval interms of 15 mins
- range: [1]
Command Output
Table 50.24-2 "QoS Fan Out Statistics for Previous Day " Display parameters
Specific Information
name Type Description
forward-byte Parameter type: <Qos::OctetCounter> number of bytes forwarded in this
- qos counter LIM.
This element is always shown.
forward-frame Parameter type: <Qos::OctetCounter> number of frames forwarded in
Command Description
This command shows the QoS fan out statistics of the current 1 day interval.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.25-1 "QoS Fan Out Statistics for Current Day" Resource Parameters
Resource Identifier Type Description
(equip-slot) Format: physical position of the board
( 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
Command Output
Table 50.25-2 "QoS Fan Out Statistics for Current Day" Display parameters
Specific Information
name Type Description
forward-byte Parameter type: <Qos::OctetCounter> number of bytes forwarded in this
- qos counter LIM.
This element is always shown.
forward-frame Parameter type: <Qos::OctetCounter> number of frames forwarded in
- qos counter this LIM.
This element is always shown.
elapsed-time Parameter type: <TimeTicks> The elapsed time interval since
- a timeout value the last measurement epoch
Command Description
This command displays the number of times the meter entry has been instantiated on any port.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.26-1 "QoS SHub Meter Statistics Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index used to identify a meter
- unique index for meter
- range: [1...64]
Command Output
Table 50.26-2 "QoS SHub Meter Statistics Status Command" Display parameters
Specific Information
name Type Description
ref-count Parameter type: <SignedInteger> nbr of times the meter is
- a signed integer instantiated/used on any port
This element is always shown.
Command Description
This command displays the number of times the flow has been instantiated on any port.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 50.27-1 "QoS SHub Flow Statistics Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index used to identify a flow
- unique index for the flow
- range: [1...64]
Command Output
Table 50.27-2 "QoS SHub Flow Statistics Status Command" Display parameters
Specific Information
name Type Description
ref-count Parameter type: <SignedInteger> nbr of times the flow is
- a signed integer instantiated/used on any port
This element is always shown.
Description
This chapter gives an overview of nodes that are handled by "IP Status Commands".
Command Tree
----show
----ip
----vrf-statistics
- (vrf-id)
----ip-statistics
- (index)
----vrf-interface
----user
----port
- (port-interface)
----bridgeport
- (port-interface)
----vrf-route
- (index)
- dest-ip-address
- next-hop-address
----vrf-media
- (equip-slot)
- ip-address
----vrf-mapping
- (name)
----vrf-next-index
----shub
----vrf
- (index)
- vlan-id
----vrf-route
- (index)
- dest
- next-hop
----arp
- (vrf-id)
----vrf-media
- (vrf)
- ip-address
----dhcp-session
- (client)
- ip-addr
Command Description
This command displays VRF statistics.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.2-1 "IP VRF Statistics" Resource Parameters
Resource Identifier Type Description
(vrf-id) Format: an unique id of a VRF.
- a profile index
- range: [1...65535]
Command Output
Table 51.2-2 "IP VRF Statistics" Display parameters
Common Information:system statistics
name Type Description
ip-route-entries Parameter type: <Counter> the total number of IP routes in
- counter the system.
This element is always shown.
ip-net2media-entries Parameter type: <Counter> the total number of IP net2media
- counter entries.
This element is always shown.
Specific Information
name Type Description
ip-route-entries Parameter type: <Counter> the total number of routes in the
- counter system.
This element is always shown.
ip-net2media-entries Parameter type: <Counter> the total number net2media
- counter entries.
This element is always shown.
Command Description
Displays the IP interface statistics.
14 ethernet ports are supported.
Port 1 : Internal port used for management
Port 2 : External port used for management
Port 3 : Used for Layer 2 Control Protocol traffic to BRAS
Ports 4-14 : Not used
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.3-1 "IP Interface Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: specifies the if-index uniquely
<Eqpt::EthernetId> indentifying each interface
Field type <Eqpt::EthernetId>
- ehternet id
Command Output
Table 51.3-2 "IP Interface Status Command" Display parameters
Specific Information
name Type Description
description Parameter type: <PrintableString> shows the description of the
- printable string interface
This element is only shown in
detail mode.
oper-status Parameter type: <Ip::OperStatus> shows the operational status of
( up the interface
| down This element is always shown.
| testing
| unknown
| dormant )
Possible values:
Command Description
This command displays the user-side VRF IP interface statistics parameters.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.4-1 "IP VRF Interface User Port Status Command" Resource Parameters
Resource Identifier Type Description
(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> /
<Eqpt::PortId> )
Possible values:
- atm-port : atm port
- bridge-port : bridge port
Command Output
Table 51.4-2 "IP VRF Interface User Port Status Command" Display parameters
Specific Information
name Type Description
rx-pkts Parameter type: <Vlan::OctetCounter> show the number of received
- vlan counter packets
This element is always shown.
rx-octets Parameter type: <Vlan::OctetCounter> show the number of received
- vlan counter octets
This element is only shown in
detail mode.
rx-drop-pkts Parameter type: <Vlan::OctetCounter> show the number of received
- vlan counter packets which are dropped
This element is always shown.
rx-drop-octets Parameter type: <Vlan::OctetCounter> show the number of received
- vlan counter octets which are dropped
This element is only shown in
detail mode.
tx-pkts Parameter type: <Vlan::OctetCounter> show the number of transmitted
- vlan counter packets
This element is always shown.
tx-octets Parameter type: <Vlan::OctetCounter> show the number of transmitted
- vlan counter octets
This element is only shown in
detail mode.
tx-drop-pkts Parameter type: <Vlan::OctetCounter> show the number of transmitted
- vlan counter packets which are dropped
This element is only shown in
detail mode.
tx-drop-octets Parameter type: <Vlan::OctetCounter> show the number of transmitted
- vlan counter octets which are dropped
This element is only shown in
detail mode.
Command Description
Obsolete command, replaced by show ip vrf-interface user port.
This command displays the user-side VRF IP interface statistics parameters.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.5-1 "IP VRF Interface User Port Status Command" Resource Parameters
Resource Identifier Type Description
(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
Command Output
Table 51.5-2 "IP VRF Interface User Port Status Command" Display parameters
Specific Information
name Type Description
rx-pkts Parameter type: <Vlan::OctetCounter> show the number of received
Command Description
This command displays the VRF routes.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.6-1 "IP VRF Routes Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: an unique index of a vrf
- the VRF ID which uniquely identify a VRF
- range: [1...127]
dest-ip-address Parameter type: <Ip::AddressAndMaskFull> inet-address with prefix
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
next-hop-address Parameter type: <Ip::V4AddressHex> next hop IP address
Format:
- IPv4-address
Command Output
Table 51.6-2 "IP VRF Routes Status Command" Display parameters
Specific Information
name Type Description
layer3-itf Parameter type: <Itf::IpoeItf> the ipox interface on NT.
( xdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> / This element is always shown.
<Eqpt::SlotId> / <Eqpt::PortId>
| xdsl-channel : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-if : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
Command Description
This command displays the VRF net-to-media statistics.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.7-1 "IP VRF Net-to-Media Statistics Command" Resource Parameters
Resource Identifier Type Description
(equip-slot) Format: equipment slot ID.
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> :
<Eqpt::VrfId>
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::VrfId>
- VRF id
ip-address Parameter type: <Ip::V4Address> the IP-address.
Format:
- IPv4-address
Command Output
Table 51.7-2 "IP VRF Net-to-Media Statistics Command" Display parameters
Specific Information
name Type Description
physical-addr Parameter type: <Ip::PhysicalAddress> the physical IP-address.
- media dependent physical address This element is always shown.
- length: x<=65535
last-changed Parameter type: <Ip::TimeInSecs> date when it is changed for the
- age last time.
This element is only shown in
detail mode.
Command Description
This command displays the VRF mapping.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.8-1 "IP VRF Mapping" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the vrf
- the name which uniquely identify a VRF
- length: 1<=x<=32
Command Output
Table 51.8-2 "IP VRF Mapping" Display parameters
Specific Information
name Type Description
vrf-index Parameter type: <Vrf::VrfIndex> A number which uniquely
- the VRF ID which uniquely identify a VRF identifies a particular VRF
- range: [1...127] context within the system.
This element is always shown.
Command Description
This command displays the next VRF index.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 51.9-2 "IP VRF Next Index" Display parameters
Specific Information
name Type Description
next-vrf-index Parameter type: <Vrf::VrfIndex> The next free Virtual Routing and
- the VRF ID which uniquely identify a VRF Forwarding (VRF) index.
- range: [1...127] This element is always shown.
Command Description
This command displays SHub IP VRF information.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.10-1 "IP SHub VRF Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the VRF ID.
- the vrf id which uniquely identify a vrf
- range: [0...127]
vlan-id Parameter type: <Vlan::VlanIndex> vlan id
Format:
- vlan id
- range: [1...4093]
Command Output
Table 51.10-2 "IP SHub VRF Status Command" Display parameters
Specific Information
name Type Description
admin-status Parameter type: <Vrf::ShubIpIfAdminStatus> the administrative status of the
( up VLAN IP interface.
| down This element is always shown.
| testing )
Possible values:
- up : ready to pass packets
- down : not ready
- testing : in some test mode
oper-status Parameter type: <Vrf::ShubIpIfOperStatus> the operational status of the
( up VLAN IP interface.
| down This element is always shown.
| testing )
Possible values:
- up : ready to pass packets
Command Description
This command displays the IP SHub VRF route status parameters.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.11-1 "IP SHub VRF Route Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the vrf id
- the vrf id which uniquely identify a vrf
- range: [0...127]
dest Parameter type: <Ip::HexAddressAndFullMask> the destination ip address and
Format: mask of this route
<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::V4AddressHex> the next hop ip address of this
Format: route
- IPv4-address
Command Output
Table 51.11-2 "IP SHub VRF Route Status Command" Display parameters
Specific Information
name Type Description
protocol Parameter type: <Vrf::ShubRouteProtocol> The routing mechanism that was
( other responsible for adding this route
| local This element is always shown.
| netmgmt
| rip
| ospf )
Possible values:
Command Description
This command displays the ARP Statistics for the Shub. Statistics are provided per VRF as well as global statistics
for the node.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.12-1 "IP SHub ARP Statistics Command" Resource Parameters
Resource Identifier Type Description
(vrf-id) Format: the vrf number
- the vrf id which uniquely identify a vrf
- range: [0...127]
Command Output
Table 51.12-2 "IP SHub ARP Statistics Command" Display parameters
Common Information:common statistics
name Type Description
in-packets Parameter type: <Counter> total number of arp datagrams
- counter received from interfaces,
including those received in error.
This element is always shown.
discard Parameter type: <Counter> total number of packets discarded
- counter This element is always shown.
in-request Parameter type: <Counter> number of arp request packets
- counter received
This element is always shown.
in-resp Parameter type: <Counter> number of arp response packets
- counter received
This element is always shown.
out-request Parameter type: <Counter> number of arp requests
- counter transmitted
This element is always shown.
out-resp Parameter type: <Counter> number of arp responses
- counter transmitted
Command Description
Displays the ARP cache on the SHub holding the IP-MAC relationship.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.13-1 "IP SHub VRF Media Status Command" Resource Parameters
Resource Identifier Type Description
(vrf) Format: the VRF id
- the vrf id which uniquely identify a vrf
- range: [0...127]
ip-address Parameter type: <Ip::V4Address> the IP-address.
Format:
- IPv4-address
Command Output
Table 51.13-2 "IP SHub VRF Media Status Command" Display parameters
Specific Information
name Type Description
physical-addr Parameter type: <Ip::PhysicalAddress> the physical IP-address.
- media dependent physical address This element is always shown.
- length: x<=65535
type Parameter type: <Transport::ipNetToMediaType> type of mapping
( other This element is always shown.
| invalid
| dynamic
| static )
Possible values:
- other : none of the following
- invalid : invalidating the corresponding entry
- dynamic : dynamic mapping
- static : static mapping
vlan Parameter type: <PrintableString> type of mapping
- printable string This element is always shown.
Command Description
This command displays the dhcp-sessions information on a per client-port and per user IP address basis.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 51.14-1 "IP DHCP Session Status Command" Resource Parameters
Resource Identifier Type Description
(client) Format: specifies the if-index uniquely
( port : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / indentifying each interface
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| bridgeport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| port : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| bridgeport : <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> )
Possible values:
- port : an atm pvc interface
- bridgeport : an bridge port interface
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Command Output
Table 51.14-2 "IP DHCP Session Status Command" Display parameters
Specific Information
name Type Description
subnet Parameter type: <Ip::PrefixLength> the subnet mask of the client ip
- IP address prefix length address
- range: [0...30] This element is always shown.
lease-time Parameter type: <Ip::LeaseTimeInSec> time period for which DHCP
- the lease time server leases ip address to a client
This element is always shown.
vrf Parameter type: <Vrf::VrfIndex> number which uniquely identifies
- the VRF ID which uniquely identify a VRF a particular VRF context within
- range: [1...127] the system
This element is always shown.
gateway-ip-addr Parameter type: <Ip::V4Address> the gateway ip address
- IPv4-address This element is only shown in
detail mode.
dhcp-ip-addr Parameter type: <Ip::V4Address> ip address of dhcp server
- IPv4-address This element is only shown in
detail mode.
Description
This chapter gives an overview of nodes that are handled by "xDSL Status Commands".
Command Tree
----show
----xdsl
----profiles
----xdsl-int
- (if-index)
----operational-data
----near-end
----line
- (if-index)
----channel
- (if-index)
----far-end
----line
- (if-index)
----channel
- (if-index)
----line
- (if-index)
----carrier-data
----near-end
- (if-index)
----far-end
- (if-index)
----failure-status
----near-end
- (if-index)
----far-end
- (if-index)
----counters
----near-end
----line
----current-interval
- (if-index)
----current-1day
- (if-index)
----previous-interval
- (if-index)
- interval-no
----previous-1day
- (if-index)
- interval-no
----channel
----current-interval
- (if-index)
----current-1day
- (if-index)
----previous-interval
- (if-index)
- interval-no
----previous-1day
- (if-index)
- interval-no
----far-end
----line
----current-interval
- (if-index)
----current-1day
- (if-index)
----previous-interval
- (if-index)
- interval-no
----previous-1day
- (if-index)
- interval-no
----channel
----current-interval
- (if-index)
----current-1day
- (if-index)
----previous-interval
- (if-index)
- interval-no
----previous-1day
- (if-index)
- interval-no
----cpe-inventory
- (if-index)
----board
- (if-index)
----link-up-changes
- (linkup-timestamp)
----slot
- (slot)
----linkup-record
- (line)
Command Description
This command displays xDSL profiles.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 52.2-2 "xDSL Profiles Status Command" Display parameters
Specific Information
name Type Description
next-av-serv-pr Parameter type: <AsamNextProfileIndex> next available index for the
- a profile index profile
- range: [0...65535] This element is always shown.
max-serv-pr Parameter type: <AsamMaxProfileIndex> max number of profile indices
- a maximum value of a profile index that can be created
- range: [0...65535] This element is always shown.
next-av-spec-pr Parameter type: <AsamNextProfileIndex> next available spectrum index
- a profile index This element is always shown.
- range: [0...65535]
max-spec-pr Parameter type: <AsamMaxProfileIndex> max number of spectrum indices
- a maximum value of a profile index that can be created
- range: [0...65535] This element is always shown.
Command Description
This command displays the number of available pm intervals per xdsl interface.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.3-1 "xDSL PM Interval Per Interface Status 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
Command Output
Table 52.3-2 "xDSL PM Interval Per Interface Status Command" Display parameters
Specific Information
name Type Description
cur-int-elapsedtime Parameter type: <SignedInteger> nbr of sec elapsed in cur intvl
- a signed integer err-measurement
This element is always shown.
cur-1day-elapsedtime Parameter type: <SignedInteger> nbr of sec elapsed in cur one day
- a signed integer err-measurement
This element is always shown.
valid-intervals Parameter type: <SignedInteger> nbr of prev intvl for which valid
Command Description
This command displays the xDSL operational data for the near and of line.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.4-1 "xDSL Operational Data Near End Line Status 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
Command Output
Table 52.4-2 "xDSL Operational Data Near End Line Status Command" Display parameters
Specific Information
name Type Description
rel-cap-occ-up Parameter type: <Xdsl::CapacityUtil> ratio of actual bitrate over the
- utilization of the capacity available max attainable bitrate
- unit: % This element is always shown.
- range: [0...100]
noise-margin-up Parameter type: <Xdsl::NoiseValue> current noise margin for the
- a noise value upstream direction
- unit: 1/10 dB This element is always shown.
Command Description
This command displays the xDSL operational data for the near and of line.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.5-1 "xDSL Operational Data Near End Channel Status 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
Command Output
Table 52.5-2 "xDSL Operational Data Near End Channel Status Command" Display parameters
Specific Information
name Type Description
actual-bitrate-up Parameter type: <Xdsl::SignedIntegerKBPS> atm bitrate for upstream fast or
- bitrate interleaved data flow
- unit: kbits/sec This element is always shown.
attain-bitrate-up Parameter type: <Xdsl::SignedIntegerKBPS> maximum attainable atm rate the
- bitrate modem can support
- unit: kbits/sec This element is always shown.
interleave-delay-down Parameter type: <Xdsl::SignedIntegerMSEC> delay caused by the interleaving
Command Description
This command displays the xDSL operational data for the line far end.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.6-1 "xDSL Operational Data Far End Line Status 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
Command Output
Table 52.6-2 "xDSL Operational Data Far End Line Status Command" Display parameters
Specific Information
name Type Description
rel-cap-occ-down Parameter type: <Xdsl::CapacityUtil> ratio of actual bitrate over the
- utilization of the capacity available max attainable bitrate
- unit: % This element is always shown.
- range: [0...100]
noise-margin-down Parameter type: <Xdsl::NoiseValue> current noise margin for the
- a noise value downstream direction
- unit: 1/10 dB This element is always shown.
Command Description
This command displays the xDSL operational data for the far end of the channel.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.7-1 "xDSL Operational Data Far End Channel Status 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
Command Output
Table 52.7-2 "xDSL Operational Data Far End Channel Status Command" Display parameters
Specific Information
name Type Description
actual-bitrate-down Parameter type: <Xdsl::SignedIntegerKBPS> atm bitrate for downstream fast
short name: act-br-down - bitrate or interleaved data flow
- unit: kbits/sec This element is always shown.
attain-bitrate-down Parameter type: <Xdsl::SignedIntegerKBPS> maximum attainable atm rate the
short name: att-br-down - bitrate modem can support
- unit: kbits/sec This element is always shown.
interleave-delay-up Parameter type: <Xdsl::SignedIntegerMSEC> delay caused by the interleaving
Command Description
This command displays the xDSL operational data statistics.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.8-1 "xDSL Operational Data Statistics" 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
Command Output
Table 52.8-2 "xDSL Operational Data Statistics" Display parameters
Specific Information
name Type Description
adm-state Parameter type: <Itf::ifAdminStatus> specifies state of the interface
( not-appl This element is always shown.
| up
| down
| testing )
Possible values:
- not-appl : not-applicable
- up : admin status is up
- down : admin status is down
- testing : no operational packets can be passed
Command Description
This command displays xDSL carrier data near end.
This command displays only the bit load distribution and not the carrier info
Carrier data is displayed in raw format so for the actual data interpretation please refer to XDSL_MIB.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.9-1 "xDSL Carrier Data Near End Status 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
Command Output
Table 52.9-2 "xDSL Carrier Data Near End Status Command" Display parameters
Specific Information
name Type Description
spacing Parameter type: <Xdsl::CarrierSpacingType> the actual carrier spacing used on
( single the XDSL line in the downstream
| double direction
| half This element is always shown.
| quarter )
Possible values:
- single : single
Command Description
This command displays xDSL carrier data far end.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.10-1 "xDSL Carrier Data Far End Status 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
Command Output
Table 52.10-2 "xDSL Carrier Data Far End Status Command" Display parameters
Specific Information
name Type Description
spacing Parameter type: <Xdsl::CarrierSpacingType> the actual carrier spacing used on
( single the XDSL line in the upstream
| double direction
| half This element is always shown.
| quarter )
Possible values:
- single : single
- double : double
- half : half
- quarter : quarter
Command Description
This command displays the xDSL failure status near end.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.11-1 "xDSL Failure Status Near End Status 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
Command Output
Table 52.11-2 "xDSL Failure Status Near End Status Command" Display parameters
Specific Information
name Type Description
line-defect Parameter type: <Xdsl::FailureStatusNearEnd> specifies the defect status in the
( yes near-end
| no ) This element is always shown.
Possible values:
- yes : defect in the near-end failure sta tus
- no : no defect in the near-end failure s tatus
los Parameter type: <Xdsl::FailureStatusNELOS> specifies status of the Loss of
Command Description
This command displays the xDSL failure of the far end.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.12-1 "xDSL Failure Status Far End Status 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
Command Output
Table 52.12-2 "xDSL Failure Status Far End Status Command" Display parameters
Specific Information
name Type Description
line-defect Parameter type: <Xdsl::FailureStatusNoDefect> specifies the defect status in the
( yes far-end
| no ) This element is always shown.
Possible values:
- yes : defect in the far-end failure status
- no : no defect in the far-end failure status
los Parameter type: <Xdsl::FailureStatusFELOS> specifies status of the Loss of
Command Description
This command displays xDSL counters near end line current 15 min.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.13-1 "xDSL Counters Near End Line Current 15 Min" 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
Command Output
Table 52.13-2 "xDSL Counters Near End Line Current 15 Min" Display parameters
Specific Information
name Type Description
los Parameter type: <Counter> number of occurences of an LOS
- counter failure event
This element is always shown.
lof Parameter type: <Counter> number of occurences of an LOF
- counter failure event
This element is always shown.
lom Parameter type: <Counter> number of occurences of a LOM
- counter failure event
This element is always shown.
ese Parameter type: <Counter> number of occurences of an ESE
Command Description
This command displays the xDSL counters near end line current day.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.14-1 "xDSL Counters Near End Line Current Day" 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
Command Output
Table 52.14-2 "xDSL Counters Near End Line Current Day" Display parameters
Specific Information
name Type Description
los Parameter type: <Counter> number of occurences of an LOS
- counter failure event
This element is always shown.
lof Parameter type: <Counter> number of occurences of an LOF
- counter failure event
This element is always shown.
lom Parameter type: <Counter> number of occurences of a LOM
- counter failure event
This element is always shown.
ese Parameter type: <Counter> number of occurences of an ESE
Command Description
This command displays the xDSL counters near end line previous 15 min.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show xdsl counters near-end line previous-interval [ (if-index) [ interval-no <Xdsl::IntervalNumber15min> ] ]
Command Parameters
Table 52.15-1 "xDSL Counters Near End Line Previous 15 Min" 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
interval-no Parameter type: <Xdsl::IntervalNumber15min> identifies prev 15min intvls,val 1
Format: as the latest intvl
- a number identifying 15 minutes interval time
- range: [1...192]
Command Output
Table 52.15-2 "xDSL Counters Near End Line Previous 15 Min" Display parameters
Specific Information
name Type Description
los Parameter type: <Counter> number of occurences of an LOS
- counter failure event
This element is always shown.
Command Description
This command displays the xDSL counters near end of the previous day.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show xdsl counters near-end line previous-1day [ (if-index) [ interval-no <Xdsl::IntervalNumber1day> ] ]
Command Parameters
Table 52.16-1 "xDSL Counters Near End Of Line Previous Day" 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
interval-no Parameter type: <Xdsl::IntervalNumber1day> nbr identifying previous 1 day
Format: intvl time, value 1 is the most
- a number identifying 1 day interval time recently completed 1 day intvl
- range: [1...7]
Command Output
Table 52.16-2 "xDSL Counters Near End Of Line Previous Day" Display parameters
Specific Information
name Type Description
los Parameter type: <Counter> number of occurences of an LOS
- counter failure event
This element is always shown.
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.17-1 "xDSL Counters Near End Channel Current 15 Min" 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
Command Output
Table 52.17-2 "xDSL Counters Near End Channel Current 15 Min" Display parameters
Specific Information
name Type Description
cv Parameter type: <Counter> number of coding violations
- counter encountered by the channel
This element is always shown.
fecc Parameter type: <Counter> number of corrected codewords
- counter encountered by the channel,
respectively corrected octets in
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.18-1 "xDSL Counters Near End Channel Current Day" 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
Command Output
Table 52.18-2 "xDSL Counters Near End Channel Current Day" Display parameters
Specific Information
name Type Description
cv Parameter type: <Counter> number of coding violations
- counter encountered by the channel
This element is always shown.
fecc Parameter type: <Counter> number of corrected codewords
- counter encountered by the channel,
respectively corrected octets in
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show xdsl counters near-end channel previous-interval [ (if-index) [ interval-no <Xdsl::IntervalNumber15min> ]
]
Command Parameters
Table 52.19-1 "xDSL Counters Near End Channel Previous 15 Min" 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
interval-no Parameter type: <Xdsl::IntervalNumber15min> nbr identifying previous 15 min
Format: intvl time, value 1 is the most
- a number identifying 15 minutes interval time recently completed 15 min intvl
- range: [1...192]
Command Output
Table 52.19-2 "xDSL Counters Near End Channel Previous 15 Min" Display parameters
Specific Information
name Type Description
cv Parameter type: <Counter> number of coding violations
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show xdsl counters near-end channel previous-1day [ (if-index) [ interval-no <Xdsl::IntervalNumber1day> ] ]
Command Parameters
Table 52.20-1 "xDSL Counters Near End Channel Previous Day" 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
interval-no Parameter type: <Xdsl::IntervalNumber1day> nbr identifying previous 1 day
Format: intvl time, value 1 is the most
- a number identifying 1 day interval time recently completed 1 day intvl
- range: [1...7]
Command Output
Table 52.20-2 "xDSL Counters Near End Channel Previous Day" Display parameters
Specific Information
name Type Description
cv Parameter type: <Counter> number of coding violations
- counter encountered by the channel
Command Description
This command displays xDSL counters far end line current 15 min.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.21-1 "xDSL Counters Far End Line Current 15 Min" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the xdsl 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
Command Output
Table 52.21-2 "xDSL Counters Far End Line Current 15 Min" Display parameters
Specific Information
name Type Description
los Parameter type: <Counter> number of occurences of an los
- counter failure event
This element is always shown.
lof Parameter type: <Counter> number of occurences of an lof
- counter failure event
This element is always shown.
lom Parameter type: <Counter> number of occurences of an lom
- counter failure event
This element is always shown.
lpr Parameter type: <Counter> number of occurences of an lpr
Command Description
This command displays xDSL counters far end line current day.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.22-1 "xDSL Counters Far End Line Current Day" 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
Command Output
Table 52.22-2 "xDSL Counters Far End Line Current Day" Display parameters
Specific Information
name Type Description
los Parameter type: <Counter> number of occurences of an los
- counter failure event
This element is always shown.
lof Parameter type: <Counter> number of occurences of an lof
- counter failure event
This element is always shown.
lom Parameter type: <Counter> number of occurences of an lom
- counter failure event
This element is always shown.
lpr Parameter type: <Counter> number of occurences of an lpr
Command Description
This command displays xDSL counters far end line previous 15 min.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show xdsl counters far-end line previous-interval [ (if-index) [ interval-no <Xdsl::IntervalNumber15min> ] ]
Command Parameters
Table 52.23-1 "xDSL Counters Far End Line Previous 15 Min" 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
interval-no Parameter type: <Xdsl::IntervalNumber15min> nbr identifying previous 15 min
Format: intvl time, value 1 is the most
- a number identifying 15 minutes interval time recently completed 15 min intvl
- range: [1...192]
Command Output
Table 52.23-2 "xDSL Counters Far End Line Previous 15 Min" Display parameters
Specific Information
name Type Description
los Parameter type: <Counter> number of occurences of an los
- counter failure event
This element is always shown.
lof Parameter type: <Counter> number of occurences of an lof
- counter failure event
This element is always shown.
Command Description
This command displays xDSL counters far end line previous day.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show xdsl counters far-end line previous-1day [ (if-index) [ interval-no <Xdsl::IntervalNumber1day> ] ]
Command Parameters
Table 52.24-1 "xDSL Counters Far End Line Previous Day" 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
interval-no Parameter type: <Xdsl::IntervalNumber1day> nbr identifying previous 1 day
Format: intvl time, value 1 is the most
- a number identifying 1 day interval time recently completed 1 day intvl
- range: [1...7]
Command Output
Table 52.24-2 "xDSL Counters Far End Line Previous Day" Display parameters
Specific Information
name Type Description
los Parameter type: <Counter> number of occurences of an los
- counter failure event
This element is always shown.
lof Parameter type: <Counter> number of occurences of an lof
- counter failure event
This element is always shown.
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.25-1 "xDSL Counters Far End Channel Current 15 Min" 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
Command Output
Table 52.25-2 "xDSL Counters Far End Channel Current 15 Min" Display parameters
Specific Information
name Type Description
cv Parameter type: <Counter> nbr of coding violations
- counter encountered by far end channel
This element is always shown.
fecc Parameter type: <Counter> number of corrected codewords
- counter encountered by the channel,
respectively corrected octets in
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.26-1 "xDSL Counters Far End Channel Current Day" 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
Command Output
Table 52.26-2 "xDSL Counters Far End Channel Current Day" Display parameters
Specific Information
name Type Description
cv Parameter type: <Counter> nbr of coding violations
- counter encountered by far end channel
This element is always shown.
fecc Parameter type: <Counter> number of corrected codewords
- counter encountered by the channel,
respectively corrected octets in
case of vdsl1 G.993.1
This element is always shown.
cec Parameter type: <Counter> the number of non-corrected
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show xdsl counters far-end channel previous-interval [ (if-index) [ interval-no <Xdsl::IntervalNumber15min> ] ]
Command Parameters
Table 52.27-1 "xDSL Counters Far End Channel Previous 15 Min" 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
interval-no Parameter type: <Xdsl::IntervalNumber15min> nbr identifying previous 15 min
Format: intvl time, value 1 is the most
- a number identifying 15 minutes interval time recently completed 15 min intvl
- range: [1...192]
Command Output
Table 52.27-2 "xDSL Counters Far End Channel Previous 15 Min" Display parameters
Specific Information
name Type Description
cv Parameter type: <Counter> number of coding violations in
- counter the previous 15 min
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show xdsl counters far-end channel previous-1day [ (if-index) [ interval-no <Xdsl::IntervalNumber1day> ] ]
Command Parameters
Table 52.28-1 "xDSL Counters Far End Channel Previous Day" 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
interval-no Parameter type: <Xdsl::IntervalNumber1day> nbr identifying previous 1 day
Format: intvl time, value 1 is the most
- a number identifying 1 day interval time recently completed 1 day intvl
- range: [1...7]
Command Output
Table 52.28-2 "xDSL Counters Far End Channel Previous Day" Display parameters
Specific Information
name Type Description
cv Parameter type: <Counter> number of coding violations in
- counter the previous one day
Command Description
This command displays xDSL inventory XT/RT.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.29-1 "xDSL Inventory XT/RT Status 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
Command Output
Table 52.29-2 "xDSL Inventory XT/RT Status Command" Display parameters
Specific Information
name Type Description
modem-vendor-id Parameter type: <Xdsl::VendorID> vendor ID retrieved during
- an octet string defining vendor identification handshaking
- length: x<=16 This element is always shown.
sys-serial-no Parameter type: <Xdsl::SystemSerialNumber> serial number that identifies the
- an octet string defining system serial number vendor equipment
- length: x<=32 This element is only shown in
detail mode.
sys-vendor-id Parameter type: <Xdsl::VendorID> vendor ID retrieved via the xdsl
- an octet string defining vendor identification EOC
- length: x<=16 This element is always shown.
Command Description
This command displays xDSL board capability.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.30-1 "xDSL Board Capability Status 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
Command Output
Table 52.30-2 "xDSL Board Capability Status Command" Display parameters
Specific Information
name Type Description
capability Parameter type: <Xdsl::OpModeTypeLinePreDef> operational mode supported by
( ansi-t1413 the board
| etsi-dts This element is always shown.
| g992-1-a
| g992-1-b
| g992-2-a
| g992-3-a
| g992-3-b
| g992-3-l1
| g992-3-l2
| g992-3-am
Command Description
This command is for displaying the link-up line after the specified time-stamp
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.31-1 "xDSL Low Rate Alarm Command" Resource Parameters
Resource Identifier Type Description
(linkup-timestamp) Format: the latest link up timestamp
- Printable string
Command Description
This command displays the linkup line bitmap for the line.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.32-1 "xDSL Low Rate Alarm Command" Resource Parameters
Resource Identifier Type Description
(linkup-timestamp) Format: the latest link up timestamp
- Printable string
(slot) Format: the physical slot position
( <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 Output
Table 52.32-2 "xDSL Low Rate Alarm Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Xdsl::PortList> displays all the lines with state
- Printable string change after specified time
This element is always shown.
Command Description
This command displays the linkup record for the line.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 52.33-1 "xDSL Low Rate Alarm Command" Resource Parameters
Resource Identifier Type Description
(line) Format: the physical slot position
<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 Output
Table 52.33-2 "xDSL Low Rate Alarm Command" Display parameters
Specific Information
name Type Description
link-timestamp-down Parameter type: <Xdsl::timeInSecs> Displays the latest link down
- Printable string timestamp
This element is always shown.
link-timestamp-up Parameter type: <Xdsl::timeInSecs> Displays the latest link up
- Printable string timestamp
This element is always shown.
act-bitrate-up Parameter type: <Xdsl::BitRateKbps> Displays the actual net data for
- Bitrate in kbps the upstream channel
- unit: kbps This element is always shown.
act-bitrate-down Parameter type: <Xdsl::BitRateKbps> Displays the actual net data for
Description
This chapter gives an overview of nodes that are handled by "Configuration Data Status Commands".
Command Tree
----show
----xdsl
----config-data-port
- (if-index)
----xdsl
- [no] service-profile
- [no] spectrum-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-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-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] carrier-data-mode
- admin-state
- [no] bonding-mode
- transfer-mode
----atm-pvc
- (port-index)
- admin-state
- [no] aal5-encap-type
----interface-atm-pvc
- (pvc-index)
- [no] customer-id
----interface-port
- [no] admin-state
- [no] link-updown-trap
- [no] user
- [no] severity
----igmp
- (port)
- perm-pkg-bitmap
- max-num-group
----security-pae
- (port)
- [no] controlled-port
- [no] quiet-period
- [no] tx-period
- [no] supp-timeout
- [no] server-timeout
- [no] max-req
- [no] authentication
- [no] init-authreq-off
- [no] handshake
- [no] handshake-period
- [no] initialize
----bridge-port
- (port)
- pvid
- default-priority
- mac-learn-off
- max-unicast-mac
- accept-frame-type
- prio-regen-prof
- [no] qos-profile
----qos
- scheduler-profile
- cac-profile
----pppox-relay
- (port)
- vlan-id
- default-priority
- max-cc
- qos-profile
----pppoe
- (port)
- max-num-session
- ppp-profile-name
----bonding-group
- group-profile
- admin-state
Command Description
This command displays the xDSL Port Configuration data.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 53.2-1 "xDSL Port Configuration Status 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 53.2-2 "xDSL Port Configuration Status Command" Command Parameters
Command Description
This command displays the xDSL port atm configuration data.
User Level
The command can be accessed by operators with atm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 53.3-1 "xDSL Port ATM Configuration Status 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
(port-index) Format: the ATM PVC
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
| dsl : <Itf::AtmInterfaceIndex> )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PortId>
- the port number
Field type <Itf::AtmInterfaceIndex>
- ATM interface
Table 53.3-2 "xDSL Port ATM Configuration Status Command" Command Parameters
Parameter Type Description
admin-state Parameter type: <Xdsl::XdslAdminStatusAtm> optional parameter
Format: specifies the administrative state
( up of the VCL.
| down )
Possible values:
- up : enable traffic flow
- down : disable traffic flow
[no] aal5-encap-type Parameter type: <Atm::VccEncapType> optional parameter with default
Format: value: "llc-snap"
( llc-snap displays the encapsulations
| llc-snap-routed method for carrying network
| llc-nlpid interconnect traffic over AAL
| vc-mux-bridged-8023 type 5 over ATM
| vc-mux-routed
| vc-mux-pppoa
| automatic : ip
| automatic : ppp
| automatic : pppoa )
Possible values:
- llc-snap : logical link control encapsulation bridged
protocol
- llc-snap-routed : logical link control encapsulation routed
protocol
- llc-nlpid : logical link control encapsulation pppoa protocol
- vc-mux-bridged-8023 : virtual channel multiplex bridged
protocol
- vc-mux-routed : virtual channel multiplex routed protocol
- vc-mux-pppoa : virtual channel multiplex pppoa protocol
- automatic : automatic detection of encapsulation type
Possible values:
- ip : autodetection of the used ip encapsulation
- ppp : autodetection of the used ppp encapsulation
- pppoa : autodetection of the used pppoa encapsulation
Field type <SignedInteger>
- a signed integer
Command Description
This command displays the xDSL port atm-interface configuration data.
User Level
The command can be accessed by operators with atm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 53.4-1 "xDSL Port ATM Interface Configuration Status 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
(pvc-index) Format: the ATM PVC
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
| dsl )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PortId>
- the port number
Table 53.4-2 "xDSL Port ATM Interface Configuration Status Command" Command Parameters
Command Description
This command displays the xDSL port interface configuration data.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 53.5-1 "xDSL Port Interface Configuration Status 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 53.5-2 "xDSL Port Interface Configuration Status Command" Command Parameters
Parameter Type Description
[no] admin-state Parameter type: <Xdsl::XdslAdminStatus> optional parameter with default
Format: value: "admin-down"
( up the state of the interface
| down )
Possible values:
- up : admin status is up
- down : admin status is down
[no] link-updown-trap Parameter type: <Itf::ifLinkUpDownTrapEnable> optional parameter with default
Format: value: "no-link-updown-trap"
( link-updown-trap indicates whether
Command Description
This command displays the xDSL IGMP configuration data.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> show xdsl config-data-port (if-index) igmp [ (port) ] perm-pkg-bitmap <Igmp::PermPkgBitMap> max-num-group
<Igmp::ChannelMaxNumGroup>
Command Parameters
Table 53.6-1 "xDSL IGMP Configuration Status 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
(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>
| 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> )
Possible values:
- vlan : vlan port
Command Description
This command displays the xDSL security PAE configuration data.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 53.7-1 "xDSL Security PAE Configuration Status 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
(port) Format: identification of the port or
( dsl : <Eqpt::VpiId> : <Eqpt::VciId> virtual channel
| dsl )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Command Description
This command displays the Bridge Port configured data.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
> show xdsl config-data-port (if-index) bridge-port [ (port) ] pvid <Vlan::StackedVlan> default-priority
<Vlan::Priority> mac-learn-off <Vlan::learnStatus> max-unicast-mac <Vlan::MaxMac> accept-frame-type
<Vlan::VlanFrameTypes> prio-regen-prof <Vlan::PrioRegenProfile> [ no qos-profile | qos-profile
<Vlan::QosProfileName> ]
Command Parameters
Table 53.8-1 "xDSL BridgePort Configuration Status 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
(port) Format: identification of the port or
( dsl : <Eqpt::VpiId> : <Eqpt::VciId> virtual channel
| dsl )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PortId>
- the port number
Command Description
This command displays the xDSL QoS configuration data.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 53.9-1 "xDSL QoS Configuration Status 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 53.9-2 "xDSL QoS Configuration Status Command" Command Parameters
Parameter Type Description
scheduler-profile Parameter type: <Qos::QosProfileName> optional parameter
Format: the name of the scheduler profile
( none to be mapped on this dsl link
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <Qos::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64
cac-profile Parameter type: <Qos::QosProfileName> optional parameter
Format: the name of the cac profile to be
( none mapped on this dsl link
| name : <Qos::IgnoredQosProfileName> )
Command Description
This command displays the xDSL PPPoX relay client port configuration data.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
> show xdsl config-data-port (if-index) pppox-relay [ (port) ] vlan-id <Vlan::StackedVlan> default-priority
<PPPoX::DefaultPriority> max-cc <PPPoX::MaxNumPppCc> qos-profile <PPPoX::QosProfileName>
Command Parameters
Table 53.10-1 "xDSL PPPoX Relay Configuration Status 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
(port) Format: client port identification
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
| dsl )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PortId>
- the port number
Table 53.10-2 "xDSL PPPoX Relay Configuration Status Command" Command Parameters
Command Description
This command displays the xDSL PPPoE configuration data.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 53.11-1 "xDSL PPPoE Configuration Status 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
(port) Format: the pppox port interafce
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
| dsl )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PortId>
- the port number
Table 53.11-2 "xDSL PPPoE Configuration Status Command" Command Parameters
Parameter Type Description
max-num-session Parameter type: <PPPoE::MaxNumSessions> optional parameter
Format: max no of PPP sessions
- max no of PPP sessions established in PPPoX interface
Command Description
This command displays the xDSL bonding group configuration data.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 53.12-1 "xDSL Bonding Group Configuration Status 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 53.12-2 "xDSL Bonding Group Configuration Status Command" Command Parameters
Parameter Type Description
group-profile Parameter type: <AsamProfileName> optional parameter
Format: name of the bonding group
- a profile name profile
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
admin-state Parameter type: <Xdsl::XdslAdminStatusGroup> optional parameter
Format: the admin-state of the group
( up
| down )
Possible values:
- up : admin-state of the group is up
Description
This chapter gives an overview of nodes that are handled by "Operational Data Status Commands".
Command Tree
----show
----xdsl
----oper-data-port
- (if-index)
----xdsl
- admin-state
- opr-state/tx-rate-ds
- cur-op-mode
- tx-rate-us
- tx-rate-ds
- noise-margin-down
- noise-margin-up
- actual-tps-tc-mode
----bridge-port
- (port)
- pvid
- default-priority
- [no] qos-profile
----atm-pvc
- (port-index)
- admin-state
- oper-state
- curr-encap-type
----interface-port
- [no] admin-state
- oper-state
----igmp
- (port)
- curr-num-group
- curr-preview-num
- curr-uncfg-num
----ip-bridge-port
- (ip-bridge-port)
- rx-pkts
- rx-drop-pkts
- tx-pkts
----qos
- frame-net-bw
- m-cast-avail-bw
- m-cast-used-bw
Command Description
This command displays the xDSL Port Operational data.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.2-1 "xDSL Port Operational Status 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 54.2-2 "xDSL Port Operational Status Command" Command Parameters
Parameter Type Description
admin-state Parameter type: <Itf::ifAdminStatus> optional parameter
Format: specifies state of the interface
( up
| down )
Possible values:
- up : admin status is up
- down : admin status is down
opr-state/tx-rate-ds Parameter type: <Xdsl::combinedCol> optional parameter
Format: current operational state of the
( down interface.
| testing
| unknown
Command Description
This command displays the Bridge Port Operational data.
User Level
The command can be accessed by operators with atm privileges.
Command Syntax
The command has the following syntax:
> show xdsl oper-data-port (if-index) bridge-port [ (port) ] pvid <Vlan::StackedVlan> default-priority
<Vlan::Priority> [ no qos-profile | qos-profile <Vlan::QosProfileName> ]
Command Parameters
Table 54.3-1 "xDSL BridgePort Operational Status 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
(port) Format: identity of the PVC
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
| dsl )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PortId>
- the port number
Table 54.3-2 "xDSL BridgePort Operational Status Command" Command Parameters
Command Description
This command displays the xDSL port atm operational data.
User Level
The command can be accessed by operators with atm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.4-1 "xDSL Port ATM Operational Status 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
(port-index) Format: the ATM PVC
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
| dsl : <Itf::AtmInterfaceIndex> )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PortId>
- the port number
Field type <Itf::AtmInterfaceIndex>
- ATM interface
Table 54.4-2 "xDSL Port ATM Operational Status Command" Command Parameters
Parameter Type Description
admin-state Parameter type: <Xdsl::XdslAdminStatusAtm> optional parameter
Command Description
This command displays the xDSL port interface configuration data.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 54.5-1 "xDSL Port Interface Configuration Status 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 54.5-2 "xDSL Port Interface Configuration Status Command" Command Parameters
Parameter Type Description
[no] admin-state Parameter type: <Xdsl::XdslAdminStatus> optional parameter with default
Format: value: "admin-down"
( up the desired state of the interface
| down )
Possible values:
- up : admin status is up
- down : admin status is down
oper-state Parameter type: <Itf::ifOperStatus> optional parameter
Format: the operational state of the
( up interface
| down
Command Description
This command displays the xDSL IGMP operational data.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> show xdsl oper-data-port (if-index) igmp [ (port) ] curr-num-group <Gauge> curr-preview-num <Counter>
curr-uncfg-num <Counter>
Command Parameters
Table 54.6-1 "xDSL IGMP Operational Status 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
(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>
| 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> )
Possible values:
- vlan : vlan port
Command Description
This command displays the xDSL Port Ip Bridge Operational data.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> show xdsl oper-data-port (if-index) ip-bridge-port [ (ip-bridge-port) ] rx-pkts <Equipm::Octet-8> rx-drop-pkts
<Equipm::Octet-8> tx-pkts <Equipm::Octet-8>
Command Parameters
Table 54.7-1 "xDSL Port Ip Bridge Operational Status 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
(ip-bridge-port) Format: identification of the port or
( dsl : <Eqpt::VpiId> : <Eqpt::VciId> virtual channel
| dsl )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PortId>
- the port number
Table 54.7-2 "xDSL Port Ip Bridge Operational Status Command" Command Parameters
Command Description
This command displays the xDSL QoS operational data.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
> show xdsl oper-data-port (if-index) qos frame-net-bw <SignedInteger> m-cast-avail-bw <SignedInteger>
m-cast-used-bw <SignedInteger>
Command Parameters
Table 54.8-1 "xDSL QoS Opertaional Status 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 54.8-2 "xDSL QoS Opertaional Status Command" Command Parameters
Parameter Type Description
frame-net-bw Parameter type: <SignedInteger> optional parameter
Format: Represents the approximate
- a signed integer bandwidth available for Ethernet
frames, which is guaranteed to be
available by the physical layer.
This approximation is made by
the configurable ATM overhead
factor.
m-cast-avail-bw Parameter type: <SignedInteger> optional parameter
Format: Represents the bandwidth
- a signed integer available for multicast services,
calculated by the ISAM. This
value is what is left from
frame-net-bw after deducting
Description
This chapter gives an overview of nodes that are handled by "xDSL Bonding Status Commands".
Command Tree
----show
----xdsl-bonding
----profiles
- (index)
----operational-data
----near-end
- (if-index)
----far-end
- (if-index)
----group
- (if-index)
----failure-status
----near-end
- (if-index)
----far-end
- (if-index)
----group
- (if-index)
----summary
- (index)
Command Description
This command displays the xDSL bonding profiles.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.2-1 "xDSL Bonding Profiles Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: a unique interface index
- bonding group profile index
- range: [1...100]
Command Output
Table 55.2-2 "xDSL Bonding Profiles Status Command" Display parameters
Common Information:profile
name Type Description
next-av-bond-pr Parameter type: <AsamNextProfileIndex> next available index for the
- a profile index bonding group profile
- range: [0...65535] This element is always shown.
max-bond-pr Parameter type: <AsamMaxProfileIndex> max number of bonding group
- a maximum value of a profile index profile indices that can be created
- range: [0...65535] This element is always shown.
Specific Information
name Type Description
name Parameter type: <AsamProfileName> name of the bonding group
- a profile name profile
- range: [a-zA-Z0-9-_.] This element is always shown.
- length: 1<=x<=32
used-status Parameter type: <Xdsl::UsedStatus> specifies the number of entities
- number of entities using this profile using this profile.
- range: [0...65535] This element is always shown.
Command Description
This command shows the operational data near end statistics.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.3-1 "xDSL Bonding Near End Operational Data Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) 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
Command Output
Table 55.3-2 "xDSL Bonding Near End Operational Data Status Command" Display parameters
Specific Information
name Type Description
actual-bitrate-up Parameter type: <Xdsl::Bitrate> when the bonding group is in
- bitrate service, this will give the actual
- unit: kbits/sec ATM bitrate and 0 when not in
- range: [0...65535] service also in case no data is
available.
This element is always shown.
Command Description
This command shows the operational data far end statistics.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.4-1 "xDSL Bonding Far End Operational Data Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) 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
Command Output
Table 55.4-2 "xDSL Bonding Far End Operational Data Status Command" Display parameters
Specific Information
name Type Description
actual-bitrate-down Parameter type: <Xdsl::Bitrate> when the bonding group is in
- bitrate service, this will give the actual
- unit: kbits/sec ATM bitrate and 0 when not in
- range: [0...65535] service also in case no data is
available.
This element is always shown.
Command Description
This command displays the xDSL bonding oper-data group statistics.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.5-1 "xDSL Bonding Group Operational Data Command" Resource Parameters
Resource Identifier Type Description
(if-index) 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
Command Output
Table 55.5-2 "xDSL Bonding Group Operational Data Command" Display parameters
Specific Information
name Type Description
running-time Parameter type: <SignedInteger> specifies accumulated time of
- a signed integer bonding group normal operation
This element is always shown.
Command Description
This command displays the xDSL bonding failure near end statistics.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.6-1 "xDSL Bonding Near End Failure Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) 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
Command Output
Table 55.6-2 "xDSL Bonding Near End Failure Status Command" Display parameters
Specific Information
name Type Description
defect Parameter type: <Xdsl::FailureStatusNEDefect> specifies the defect status in the
( yes near-end
| none ) This element is always shown.
Possible values:
- yes : defect in the near-end failure status
- none : no defect in the near-end failure status
up-min-bitrate Parameter type: <Xdsl::FailureStatusNEUpMinBitrate> specifies the upstream bitrate
Command Description
This command displays the xDSL bonding failure far end statistics.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.7-1 "xDSL Bonding Far End Failure Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) 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
Command Output
Table 55.7-2 "xDSL Bonding Far End Failure Status Command" Display parameters
Specific Information
name Type Description
defect Parameter type: <Xdsl::FailureStatusFEDefect> specifies the defect status in the
( yes far-end
| none ) This element is always shown.
Possible values:
- yes : defect in the far-end failure status
- none : no defect in the far-end failure status
down-min-bitrate Parameter type: <Xdsl::FailureStatusFEDownMinBitrate> specifies the downstream bitrate
Command Description
This command displays the xDSL bonding failure group statistics.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.8-1 "xDSL Bonding Group Failure Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) 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
Command Output
Table 55.8-2 "xDSL Bonding Group Failure Status Command" Display parameters
Specific Information
name Type Description
defect Parameter type: <Xdsl::BondingGroupFailureStatusDefect> specifies the current failure
( none reason of a bonding group
| not-feasible This element is always shown.
| min-bitrate
| no-host
| diff-delay )
Possible values:
- none : no defect on the bonding group failure status
- not-feasible : bonding group configuration not feasible
- min-bitrate : bonding group minimum data rate not met
- no-host : bonding group host not reachable
Command Description
This command displays the xDSL bonding group summary information.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 55.9-1 "xDSL Bonding Group Summary Info Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the physical number of the slot
( <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 Output
Table 55.9-2 "xDSL Bonding Group Summary Info Command" Display parameters
Specific Information
name Type Description
occupancy Parameter type: <SignedInteger> indicates the occupancy per slot
- a signed integer of the bonding host function
This element is always shown.
Description
This chapter gives an overview of nodes that are handled by "PPPoE Status Commands".
Command Tree
----show
----pppoe
----session
- (port)
----connection
- (connection)
----if-table
- (session)
----ppp-statistics
- (port)
----statistics-pppoe-itf
----stats
- (port)
----rx-pkt
- (port)
----tx-pkt
- (port)
----ppp-profile
- (name)
----ip-address
- (remote-ip-addr)
----mac-address
- (remote-mac)
Command Description
This command displays the PPPoE session parameters, such as the PPPoE session id, PPPoE session lowerlayer
Ifindex, PPPoE session local MAC address, and PPPoE remote MAC address.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.2-1 "PPPoE Sessions Status 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::LogicalSesId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan> : <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan> :
<Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan> <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
<Eqpt::LogicalSesId> )
Possible values:
- vlan : vlan port
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 Output
Table 56.2-2 "PPPoE Sessions Status Command" Display parameters
Specific Information
name Type Description
session-id Parameter type: <SignedInteger> PPPoE session id associated for a
- a signed integer PPP session
This element is always shown.
local-mac Parameter type: <Vlan::MacAddr> The MAC address of the PPPoE
- mac address (aa:bb:cc:a1:02:03) server on which PPPoE session is
- length: 6 established.
This element is always shown.
remote-mac Parameter type: <Vlan::MacAddr> The MAC address of the user
- mac address (aa:bb:cc:a1:02:03) who established the PPPoE
- length: 6 session.
This element is always shown.
Command Description
This command displays the PPPoE sessions/connection status.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.3-1 "PPPoE Sessions/Connection Status Command" Resource Parameters
Resource Identifier Type Description
(connection) Format: the identification of a pppoe
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / interface
<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> )
Possible values:
- vlan : vlan port
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 Output
Table 56.3-2 "PPPoE Sessions/Connection Status Command" Display parameters
Specific Information
name Type Description
session Parameter type: <Itf::PppoeSession> the identification of a session
short name: sess ( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / This element is always shown.
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::LogicalSesId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan> : <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan> :
<Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan> <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
<Eqpt::LogicalSesId> )
Possible values:
- vlan : vlan port
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
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Field type <Eqpt::LogicalSesId>
- logical id
Command Description
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.4-1 "PPPoE Interface Status Command" Resource Parameters
Resource Identifier Type Description
(session) Format: the identification of a pppoe
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / session
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::LogicalSesId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan> : <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan> :
<Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan> <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
<Eqpt::LogicalSesId> )
Possible values:
- vlan : vlan port
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>
Command Output
Table 56.4-2 "PPPoE Interface Status Command" Display parameters
Specific Information
name Type Description
state Parameter type: <PPPoE::pppIfState> current PPP state of the session.
( lcp This element is always shown.
| authenticating
| ipcp
| up
| down )
Possible values:
- lcp : PPP session reaches LCP phase
- authenticating : PPP session reaches Authentication phase
- ipcp : PPP session reaches IPCP phase
- up : PPP session is UP
- down : PPP session is down
user-name Parameter type: <PrintableString> username (along with the domain
- printable string name) who established the
PPPoE session.
This element is always shown.
local-ip-addr Parameter type: <PPPoE::InetAddress> IP address of the system on
- IPv4-address which PPPoE session is
established
This element is only shown in
detail mode.
remote-ip-addr Parameter type: <PPPoE::InetAddress> IP address of the user who
- IPv4-address established the PPPoE session.
This element is only shown in
detail mode.
local-mru Parameter type: <SignedInteger> The MRU of the system link, on
- a signed integer which PPPoE session is
established.
This element is only shown in
detail mode.
remote-mru Parameter type: <SignedInteger> The MRU of the user link, who
- a signed integer established the PPPoE session.
This element is only shown in
detail mode.
prim-dns-addr Parameter type: <PPPoE::InetAddress> remote primary DNS IP address,
- IPv4-address obtained from the authentication
service
Command Description
This command shows PPP statistics on the PPPoX interface. This command takes the rack/subrack/slot/port and
vpi and vci values as arguments on which the PPPoE was configured, and displays the arguments.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.5-1 "PPPoX Interface Statistics 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>
| 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> )
Possible values:
- vlan : vlan port
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 Output
Table 56.5-2 "PPPoX Interface Statistics Command" Display parameters
Specific Information
name Type Description
open-sess Parameter type: <Counter> total number of opened sessions.
- counter This element is always shown.
low-layer-down-event Parameter type: <Counter> total number of session
- counter terminates due to link down
events.
This element is always shown.
chap-auth-fail Parameter type: <Counter> total number of CHAP
- counter authentication failure.
This element is always shown.
pap-auth-fail Parameter type: <Counter> total number of PAP
- counter authentication failure.
This element is always shown.
ip-addr-fail Parameter type: <Counter> total number of failed retrievals
- counter for local IP address.
This element is only shown in
detail mode.
lcp-nego-mis Parameter type: <Counter> total number of negotiation
- counter mismatch occurred in LCP phase.
This element is only shown in
detail mode.
ipcp-nego-mis Parameter type: <Counter> total number of negotiation
- counter mismatch occurred in IPCP
phase.
This element is only shown in
detail mode.
usr-term Parameter type: <Counter> total number of user terminate
- counter requests received.
This element is only shown in
detail mode.
sys-term Parameter type: <Counter> total number of system terminate
- counter requests sent.
This element is always shown.
Command Description
This command displays the PPPoE interface statistics. This command takes the rack/subrack/slot/port and vpi and
vci values as arguments on which the PPPoE was configured, and displays the arguments.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.6-1 "PPPoE Interface Statistics" 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>
| 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> )
Possible values:
- vlan : vlan port
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 Output
Table 56.6-2 "PPPoE Interface Statistics" Display parameters
Specific Information
name Type Description
act-sess Parameter type: <Gauge> Total number of active PPPoE
short name: sess/act - gauge sessions.
This element is always shown.
estab-sess Parameter type: <Counter> Total number of PPPoE sessions
short name: sess/estab - counter established after the system has
been reset.
This element is always shown.
error Parameter type: <Counter> The statistics indicates the
- counter number of errors experienced in
performing the host request.
This element is always shown.
padi-inv-id Parameter type: <Counter> Total number of invalid
short name: inv-id/padi - counter session-id received in PADI
packets.
This element is always shown.
padr-inv-id Parameter type: <Counter> Total number of invalid
short name: inv-id/padr - counter session-id received in PADR
packets.
This element is always shown.
Command Description
This command displays the PPPoE interface received statistics.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.7-1 "PPPoE Interface Received Statistics" 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>
| 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> )
Possible values:
- vlan : vlan port
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 Output
Table 56.7-2 "PPPoE Interface Received Statistics" Display parameters
Specific Information
name Type Description
inv-header Parameter type: <Counter> Total number of PPPoE invalid
- counter header packets received.
This element is always shown.
inv-type Parameter type: <Counter> Total number of PPPoE invalid
- counter type packets received.
This element is always shown.
inv-code Parameter type: <Counter> Total number of PPPoE invalid
- counter code packets received.
This element is always shown.
invl-tag Parameter type: <Counter> Total number of invalid tag
- counter received in the PPPoE header.
This element is always shown.
invl-length Parameter type: <Counter> Total number packets received
- counter with invalid length in PPPoE
header.
This element is always shown.
padi Parameter type: <Counter> Total number of PPPoE active
- counter discovery initiation (PADI)
packets received.
This element is always shown.
padr Parameter type: <Counter> Total number of PPPoE active
- counter discovery request (PADR)
packets received.
This element is always shown.
padt Parameter type: <Counter> Total number of PPPoE active
- counter discovery terminate (PADT)
packets received
This element is always shown.
Command Description
This command displays the PPPoE interface transmitted statistics.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.8-1 "PPPoE Interface Transmitted Statistics 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>
| 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> )
Possible values:
- vlan : vlan port
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>
Command Output
Table 56.8-2 "PPPoE Interface Transmitted Statistics Command" Display parameters
Specific Information
name Type Description
pado Parameter type: <Counter> Total number of PPPoE active
- counter discovery offer (PADO) packets
transmitted
This element is always shown.
pads Parameter type: <Counter> Total number of PPPoE active
- counter discovery session-confirmation
(PADS) packets transmitted
This element is always shown.
padt Parameter type: <Counter> Total number of PPPoE active
- counter discovery terminate (PADT)
packets transmitted
This element is always shown.
rej-padi Parameter type: <Counter> Total number of PPPoE active
- counter discovery initiation (PADI)
packets that were rejected
This element is always shown.
rej-padr Parameter type: <Counter> Total number of PPPoE active
- counter discovery request (PADR)
packets that were rejected
This element is always shown.
Command Description
This command displays the value of the ppp-profile name, used-status, and the version of the profile.
The manager can associate a version number with the profile. The version number is set to 1 when the profile is
first created and is incremented by the manager when the profile is modified.
The profile used-status indicates the number of entities using this profile. If the reference count is greater than 0,
then this profile is 'in use', and must not be deleted. If the value is 0, then this profile is 'not in use' and can be
deleted.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.9-1 "PPPoE Profile Status 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
Command Output
Table 56.9-2 "PPPoE Profile Status Command" Display parameters
Specific Information
name Type Description
used-status Parameter type: <AsamProfileRefCount> indicates the number of entities
- number of entities using this particular profile using this profile.
- range: [0...65535] This element is always shown.
version Parameter type: <SignedInteger> version number associated with
- a signed integer the profile.
This element is always shown.
auth-type Parameter type: <PPPoE::pppProfileAuthenType> specifies the type of PPP
( pap authentication used.
| chap This element is always shown.
| pap-chap
| chap-pap )
Command Description
This command displays the PPP data for each IP address.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.10-1 "IP Address-related PPP Status Command" Resource Parameters
Resource Identifier Type Description
(remote-ip-addr) Format: IP address of the user who
- IPv4-address established the PPPoE session.
Command Output
Table 56.10-2 "IP Address-related PPP Status Command" Display parameters
Specific Information
name Type Description
session Parameter type: <Itf::PppoeSession> the identification of a pppoe
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / session
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : This element is always shown.
<Eqpt::LogicalSesId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan> : <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan> :
<Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan> <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
<Eqpt::LogicalSesId> )
Possible values:
- vlan : vlan port
Command Description
This command displays the PPP data for each MAC address.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 56.11-1 "MAC Address-related PPP Status Command" Resource Parameters
Resource Identifier Type Description
(remote-mac) Format: The MAC address of the user
- mac address (aa:bb:cc:a1:02:03) who established the PPPoE
- length: 6 session.
Command Output
Table 56.11-2 "MAC Address-related PPP Status Command" Display parameters
Specific Information
name Type Description
session Parameter type: <Itf::PppoeSession> the identification of a PPPoE
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / session
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : This element is always shown.
<Eqpt::LogicalSesId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan> : <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan> :
<Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan> <Eqpt::LogicalSesId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
<Eqpt::LogicalSesId> )
Possible values:
Description
This chapter gives an overview of nodes that are handled by "Interface Status Commands".
Command Tree
----show
----interface
----alarm
- (interface-type)
----phy-itf-status
- (shelf)
----port
- (port)
----test
- (port)
----stack
- (higher)
- lower
----shub
----vlan
- (vlan-id)
----port
- (port)
----group
- (group-id)
----statistics
- (port)
----availability
- (port-type)
Command Description
This command shows the alarm configured for the interface and the default minimal severity with which the alarm
is reported.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.2-1 "Interface Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(interface-type) Format: type of the interface
( xdsl-line
| ethernet-line
| shdsl-line )
Possible values:
- xdsl-line : xdsl line
- ethernet-line : ethernet line
- shdsl-line : shdsl line
Command Output
Table 57.2-2 "Interface Alarm Status Command" Display parameters
Specific Information
name Type Description
default-severity Parameter type: The default minimal severity for
<Itf::asamIfExtAlmReportingSeverityDefault> an alarm to be reported that will
( indeterminate be used for interfaces.
| warning This element is always shown.
| minor
| major
| critical )
Possible values:
- indeterminate : not a definite known severity
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
Command Description
This command shows the summary of the physical interface, for example, the number of changes which occurred
for the physical interface.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.3-1 "Physical Interface Status Command" Resource Parameters
Resource Identifier Type Description
(shelf) Format: the physical position of the shelf
<Eqpt::RackId> / <Eqpt::ShelfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Command Output
Table 57.3-2 "Physical Interface Status Command" Display parameters
Specific Information
name Type Description
no-of-change-occur Parameter type: <Counter> Number of state changes of
- counter physical lines, equipped on
boards within this shelf.
This element is always shown.
Command Description
This command shows all the parameters related to the interface such as the type of interface, current bandwidth of
the interface, maximum size of the packet supported, and the connector present. All interfaces do not support each
of these parameters.
Ethernet port interfaces supports 14 ethernet ports.
Port 1 : Internal port used for management
Port 2 : External port used for management
Port 3 : Used for L2CP OAM traffic to BRAS
Ports 4-14 : Not used
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.4-1 "Interface Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: the interface index
( xdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| xdsl-channel : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-if : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
Command Output
Table 57.4-2 "Interface Status Command" Display parameters
Specific Information
name Type Description
if-index Parameter type: <SignedInteger> Specifies a unique value for each
- a signed integer interface.
This element is only shown in
detail mode.
info Parameter type: <PrintableString> A textual string containing
- printable string information about the interface.
This string include the name of
the manufacturer, the product
name and the version of the
interface hardware/software.
This element is only shown in
detail mode.
type Parameter type: <Itf::IANAifType> Specifies the type of interface.
( ethernet This element is only shown in
| sw-loopback detail mode.
| slip
| atm
| atm-bonding
| xdsl-line
| xdsl-channel
| atm-vci-ep
| bridge-port
| pppoe
| pppoe-session
| l2-vlan
| ip-fwd
| efm
| atm-ima
| shdsl )
Possible values:
- ethernet : ethernet csmacd
- sw-loopback : software loopback interface
- slip : generic SLIP interface
- atm : atm interface
- atm-bonding : atm bonding
- xdsl-line : xdsl line
- xdsl-channel : xdsl channel
- atm-vci-ep : ATM VCI end point
- bridge-port : transparent bridge interface
- pppoe : pppoe interface
- pppoe-session : pppoe session
- l2-vlan : layer 3 VLAN using IPX
- ip-fwd : IP forwarding interface
- efm : EFM interface
- atm-ima : atm-ima interface
- shdsl : shdsl interface
largest-pkt-size Parameter type: <Itf::ifMtu> The size of the largest packet
- packet size which can be sent/received on the
- unit: octets interface, specified in octets. For
Command Description
This command shows the parameters related to the testing of an interface.
Metallic Test Access is an example of an interface test. The result of the Metallic Test Access interface test is shown
with this command.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.5-1 "Interface Test Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: index (1/1/3/0..) of
( xdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> / rack/shelf/slot/port
<Eqpt::SlotId> / <Eqpt::PortId>
| xdsl-channel : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-if : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| atm-pvc : <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>
| pppoe : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| l2-vlan : <Eqpt::VlanId>
| ip : <Eqpt::LogicalId>
| sw-loopback
| slip
| ethernet : <Eqpt::EthernetId>
| pppoeses : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::LogicalSesId>
| atm-bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| ip-gateway : <Eqpt::VrfId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
Command Output
Table 57.5-2 "Interface Test Status Command" Display parameters
Specific Information
name Type Description
id Parameter type: <TestAndIncr> Specifies the current invocation
- TestAndIncr of the interface's test.
- range: [0...2147483647] This element is always shown.
result Parameter type: <Itf::ifTestResult> Specifies the result of the most
( none recently requested test
| success This element is always shown.
| in-progress
| not-supported
| unable-to-run
Command Description
This command shows the status of the stack.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.6-1 "Interface Stack Status Command" Resource Parameters
Resource Identifier Type Description
(higher) Format: a higher layer interface index
( xdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| xdsl-channel : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-if : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| atm-pvc : <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>
| pppoe : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| l2-vlan : <Eqpt::VlanId>
| ip : <Eqpt::LogicalId>
| sw-loopback
| slip
| ethernet : <Eqpt::EthernetId>
| pppoeses : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::LogicalSesId>
| atm-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>
| pppoe : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
Command Description
This command shows the current operational state of an interface.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.7-1 "SHub Interface Status Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
Command Output
Table 57.7-2 "SHub Interface Status Command" Display parameters
Specific Information
name Type Description
admin-status Parameter type: <Shub::AdminStatus> The administrative state of the
( up vlan interface.
| down This element is always shown.
| testing
| auto-up )
Possible values:
- up : up
- down : down
- testing : testing
- auto-up : autoup
oper-status Parameter type: <Shub::OperStatus> The current operational state of
( up the vlan interface.
| down This element is always shown.
| testing
| unknown
| dormant
| not-present
| lower-layer-down )
Command Description
This command displays the port control status.
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.8-1 "SHub Interface Port Control Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: control index of the port
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Command Output
Table 57.8-2 "SHub Interface Port Control Status Command" Display parameters
Specific Information
name Type Description
admin-status Parameter type: <Shub::AdminStatus> Specifies the administrative
( up status of the interface
| down This element is always shown.
| testing
| auto-up )
Possible values:
- up : up
- down : down
- testing : testing
- auto-up : autoup
oper-status Parameter type: <Shub::AdminStatus> Specifies the operational status of
( up the interface
| down This element is always shown.
| testing
| auto-up )
Possible values:
- up : up
Command Description
This node allows the user to view the current state of an interface
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.9-1 "SHub Interface Uplink Group Status Command" Resource Parameters
Resource Identifier Type Description
(group-id) Format: groupid number
- the number of uplink group
- range: [1...7]
Command Output
Table 57.9-2 "SHub Interface Uplink Group Status Command" Display parameters
Specific Information
name Type Description
group-status Parameter type: <Itf::GroupStatus> the current uplink group status
( up This element is always shown.
| down
| invalid )
Possible values:
- up : uplink group status up
- down : uplink group status down
- invalid : uplink group status invalid
threshold Parameter type: <Itf::Threshold> the min nbr of links to be
- the min nbr of links to be operational UP in grp operational UP in grp
- range: [0...7] This element is always shown.
up-links Parameter type: <SignedInteger> available number of links in the
- a signed integer group
This element is always shown.
port-list Parameter type: <Shub::PortList> The set of ports members of the
- a list of ports (port 1 is the MSB of the first byte) uplink group
- length: 3 This element is always shown.
Command Description
This command shows the interface statistics.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.10-1 "Interface Statistics Commands" Resource Parameters
Resource Identifier Type Description
(port) Format: port number
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Command Output
Table 57.10-2 "Interface Statistics Commands" Display parameters
Specific Information
name Type Description
in-octets Parameter type: <Counter> The total number of octets
- counter received on the interface,
including framing characters.
This element is always shown.
in-ucast-pkts Parameter type: <Counter> The number of packets, delivered
- counter by this sub-layer to a higher
(sub-)layer, which were not
addressed to a multicast or
broadcast address at this
sub-layer.
This element is only shown in
detail mode.
in-addr-ucast-pkts Parameter type: <Counter> The number of packets, delivered
- counter by this sub-layer to a higher
(sub-)layer, which were
addressed to a multicast or
broadcast address at this
Command Description
This command shows the parameters related to an interface such as next avalable port type, counter indicating
number of state changes, and number of network interfaces.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 57.11-1 "Interface Extensive Status Command" Resource Parameters
Resource Identifier Type Description
(port-type) Format: the port type
( xdsl-line
| ethernet-line )
Possible values:
- xdsl-line : xdsl line
- ethernet-line : ethernet line
Command Output
Table 57.11-2 "Interface Extensive Status Command" Display parameters
Common Information:common
name Type Description
change-count Parameter type: <Counter> Number of state changes of the
- counter physical line.
This element is always shown.
interface-cnt Parameter type: <SignedInteger> The number of network interfaces
- a signed integer (regardless of their current state)
present on this system.
This element is always shown.
Specific Information
name Type Description
next-available Parameter type: <Itf::NextAvailable> Specifies the next available
( xdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> / physical interface can be
<Eqpt::SlotId> / <Eqpt::PortId> retrieved.
| ethernet-line : <Eqpt::RackId> / <Eqpt::ShelfId> / This element is always shown.
<Eqpt::SlotId> / <Eqpt::PortId> )
Description
This chapter gives an overview of nodes that are handled by "SNTP Status Commands".
Command Tree
----show
----sntp
Command Description
This command displays the information about the SNTP and its related parameters.
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 58.2-2 "SNTP Status Command" Display parameters
Specific Information
name Type Description
operating-mode Parameter type: <Sys::SNTPOperatingMode> specifies the operating mode for
( unicast the SNTP application at the
| anycast SNMP agent.
| multicast ) This element is always shown.
Possible values:
- unicast : operating mode unicast value 1
- anycast : operating mode anycast value 2
- multicast : operating mode multicast value 3
system-time Parameter type: <Sys::timeInSecs> specifies the network time.
- the time (yyyy-mm-dd:hour:minutes:secs) This element is always shown.
- unit: UTC
shub-time Parameter type: <Sys::TimeRef1970> specifies shub network time.
- the time (yyyy-mm-dd:hour:minutes:secs) This element is always shown.
- unit: UTC
Description
This chapter gives an overview of nodes that are handled by "System Status Commands".
Command Tree
----show
----system
----shub
----entry
----ip
----version
----status
----misc
----config-control
- (ctrl-index)
----filters
----ip
- (index-num)
----shub-manager
- (index)
----entry
----license
- (feature)
----clock-mgmt
----syslog
Command Description
This command displays the SHub IP parameters.
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 59.2-2 "SHub System IP Status Command" Display parameters
Specific Information
name Type Description
ip-addr-cfg-mode Parameter type: <Sys::DefIpAddr> Specifies the mode by which the
( manual default interface in the device
| dynamic ) gets the IP address.
Possible values: This element is always shown.
- manual : ip address got from the system
- dynamic : ip address got through dynamic IP address
eff-ip-addr Parameter type: <Ip::V4Address> Specifies Effective IP address of
- IPv4-address the switch to be used for
contacting through SNMP
interface or web interface.
This element is always shown.
Command Description
This command displays the version of the SHub system parameters.
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 59.3-2 "SHub System Version Status Command" Display parameters
Specific Information
name Type Description
sw-release-num Parameter type: <Sys::ReleaseNum> specifies the software version
- release number number.
- length: 1<=x<=7 This element is always shown.
Command Description
This command displays the last changed time of the status of the SHub HTTP access.
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 59.4-2 "SHub System HTTP Status Command" Display parameters
Specific Information
name Type Description
last-chg-status Parameter type: <PrintableString> Specifies whether last
- printable string configuration change has been
saved in flash/remote and current
status of restore.
This element is always shown.
http-status Parameter type: <Sys::HttpStatus> Specifies whether http access for
( http-access the users is enabled or disabled.
| no-http-access ) This element is always shown.
Possible values:
- http-access : enable http access for the users
- no-http-access : disable http access for the users
Command Description
This command displays the common system parameters of the SHub.
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 59.5-2 "SHub System Common Status Command" Display parameters
Specific Information
name Type Description
def-intf Parameter type: <Sys::DefInterface> Name of the default interface that
- default interface name can be used for communicating
- length: 1<=x<=16 with the system for configuration
through SNMP.
This element is always shown.
base-bdg-addr Parameter type: <Vlan::MacAddr> Specifies the MAC address used
- mac address (aa:bb:cc:a1:02:03) by the bridge when it must be
- length: 6 referred to in a unique fashion.
This element is always shown.
sys-mac-addr Parameter type: <Vlan::MacAddr> Specifies the system MAC
- mac address (aa:bb:cc:a1:02:03) address used by this bridge when
- length: 6 it must be referred to in a unique
fashion.
This element is always shown.
Command Description
This command displays the system control parameters.
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 59.6-1 "SHub System Control Status Command" Resource Parameters
Resource Identifier Type Description
(ctrl-index) Format: control index of the config
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Command Output
Table 59.6-2 "SHub System Control Status Command" Display parameters
Specific Information
name Type Description
egress Parameter type: <Sys::EgressStatus> Specifies the transmission of
( egress-enabled egress traffic over this interface is
| egress-disabled ) enabled or not.
Possible values: This element is always shown.
- egress-enabled : enable this status
- egress-disabled : disable this status
collection Parameter type: <Sys::CollectionStatus> Specifies the statistics collection
( collection for this interface is enabled or
| no-collection ) not.
Possible values: This element is always shown.
- collection : enable the collection of statistics
- no-collection : disable the collection of statistics
ctrl-status Parameter type: <Sys::ConfigCtrlStatus> Specifies the config control
( enable status.
| disable ) This element is always shown.
Possible values:
- enable : makes the entry valid
Command Description
This command displays IP filter related information.
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 59.7-1 "SHub IP Filter Status Command" Resource Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
Command Output
Table 59.7-2 "SHub IP Filter Status Command" Display parameters
Specific Information
name Type Description
protocol Parameter type: <Sys::Protocol> Specifies the type of protocol to
( icmp be checked against the packet.
| igmp This element is always shown.
| ggp
| ip
| tcp
| egp
| igp
| nvp
| udp
| irtp
| idrp
| rsvp
| msrp
| igrp
| ospf
| any )
Possible values:
- icmp : check the packet for icmp
Command Description
This command displays the manager parameters.
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 59.8-1 "SHub System Manager Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index number of the SrcIp
- index(1..100)
- range: [1...100]
Command Output
Table 59.8-2 "SHub System Manager Status Command" Display parameters
Specific Information
name Type Description
src-ip-addr Parameter type: <Ip::V4Address> Specifies the management vlan
- IPv4-address filter IP address to be matched
with the packet.
This element is always shown.
Command Description
This command displays the status of the list commands.
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 59.9-2 "System Statistics Command" Display parameters
Specific Information
name Type Description
status-bit-map Parameter type: <Sys::AsamSysStatusBitMap> Specifies the status bitmap.
- status bitmap This element is always shown.
mib-version Parameter type: <Sys::asamMibVersion> Specifies the version of the
- a printable string management interface.
- length: x<=21 This element is always shown.
init-progress Parameter type: <Sys::AsamSystemInitProgress> Specifies the progress of the
- progress of system initialisation indicated as percent system initialization indicated as
- unit: percent a percentage.
- range: [0...100] This element is always shown.
Command Description
This command displays the number of software licenses for the following features.
For ADSL2+, the counter indicates the number of XDSL lines for which an ADSL2+ operational mode (POTS
and/or ISDN) is enabled in its configuration, and supported by the LT board, and for which the XDSL board is
equipped.
For READSL2 operational mode (US mode 1 and/or US mode 2), the counter is enabled in its configuration, and
supported by the LT board, and for which the XDSL board is equipped.
For IGMP, the counter indicates the number of PVCs for which an IGMP control channel has been configured.
For IP-Forwarding, the counter indicates the number of PVCs configured.
For PPPoX Relay, the counter indicates the number of PVCs configured.
For PPPoX Termination, the counter indicates the number of PVCs for which PPPoE termination or PPPoA
termination has been configured.
For 802.1x, the counter indicates the number of PVCs for which 802.1x has been configured as 'enabled'.
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 59.10-1 "System Licenses Status Command" Resource Parameters
Resource Identifier Type Description
(feature) Format: table index
( adsl2-plus
| readsl2
| igmp
| ip-forward
| pppox-relay
| pppox-termination
| 802dot1x
| annex-m
| ipoa-cc )
Possible values:
- adsl2-plus : number of xdsl lines for which ADSL2 is
enabled
- readsl2 : number of xdsl lines for which READSL2 is
Command Output
Table 59.10-2 "System Licenses Status Command" Display parameters
Common Information:routing-licence
name Type Description
routing-licence Parameter type: <Sys::RoutingLicStatus> shows the status of the routing
( not-active license.
| active ) This element is always shown.
Possible values:
- not-active : routing license unavailable
- active : routing license available
Specific Information
name Type Description
number-license Parameter type: <SignedInteger> Specifies number of license.
- a signed integer This element is always shown.
Command Description
This command displays three display elements named actual-priority, clock-status, and clock-selection.
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 59.11-2 "System Clock Status Command" Display parameters
Specific Information
name Type Description
actual-priority Parameter type: <Sys::SysClkSrcPriorityScheme> Shows the actual priority of clock
( autoselect sources.
| local This element is always shown.
| external-local )
Possible values:
- autoselect : select based on location
- local : always select local clock
- external-local : external clock > local clock
selection Parameter type: <Sys::asamSysClkSrcSelection> Shows the clock source selected
( active-external by system
| active-local ) This element is always shown.
Possible values:
- active-external : external clock on active NT
- active-local : local clock on active NT
ext-source Parameter type: <Sys::SysClkExtSource> Shows the clock source selected
( e1 by system E1/DS1/2048KHz
| ds1 This element is always shown.
| khz2048 )
Possible values:
- e1 : select ETSI Source
- ds1 : select DS1 Source
- khz2048 : select 2048KHz Source
external-nt-a Parameter type: <Sys::clkSrcExtAFailure> Shows the status of the External
( failure clock on NT A
| available ) This element is always shown.
Possible values:
- failure : failure of external clock on NT A
- available : availablity of external of clock on NT A
Command Description
This command displays the system related parameters for syslog.
User Level
The command can be accessed by operators with security privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 59.12-2 "Show syslog parameters" Display parameters
Specific Information
name Type Description
max-msg-size Parameter type: <Sys::MaxMsgSize> maximum size of the syslog
- the maximum size of the syslog message message
- unit: bytes This element is always shown.
- range: [0...1024]
available-on-disk Parameter type: <Sys::MaxStorageSize> total storage size available to
- total storage size available to store the messages store the messages
- unit: bytes This element is always shown.
- range: [0...2000000]
used-on-disk Parameter type: <Sys::UsedSize> indicates inuse storage size by the
- indicates inuse storage size by the messages messages
- unit: bytes This element is always shown.
- range: [0...2000000]
reserved-on-disk Parameter type: <Sys::ReservedSize> indicate the reserved storage size
- indicates inuse storage size by the messages for the messages
- unit: bytes This element is always shown.
- range: [0...2000000]
free-on-disk Parameter type: <Sys::FreeSize> total free memory available to
- free memory available for storing syslog messages from store syslog messages
total allocated memory This element is always shown.
- unit: bytes
- range: [0...2000000]
Description
This chapter gives an overview of nodes that are handled by "Transaction Status Commands".
Command Tree
----show
----transaction
----set-log-table
- (log-table-index)
----log-entry
Command Description
This command displays the transaction set log parameters.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 60.2-1 "Transaction Log Status Command" Resource Parameters
Resource Identifier Type Description
(log-table-index) Format: the key in the set Log table
- a signed integer
Command Output
Table 60.2-2 "Transaction Log Status Command" Display parameters
Specific Information
name Type Description
log-ipaddr Parameter type: <Ip::V4Address> IP address of the Manager who
- IPv4-address changed this object
This element is always shown.
changed-object-id Parameter type: <Object> the Object Identifier of an object
- an object identifier which has been changed.
This element is always shown.
context Parameter type: <Trans::context> The context, which the object
( nt belongs to
| shub ) This element is always shown.
Possible values:
- nt : nt: nt context
- shub : shub: shub context
Command Description
This command displays the transaction log entry-related parameters.
User Level
The command can be accessed by operators with alarm privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 60.3-2 "Transaction Log Entry Status Command" Display parameters
Specific Information
name Type Description
set-log-lastentry Parameter type: <SignedInteger> index of the last entry that has
- a signed integer been added to the set log table.
This element is always shown.
set-log-resettime Parameter type: <Sys::Time> time when set log has been reset
- the time (yyyy-mm-dd:hour:minutes:secs) This element is always shown.
- unit: UTC
set-log-overflowed Parameter type: <Trans::overflowed> specifies whether the set log
( not-overflowed buffer is overflowed or not.
| overflowed ) This element is always shown.
Possible values:
- not-overflowed : log buffer not overflowed is 1
- overflowed : log buffer overflowed is 2
set-log-buffersize Parameter type: <SignedInteger> the size of the internal set log
- a signed integer buffer.
This element is always shown.
nbr-of-sets Parameter type: <SignedInteger> nbr of successfull sets since
- a signed integer system is up.
This element is always shown.
Description
This chapter gives an overview of nodes that are handled by "Error Status Command".
Command Tree
----show
----error
- (id)
Command Description
This command displays the error 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 61.2-1 "Error Log Status Command" Resource Parameters
Resource Identifier Type Description
(id) Format: error number
- a signed integer
Command Output
Table 61.2-2 "Error Log Status Command" Display parameters
Common Information:error-log related information
name Type Description
last-entry Parameter type: <Error::ErrLogLastEntry> index of the last entry that is
- index of the last entry of error log table added to the error log table.
This element is always shown.
reset-time Parameter type: <Sys::Time> time value when the error log is
- the time (yyyy-mm-dd:hour:minutes:secs) resetted
- unit: UTC This element is always shown.
buffer-size Parameter type: <SignedInteger> size of the internal log buffer.
- a signed integer This element is always shown.
overflowed Parameter type: <Error::LogOverFlow> specifies whether log buffer is
( no overflowed or not.
| yes ) This element is always shown.
Possible values:
- no : when log buffer is reset
- yes : full action set to warp around
Specific Information
name Type Description
timestamp Parameter type: <Sys::Time> network time when the error is
- the time (yyyy-mm-dd:hour:minutes:secs) generated.
- unit: UTC This element is always shown.
Description
This chapter gives an overview of nodes that are handled by "Software Status Commands".
Command Tree
----show
----software-mngt
----database
- (db-container)
- oswp-number
----descriptor-files
- (index)
----oswp
- (index)
----swp
- (name)
----swp-disk-file
- (name)
- file-name
- file-board-type
----upload-download
----shub
----config-file
----boot-rom-status
Command Description
This command displays the various database parameters.
User Level
The command can be accessed by operators with software management privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 62.2-1 "Database Status Command" Resource Parameters
Resource Identifier Type Description
(db-container) Format: the database container ID
( first
| second
| third )
Possible values:
- first : first container
- second : second container
- third : third container
oswp-number Parameter type: <SwMngt::DbmOswpIndex> index in the database table
Format:
- index in the database table
- range: [1...2]
Command Output
Table 62.2-2 "Database Status Command" Display parameters
Specific Information
name Type Description
name Parameter type: <SwMngt::dbmDatabaseName> A string representing the
- a printable string database. The value 'NO-NAME'
- length: x<=32 will be used by the system for the
default databases.
This element is always shown.
oper-status Parameter type: <SwMngt::dBaseOperStatus> The operational status of the
( actual database.
| preferable This element is always shown.
| previous
Command Description
This command displays the values of the various attributes of the SWM disk file.
User Level
The command can be accessed by operators with software management privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 62.3-1 "Disk Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index to the swm disk file table
- path and name of the oswp ,file name less than 160 char
- range: [a-zA-Z0-9-_./]
- length: 1<=x<=255
Command Output
Table 62.3-2 "Disk Status Command" Display parameters
Specific Information
name Type Description
type Parameter type: <SwMngt::diskFileType> Specifies the type of the file.
( overall-descriptor This element is always shown.
| descriptor
| file-type-a
| file-type-b
| not-specified
| file-type-c
| file-type-d
| file-type-e
| file-type-f
| file-type-g
| file-type-h
| file-type-i
| file-type-j )
Possible values:
- overall-descriptor : over all descriptor file
- descriptor : descriptor file
- file-type-a : file type a
Command Description
This command displays various OSWP states and attributes.
User Level
The command can be accessed by operators with software management privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 62.4-1 "Overall Software Package Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index to the swm oswp table
- id of one of the two oswps
- range: [1...2]
Command Output
Table 62.4-2 "Overall Software Package Status Command" Display parameters
Specific Information
name Type Description
name Parameter type: <SwMngt::oswpName> Name of the OSWP. The name of
- path and name of the oswp ,file name less than 160 char an OSWP corresponds to the path
- range: [a-zA-Z0-9-_./] name:
- length: 1<=x<=255 /path_to_OSWP/file_name.
This element is always shown.
availability Parameter type: <SwMngt::operAvailStatus> Specifies the availability status of
( empty the OSWP.
| enabled This element is always shown.
| disabled
| downloading
| aborting )
Possible values:
- empty : no OSWP is related to the index
- enabled : related OSWP is valid
- disabled : download of related OSWP failed
- downloading : download of related OSWP is ongoing
- aborting : files of the related OSWP are removed
act-status Parameter type: <SwMngt::operActStatus> Specifies the related OSWP is
Command Description
This command displays the parameters of the dynamic SWP table, which represent the SWPs that belong to at least
one of the OSWPs available in the system.
User Level
The command can be accessed by operators with software management privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 62.5-1 "Software Package Status Command" Resource Parameters
Resource Identifier Type Description
(name) Format: index to the swm-swp table
- a printable string
- length: x<=32
Command Output
Table 62.5-2 "Software Package Status Command" Display parameters
Specific Information
name Type Description
type Parameter type: <SwMngt::swmSwpType> Specifies the type of the software
( asam-core package.
| voice-gateway This element is always shown.
| ip-server )
Possible values:
- asam-core : asam core
- voice-gateway : voice gateway
- ip-server : ip server
dbase-ver-no Parameter type: <SwMngt::dBVersionNumber> Specifies the version number of
- a printable string the database that is compatible
- length: x<=32 with the software package.
This element is always shown.
primary-file-id Parameter type: <Ip::V4Address> Specifies the IP address of the
- IPv4-address TFTP/SFTP server where the
software package can be found.
This element is always shown.
secondary-file-id Parameter type: <Ip::V4Address> Specifies the IP address of a
Command Description
This command displays information about the relationships between the files known by the system and the available
OSWPs.
User Level
The command can be accessed by operators with software management privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 62.6-1 "File Status Command" Resource Parameters
Resource Identifier Type Description
(name) Format: index to the Swm_Contains_File
- a printable string table
- length: x<=32
file-name Parameter type: <SwMngt::swpContainsFileName> index to the Swm_Contains_File
Format: table
- a printable string
- length: x<=32
file-board-type Parameter type: <SwMngt::swpBoardType> index to the Swm_Contains_File
Format: table
- a printable string
- length: x<=21
Command Output
Table 62.6-2 "File Status Command" Display parameters
Specific Information
name Type Description
file-format Parameter type: <SwMngt::fileFormat> Specifies the format of the file.
( tar This element is always shown.
| lz77
| ascii
| exe )
Possible values:
- tar : file format is tar
- lz77 : file format is lz77
Command Description
This command displays the upload and download parameters.
User Level
The command can be accessed by operators with software management privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 62.7-2 "Upload/Download Status Command" Display parameters
Specific Information
name Type Description
disk-space Parameter type: <SwMngt::TotalSpaceOnDisk> The total space on the file disk
- total space on file disk that is reserved for storage that is reserved for the storage of
- unit: bytes files.
This element is always shown.
free-space Parameter type: <SwMngt::FreeSpaceOnDisk> Specifies the space on the file
- total space on the file disk that is still available disk that is still available for the
- unit: bytes storage of files.
This element is always shown.
download-progress Parameter type: <SwMngt::downloadProgress> Specifies the current status of the
( download-ongoing database download process.
| download-success This element is always shown.
| download-fail )
Possible values:
- download-ongoing : download ongoing
- download-success : download finished and successfull
- download-fail : download finished but failed
download-error Parameter type: <SwMngt::downloadError> Specifies the reason in case of a
( illegaltftpoperation database download failure.
| file-not-found This element is always shown.
| access-violation
| diskfull-alloc-exced
| illegal-tftp-operation
| unknown-transfer-id
| file-exists
| no-such-user
| corrupted-database
| system-restart
| no-error )
Command Description
This command displays the status of software management on the SHub.
User Level
The command can be accessed by operators with software management privileges.
Command Syntax
The command has the following syntax:
Command Description
This command shows the status of SHub configuration files.
User Level
The command can be accessed by operators with software management privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 62.9-2 "SHub Configuration File Status Command" Display parameters
Specific Information
name Type Description
db-save-status Parameter type: <Sys::SaveStatus> the status of the database save
( inprogress operation
| successful This element is always shown.
| failed
| notinitiated )
Possible values:
- inprogress : operation in progress
- successful : operation is successful
- failed : operation failed
- notinitiated : not initiated
sw-download-status Parameter type: <Sys::DownloadStatus> the status of the software
( inprogress download operation
| successful This element is always shown.
| failed )
Possible values:
- inprogress : operation in progress
- successful : operation is successful
- failed : operation failed
downloaded-sw Parameter type: <SwMngt::ShubSoftwareImage> the specification of the
<Ip::V4Address> : <Sys::FileName> downloaded software package
Field type <Ip::V4Address> This element is only shown in
- IPv4-address detail mode.
Field type <Sys::FileName>
- name
- length: 1<=x<=256
current-osp Parameter type: <SwMngt::CurrOSPVersion> the current osp version
( other than config/tftp This element is always shown.
| config-1
Command Description
This command displays the status of the SHub boot ROM update.
User Level
The command can be accessed by operators with software management privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 62.10-2 "Status of the SHub Boot ROM Update Command" Display parameters
Specific Information
name Type Description
boot-rom-status Parameter type: <SwMngt::ShubBootRomStatus> the status of the boot ROM image
( in-progress update operation
| successful This element is always shown.
| failed )
Possible values:
- in-progress : update operation in progress
- successful : update operation successful
- failed : update operation failed
Description
This chapter gives an overview of nodes that are handled by "IGMP Status Commands".
Command Tree
----show
----igmp
----system
----channel
----counter
- (port)
----miscellaneous
- (port)
----protocol
- (port)
----package-to-src
- (package-id)
----grp-to-package
- (mcast-addr)
----module-mcast-src
- (slot)
- mcast-addr
----module
----counter
- (slot-index)
----time
- (slot-index)
----miscellaneous
- (slot-index)
----shub
----vlan-router-port
- (vlan-id)
- network-port
----igs-stats
- (vlan-id)
----system-stats
----mcast-stats
- (src)
- vlan-id
- ip-addr
----bundle-stats
- (bundle-name)
----bundle-to-src
- (bundle-name)
- class-d-addr
- vlan-id
Command Description
This command displays the IGMP system-related parameters.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 63.2-2 "IGMP System Status Command" Display parameters
Specific Information
name Type Description
startup-query-intvl Parameter type: <Igmp::SysStartUpQueryInt> The interval between general
- interval at which general membership queries transmitted membership queries sent on
- unit: sec startup.
- range: [1...3175] This element is always shown.
startup-query-count Parameter type: <Igmp::SystemStartupQueryCount> The number of queries sent out
- queries sent out on startup separated by query interval on startup separated by the query
- range: [1...10] interval.
This element is always shown.
stats-intvl Parameter type: <Igmp::McastSrcPeakTime> This statistics indicates the
- the time (yyyy-mm-dd:hour:minutes:secs) network time of when the
- unit: UTC system-wide statistics were last
reset.
This element is always shown.
src-ipaddr Parameter type: <Ip::V4Address> This object specifies the source
- IPv4-address IP address which is contained in
every multicast IP datagrams
transmitted on all IGMP control
channels.
This element is always shown.
router-present-timeout Parameter type: <SignedInteger> When the system acts as host on
- a signed integer the network side of the IGMP
proxy, this value is the time how
long the system shall wait after
hearing a Version 1 Query before
it shall send any IGMPv2
messages.
This element is always shown.
grp-memb-intvl Parameter type: <SignedInteger> The interval that must pass before
Command Description
This command displays the IGMP channel source.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 63.3-1 "IGMP Channel Sources Status 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> )
Possible values:
- vlan : vlan port
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 Output
Table 63.3-2 "IGMP Channel Sources Status Command" Display parameters
Specific Information
name Type Description
noperm-join Parameter type: <Counter> no of times perm bitmap failure
- counter has occurred.
This element is always shown.
bitrate-fail Parameter type: <Counter> no of times IGMP join message
- counter failed
This element is always shown.
inval-classd Parameter type: <Counter> indicates the count of IP address
- counter states
This element is always shown.
numsec-ovld-protappl Parameter type: <Counter> no of 1sec int for overload
- counter protection has been applied
This element is always shown.
num-fail Parameter type: <Counter> Indicates the count of failure join
- counter This element is always shown.
sysnum-fail Parameter type: <Counter> Indicates the count of failure
- counter IGMP join
This element is always shown.
Command Description
This command displays the IGMP channel source.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 63.4-1 "IGMP Channel Miscellaneous Status 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> )
Possible values:
- vlan : vlan port
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>
Command Output
Table 63.4-2 "IGMP Channel Miscellaneous Status Command" Display parameters
Specific Information
name Type Description
curr-num-group Parameter type: <Gauge> current group number in this
- gauge port(ADSL,PVC)
This element is always shown.
curr-preview-num Parameter type: <Counter> count of prev mcast grp that igmp
- counter channel joins currently
This element is always shown.
curr-uncfg-num Parameter type: <Counter> current unconfig group number in
- counter this port(ADSL,PVC)
This element is always shown.
Command Description
This command shows the IGMP protocol statistics for an IGMP channel
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 63.5-1 "IGMP Channel Protocol Status 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> )
Possible values:
- vlan : vlan port
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 Output
Table 63.5-2 "IGMP Channel Protocol Status Command" Display parameters
Specific Information
name Type Description
tx-gmq Parameter type: <Counter> number of general queries
- counter transmitted on user interface
This element is always shown.
tx-gsq Parameter type: <Counter> number of group specific queries
- counter transmitted
This element is always shown.
rx-v1-req Parameter type: <Counter> number of V1 membership report
- counter received
This element is always shown.
rx-v2-req Parameter type: <Counter> number of V2 membership report
- counter received
This element is always shown.
rx-v3-req Parameter type: <Counter> number of V3 membership report
- counter received
This element is always shown.
rx-v2-leaves Parameter type: <Counter> number of leave messages report
- counter received
This element is always shown.
rx-valid-message Parameter type: <Counter> number of valid IGMP packets
- counter received
This element is always shown.
rx-invalid-message Parameter type: <Counter> number of invalid IGMP packets
- counter received
This element is always shown.
rx-unknown-message Parameter type: <Counter> number of unknown IGMP
- counter packets received
This element is always shown.
rx-bad-length Parameter type: <Counter> number of bad length IGMP
- counter packet received/dropped
This element is always shown.
rx-bad-ip-checksum Parameter type: <Counter> number of wrong IP checksum
- counter IGMP packet received/dropped
This element is always shown.
rx-bad-igmp-checksum Parameter type: <Counter> number of wrong IGMP
- counter checksum IGMP packets
received/dropped
This element is always shown.
Command Description
This command shows the IGMP package to multicast source parameters.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 63.6-1 "IGMP package to multicast source Command" Resource Parameters
Resource Identifier Type Description
(package-id) Format: name used to identify the
- index of the package packages
- range: [1...1024]
Command Output
Table 63.6-2 "IGMP package to multicast source Command" Display parameters
Specific Information
name Type Description
group-address Parameter type: <Ip::V4Address> the multicast group address
- IPv4-address This element is always shown.
source-address Parameter type: <Ip::V4Address> the multicast group source
- IPv4-address address
This element is always shown.
Command Description
This command shows the IGMP group to package parameters
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 63.7-1 "IGMP Group to Package Status Command" Resource Parameters
Resource Identifier Type Description
(mcast-addr) Format: the multicast group address
- IPv4-address
Command Output
Table 63.7-2 "IGMP Group to Package Status Command" Display parameters
Specific Information
name Type Description
mcast-src-addr Parameter type: <Ip::V4Address> the multicast group source
- IPv4-address address
This element is always shown.
index Parameter type: <Igmp::PackageIndex> index used to identify the
- index of the package packages
- range: [1...1024] This element is always shown.
Command Description
This command shows the multicast-related parameters.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 63.8-1 "Show Multicast Source Statistics Command" Resource Parameters
Resource Identifier Type Description
(slot) Format: identifies an IGMP module by
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> the logical 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
mcast-addr Parameter type: <Igmp::MulticastAddress> mcast src address in network-byte
Command Output
Table 63.8-2 "Show Multicast Source Statistics Command" Display parameters
Specific Information
name Type Description
peak-nbr-subs-channels Parameter type: <Counter> The peak number of subscribed
short name: - counter IGMP channels which have
pk-nr-sub-chan members connected to the source
since the last statistics reset. It is
only for those groups configured
in multicast source table.
This element is always shown.
peak-time Parameter type: <Igmp::McastSrcPeakTime> The network time indicating
- the time (yyyy-mm-dd:hour:minutes:secs) when the peak number of
- unit: UTC subscribed IGMP channels for
the source occurred. It is only for
those groups configured in
Multicast Source Table.
This element is always shown.
curr-subs-channels Parameter type: <Gauge> Indicates the current number of
- gauge subscribed IGMP channels for
the source.
This element is only shown in
detail mode.
nbr-connect-fail Parameter type: <Counter> Indicates the number of times
short name: nr-con-fail - counter that an attempt to create a
multicast connection fails.
This element is always shown.
user-success-join Parameter type: <Counter> indicates the number of times that
- counter users successfully joined a group.
This element is always shown.
Command Description
This command displays the IGMP module counters.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 63.9-1 "IGMP Module Counter Status Command" Resource Parameters
Resource Identifier Type Description
(slot-index) Format: identifies an IGMP module by
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> the logical slot id
| <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 Output
Table 63.9-2 "IGMP Module Counter Status Command" Display parameters
Specific Information
name Type Description
total-msg Parameter type: <Counter> The total number of messages
- counter received from users, including
IGMP messages and invalid
messages.
This element is always shown.
total-igmp-msg Parameter type: <Counter> The total number of IGMP
- counter messages, which includes join
and leave requests from users,
(both successful and
unsuccessful).
This element is always shown.
total-req Parameter type: <Counter> The total number of join requests
Command Description
This command displays the IGMP module time-related parameters.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 63.10-1 "IGMP Module Time Status Command" Resource Parameters
Resource Identifier Type Description
(slot-index) Format: identifies an IGMP module by
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> the logical slot id
| <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 Output
Table 63.10-2 "IGMP Module Time Status Command" Display parameters
Specific Information
name Type Description
peak-connects Parameter type: <Igmp::McastSrcPeakTime> This statistic is the network time
- the time (yyyy-mm-dd:hour:minutes:secs) indicating when the peak number
- unit: UTC of connects performed per second
occurred.
This element is always shown.
peak-disconnects Parameter type: <Igmp::McastSrcPeakTime> The network time of when the
- the time (yyyy-mm-dd:hour:minutes:secs) peak number of disconnects to
- unit: UTC users performed per second
occurred.
This element is always shown.
peak-msg Parameter type: <Igmp::McastSrcPeakTime> The network time of when the
- the time (yyyy-mm-dd:hour:minutes:secs) peak number of messages
Command Description
This command displays the IGMP module parameters.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 63.11-1 "IGMP Module Miscellaneous Status Command" Resource Parameters
Resource Identifier Type Description
(slot-index) Format: identifies an IGMP module by
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> the logical slot id
| <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 Output
Table 63.11-2 "IGMP Module Miscellaneous Status Command" Display parameters
Specific Information
name Type Description
curr-root-conn Parameter type: <Gauge> The number of the connected
- gauge groups.
This element is always shown.
con-cfgd Parameter type: <Gauge> The number of the connected
- gauge groups who are configured in
multicast source table.
This element is always shown.
con-un-cfgd Parameter type: <Gauge> The number of the connected
- gauge groups who aren't configured in
Command Description
This command displays the status of the IGMP VLAN router ports.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 63.12-1 "SHub IGMP VLAN Router Port Status 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:
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Command Output
Table 63.12-2 "SHub IGMP VLAN Router Port Status Command" Display parameters
Specific Information
name Type Description
config-status Parameter type: <Vlan::VlanRouterConfigStatus> status of the router port
( static This element is always shown.
| dynamic
| static-dynamic )
Possible values:
- static : static group entry
- dynamic : dynamic entry
- static-dynamic : static dynamic entry
Command Description
This command shows IGMP protocol statistics for the shub
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 63.13-1 "Shub IGMP System Status Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: for which IGMP snooping
- vlan id statistics are displayed
- range: [1...4093]
Command Output
Table 63.13-2 "Shub IGMP System Status Command" Display parameters
Specific Information
name Type Description
rx-gmq Parameter type: <SignedInteger> number of queries received by
- a signed integer the snooping switch
This element is always shown.
rx-gsq Parameter type: <SignedInteger> number of group queries received
- a signed integer by the snoop switch
This element is always shown.
rx-gmq-gsq Parameter type: <SignedInteger> number of group,source queries
- a signed integer received by switch
This element is always shown.
rx-igmp-reports Parameter type: <SignedInteger> number of IGMPv1/IGMPv2
- a signed integer membership reports received
This element is always shown.
rx-igmp-v3-reports Parameter type: <SignedInteger> number of IGMPv3 mem-reports
- a signed integer received by snoop switch
This element is always shown.
rx-igmp-v3-is-in-msgs Parameter type: <SignedInteger> number of IGMPv3 mem-reports
- a signed integer of type IS_IN received
This element is always shown.
Command Description
This command shows the CAC system-related parameters and statistics.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 63.14-2 "Shub IGMP CAC System Status Command" Display parameters
Specific Information
name Type Description
used-bw-grt Parameter type: <Igmp::OccupyBWGuranteed> bandwidth occupied by the all
short name: bw-grt - bandwidth occupied by all active guaranteed channels active guaranteed channels
- unit: kbps This element is always shown.
used-chan-grt Parameter type: <Igmp::OccupyGuaranteedChannel> number of active guaranteed
short name: chan-grt - a signed integer channels connected to lanx
This element is always shown.
used-bw-no-grt Parameter type: <Igmp::OccupyBWNonGuranteed> bandwidth occupied by the all
short name: bw-no-grt - bandwidth occupied by all active non-guaranteed channels active non-guaranteed channels
- unit: kbps This element is always shown.
used-chan-no-grt Parameter type: <Igmp::OccupyNonGuaranteedChannel> number of active non-guaranteed
short name: chan-no-grt - a signed integer channels connected to lanx
This element is always shown.
jn-reject-bw Parameter type: <Counter> the number of joins rejected for
- counter non-guaranteed channels
This element is only shown in
detail mode.
jn-reject-chan Parameter type: <Counter> number of multicast joins
- counter rejected for the
non-guaranteed/non-configured
channels
This element is only shown in
detail mode.
jn-reject-uncfg Parameter type: <Counter> count of joins rejected for
- counter non-configured multicast source
This element is only shown in
detail mode.
active-non-rate-based Parameter type: <Igmp::ActiveNonConfMulticastEntries> number of active non configured
- a signed integer multicast entries, include
Command Description
Show the Multicast channel statistics maintained by SHub for CAC functionality.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> show igmp shub mcast-stats [ (src) [ vlan-id <Igmp::McastSrcVLANID> ] [ ip-addr <Ip::V4Address> ] ]
Command Parameters
Table 63.15-1 "Shub IGMP CAC Multicast Sources Status 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-enaian)
Command Output
Table 63.15-2 "Shub IGMP CAC Multicast Sources Status Command" Display parameters
Specific Information
name Type Description
fail-join Parameter type: <Counter> number of multicast joins
- counter rejected of all un-configured and
un-guaranteed
This element is always shown.
fail-sys-bw Parameter type: <Counter> number of multicast joins
- counter rejected since bandwidth is not
available at the system
This element is always shown.
fail-bundle-bw Parameter type: <Counter> number of multicast joins
Command Description
Show the Multicast Bundle statistics maintained by LANX for CAC functionality.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 63.16-1 "Shub IGMP CAC Bundle Status Command" Resource Parameters
Resource Identifier Type Description
(bundle-name) Format: name of this bundle
- the name of the bundle
- length: x<=32
Command Output
Table 63.16-2 "Shub IGMP CAC Bundle Status Command" Display parameters
Specific Information
name Type Description
jn-reject-bw Parameter type: <Counter> number of multicast joins
short name: reject-bw - counter rejected since bandwidth is not
available in the bundle
This element is always shown.
jn-reject-chan Parameter type: <Counter> number of multicast joins
short name: reject-chan - counter rejected since bundle max
connections has reached
This element is always shown.
used-bw-grt Parameter type: <Igmp::bundleOccupiedBWGuranteed> total bandwidth currently
short name: bw-grt - bandwidth occupied by all active guaranteed channels occupied by guaranteed channels
- unit: kbps This element is always shown.
used-chan-grt Parameter type: <Igmp::bundleOccupiedGuaranteed> number of guaranteed channels
short name: chan-grt - a signed integer that are active in that bundle
This element is always shown.
used-bw-no-grt Parameter type: <Igmp::bundleOccupiedBWNonGuranteed> total bandwidth currently
short name: bw-no-grt - bandwidth occupied by all active non-guaranteed channels occupied by unguaranteed
- unit: kbps channels
This element is always shown.
Command Description
This command shows the CAC Bundle to multicast source parameters.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 63.17-1 "Shub IGMP CAC Bundle to Source Command" Resource Parameters
Resource Identifier Type Description
(bundle-name) Format: name of this bundle
- the name of the bundle
- length: x<=32
class-d-addr Parameter type: <Igmp::MulticastAddress> mcast src address in network-byte
Format: order(big-endian)
- multicast-address (range: 224.0.0.3....239.255.255.255)
vlan-id Parameter type: <Igmp::McastSrcVLANID> vlan for this multicast source
Format:
- VLAN for this multicast source
- range: [1...4093]
Command Output
Table 63.17-2 "Shub IGMP CAC Bundle to Source Command" Display parameters
Specific Information
name Type Description
ip-addr Parameter type: <Ip::V4Address> ip address of the multicast server
- IPv4-address in network-byte order
(big-endian)
This element is always shown.
Description
This chapter gives an overview of nodes that are handled by "Transport Status Commands".
Command Tree
----show
----transport
----icmp
----ip-address
- (address)
----ip-parameters
----ip-route
- (destination)
----ip-net-to-media
- (interface-name)
- network-addr
----snmp
----protocol-stats
----engine
----system-parameters
----udp-parameters
----udp
- (local-address)
- local-port
----ether-dot3
- (stats-index)
----ether-ifmau
- (if-index)
- index
----ether-ifsfplt
- (if-index)
- index
----shub
----dot3-coll
- (if-index)
- coll-count
----dot3-control
- (stats-index)
----dot3-pause
- (stats-index)
----dot3-status
- (stats-index)
----mac
- (index-num)
----rate
- (port)
----ether-ifmault
- (if-index)
- index
----ether-dot3lt
- (stats-index)
Command Description
This command displays the ICMP parameter, which gives a count of how many ICMP messages an entity
receives(including errors also).This errors determine the number of ICMP specific errors in the ICMP messages.
The ICMP parameter uses a list for the numbers of messages that did not reach the destination, time exceeded
messages,parameter problem messages received, source quench messages, redirect messages, echo request and
reply messages, time stamp request and reply messages, address mask request and reply messages, messages which
the entity attempted to send including the error messages and messages which the entity did not send due to the
problems like lack of buffer.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 64.2-2 "ICMP Status Command" Display parameters
Specific Information
name Type Description
rx-total-msgs Parameter type: <Counter> The total number of ICMP
- counter messages which the entity
received(includes errors also).
This element is always shown.
rx-err-msgs Parameter type: <Counter> The number of ICMP messages
- counter which the entity received but
determined as having
ICMP-specific errors.
This element is always shown.
rx-dest-unreach-msgs Parameter type: <Counter> The number of ICMP destination
- counter unreachable messages received.
This element is always shown.
rx-time-exceed-msgs Parameter type: <Counter> The number of ICMP time
- counter exceeded messages received.
This element is always shown.
rx-param-problem-msgs Parameter type: <Counter> The number of ICMP parameter
- counter problem messages received.
This element is always shown.
rx-src-quench-msgs Parameter type: <Counter> The number of ICMP source
- counter quench messages received.
This element is always shown.
rx-redirect-msgs Parameter type: <Counter> The number of ICMP Redirect
Command Description
This command displays the IP address parameter that holds the addressing information for one of this entity's IP
addresses.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.3-1 "IP Address Status Command" Resource Parameters
Resource Identifier Type Description
(address) Format: ip address where addressing
- IPv4-address information pertains
Command Output
Table 64.3-2 "IP Address Status Command" Display parameters
Specific Information
name Type Description
ifindex Parameter type: <SignedInteger> Uniquely identifies the interface
- a signed integer to which this is applicable.
This element is always shown.
subnet-mask Parameter type: <Ip::V4Address> The subnet mask associated with
- IPv4-address the IP address.
This element is always shown.
bcast-addr Parameter type: <SignedInteger> The broadcast address used for
- a signed integer sending datagrams on the
(logical) interface associated with
the IP address
This element is only shown in
detail mode.
reas-max-size Parameter type: <Transport::IpAdEntReasmMaxSize> The size of the largest IP
- size of the largest reassembled IP datagram datagram which this entity can
- range: [0...65535] re-assemble from incoming IP
fragmented datagrams received
on this interface.
This element is only shown in
64.4 IP Statistics
Command Description
This command displays the IP statistics.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 64.4-2 "IP Statistics" Display parameters
Specific Information
name Type Description
rx-total-datagrams Parameter type: <Counter> The total number of input
- counter datagrams received from
interfaces, including those
received in error.
This element is always shown.
in-hdr-err-data Parameter type: <Counter> The number of input datagrams
- counter discarded due to errors in their IP
headers, including bad
checksums, version number
mismatch, other format errors,
time-to-live exceeded, errors
discovered in processing their IP
options, etc.
This element is always shown.
in-addr-err-data Parameter type: <Counter> The number of input datagrams
- counter discarded because the IP address
in their IP header's destination
field was not a valid address to be
received at this entity.
This element is always shown.
forwarded-datagrams Parameter type: <Counter> The number of input datagrams
- counter for which this entity was not their
final IP destination, as a result of
which an attempt was made to
find a route to forward them to
that final destination.
This element is always shown.
rx-unknown-proto-data Parameter type: <Counter> The number of locally-addressed
Command Description
This command displays the IP routing statistics.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.5-1 "IP Route Status Command" Resource Parameters
Resource Identifier Type Description
(destination) Format: destination IP address of this
- IPv4-address route
Command Output
Table 64.5-2 "IP Route Status Command" Display parameters
Specific Information
name Type Description
routing-mechanism Parameter type: <Transport::ipRouteProto> The routing mechanism via
( other which this route was learned.
| local This element is always shown.
| netmgmt
| icmp
| egp
| ggp
| hello
| rip
| is-is
| es-is
| cisco-igrp
| bbn-spf-igp
| ospf
| bgp )
Possible values:
- other : entry is created via the BOOTP protocol
- local : manually configured
- netmgmt : entry is created via the SNMP protocol
- icmp : obtained via ICMP
Command Description
This command displays the status of net-to-media.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.6-1 "IP Net-to-media Status Command" Resource Parameters
Resource Identifier Type Description
(interface-name) Format: name of the interface
eth1
Possible values:
- eth1 : control interface
network-addr Parameter type: <Ip::V4AddressHex> ip addr corresponding to
Format: media-dependent physical addr
- IPv4-address
Command Output
Table 64.6-2 "IP Net-to-media Status Command" Display parameters
Specific Information
name Type Description
phy-addr Parameter type: <Sys::MacAddr> media-dependent physical addr
- a mac-address (example : 01:02:03:04:05:06) This element is always shown.
- length: 6
type Parameter type: <Transport::ipNetToMediaType> type of mapping
( other This element is always shown.
| invalid
| dynamic
| static )
Possible values:
- other : none of the following
- invalid : invalidating the corresponding entry
- dynamic : dynamic mapping
- static : static mapping
Command Description
This command displays the statistics related to the SNMP protocol.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 64.7-2 "SNMP Protocol Statistics Command" Display parameters
Specific Information
name Type Description
in-pkts Parameter type: <Counter> The total number of received
- counter SNMP packets.
This element is always shown.
out-pkts Parameter type: <Counter> The total number of transmitted
- counter SNMP packets.
This element is always shown.
in-get-requests Parameter type: <Counter> The total number of received
- counter SNMP get requests.
This element is always shown.
out-get-requests Parameter type: <Counter> The total number of transmitted
- counter SNMP get requests.
This element is always shown.
in-get-next-requests Parameter type: <Counter> The total number of received
- counter SNMP get-next requests.
This element is always shown.
out-get-next-requests Parameter type: <Counter> The total number of transmitted
- counter get-next requests .
This element is always shown.
in-set-requests Parameter type: <Counter> The total number of received
- counter SNMP set requests.
This element is always shown.
out-set-requests Parameter type: <Counter> The total number of transmitted
- counter SNMP set requests.
This element is always shown.
in-get-responses Parameter type: <Counter> The total number of received
- counter SNMP get responses.
This element is always shown.
out-get-responses Parameter type: <Counter> The total number of transmitted
Command Description
This command displays the status of the SNMP engine.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 64.8-2 "SNMP Engine Status Command" Display parameters
Specific Information
name Type Description
engine-id Parameter type: <Snmp::EngineID> the unique identifier for the
- SNMP Engine Identifier SNMP engine
- length: 5<=x<=32 This element is always shown.
boot-cnt Parameter type: <Snmp::EngineBoots> the number of times the SNMP
- SNMP Engine Boots engine booted.
- range: [1...2147483647] This element is always shown.
up-time Parameter type: <Snmp::EngineTime> the number of seconds since the
- SNMP Engine Time last boot
- range: [1...2147483647] This element is always shown.
max-message-size Parameter type: <Snmp::MessageSize> the maximum length for an
- SNMP Message Size SNMP message for this engine
- range: [484...2147483647] This element is always shown.
Command Description
This command displays the system statistics.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 64.9-2 "System Status Command" Display parameters
Specific Information
name Type Description
description Parameter type: <Transport::sysDescr> A textual description which
- a printable string include's the full name and
- length: x<=255 version identification of the
system's hardware type, software
operating-system, and
networking software.
This element is always shown.
object-id Parameter type: <Object> The vendor's authoritative
- an object identifier identification of the network
management subsystem
contained in the entity. This value
is allocated within the SMI
enterprises subtree (1.3.6.1.4.1)
and provides an easy and
unambiguous means for
determining `what kind of box' is
being managed.
This element is always shown.
up-time Parameter type: <TimeTicks> The time since the network
- a timeout value management portion of the
- unit: msec system was last re-initialized.
This element is always shown.
services Parameter type: <Transport::SysServices> A value which indicates the set of
- set of services services that this entity primarily
- unit: milisec offers.
- range: [0...127] This element is always shown.
Command Description
This command displays the parameters that keep track of the number of UDP datagrams delivered to the UDP user
and also the number of errors that occurred. Implementation of the UDP group is mandatory for all systems that
implement the UDP.
The total number of UDP datagrams delivered to UDP users is given by the total-delivered-datagrams parameter.
The no-port parameter gives the total number of received UDP datagrams for which there was no application at
the destination port. The err-datagrams parameter gives the number of received UDP datagrams that could not be
delivered for reasons other than the lack of an application at the destination port. The total-datagrams parameter
gives the total number of UDP datagrams sent from this entity.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 64.10-2 "UDP Status Command" Display parameters
Specific Information
name Type Description
tot-deliv-data Parameter type: <Counter> The total number of UDP
- counter datagrams delivered to UDP
users.
This element is always shown.
rx-tot-no-port-data Parameter type: <Counter> The total number of received
- counter UDP datagrams for which there
was no application at the
destination port.
This element is always shown.
rx-err-datagrams Parameter type: <Counter> The number of received UDP
- counter datagrams that could not be
delivered for reasons other than
the lack of an application at the
destination port.
This element is always shown.
tx-total-datagrams Parameter type: <Counter> The total number of UDP
- counter datagrams sent from this entity.
This element is always shown.
Command Description
This command displays the UDP listener table that contains information about this entity's UDP end-points on
which a local application is currently accepting datagrams.
The local IP address for this UDP listener is given by the local-address parameter. In the case of a UDP listener
which is willing to accept datagrams for any IP interface associated with the node, the value 0.0.0.0 is used. The
local port number for this UDP listener is given by local-port parameter.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.11-1 "UDP Listener Status Command" Resource Parameters
Resource Identifier Type Description
(local-address) Format: local IP address for this UDP
- IPv4-address listener
local-port Parameter type: <Transport::UdpLocalPort> local port number for this UDP
Format: listener
- udp local port number
- range: [0...65535]
Command Description
This command displays the Statistics for a collection of Ethernet-like interfaces attached to a particular system.
There will be one row in this table for each Ethernet-like interface in the system. The parameter stats-index gives
an index value that uniquely identifies an interface to an Ethernet-like medium.
The alignment-error parameter gives a count of frames received on a particular interface that are not an integral
number of octets in length and do not pass the FCS check. The count represented by an instance of this object is
incremented when the alignmentError status is returned by the MAC service to the LLC. This counter does not
increment for 8-bit wide group encoding schemes. Discontinuities in the value of this counter can occur at
re-initialization of the management system.
The fcs-error parameter gives a count of frames received on a particular interface that are an integral number of
octets in length, but do not pass the FCS check. This count does not include frames received with frame-too-long or
frame-too-short error.
The single-collision-frame parameter gives a count of successfully transmitted frames on a particular interface for
which transmission is inhibited by exactly one collision. This counter does not increment when the interface is
operating in full-duplex mode. The multiple-collision-frame gives a count of successfully transmitted frames on a
particular interface for which transmission is inhibited by more than one collision. This counter also does not
increment when the interface is operating in full-duplex mode.
The deferred-transmission parameter gives a count of frames for which the first transmission attempt on a
particular interface is delayed because the medium is busy. The count represented by an instance of this object
does not include frames involved in collisions. This counter does not increment when the interface is operating in
full-duplex mode.
The late-collision parameter gives the number of times that a collision is detected on a particular interface later
than one slotTime into the transmission of a packet. A (late) collision included in a count represented by an
instance of this object is also considered as a (generic) collision for purposes of other collision-related statistics.
This counter does not increment when the interface is operating in full-duplex mode.
The excessive-collision parameter gives a count of frames for which transmission on a particular interface fails due
to excessive collisions. This counter does not increment when the interface is operating in full-duplex mode.
The internal-mac-tx-error parameter gives a count of frames for which transmission on a particular interface fails
due to an internal MAC sublayer transmit error. A frame is only counted by an instance of this object if it is not
counted by the corresponding instance of either the late collisions object, the excessive collisions object, or the
carrier sense errors object. The precise meaning of the count represented by an instance of this object is
implementation-specific. In particular, an instance of this object may represent a count of transmission errors on a
particular interface that are not otherwise counted.
The frame-too-long parameter gives a count of frames received on a particular interface that exceed the maximum
permitted frame size. The count represented by an instance of this object is incremented when the frameTooLong
status is returned by the MAC service to the LLC.
The internal-mac-rx-error parameter gives a count of frames for which reception on a particular interface fails due
to an internal MAC sublayer receive error. A frame is only counted by an instance of this object if it is not counted
by the corresponding instance of either the frame toolongs object, the alignment errors object, or the FCS errors
object. The precise meaning of the count represented by an instance of this object is implementation-specific. In
particular, an instance of this object may represent a count of receive errors on a particular interface that are not
otherwise counted.
The duplex-status parameter is the mandatory mode of operation of the MAC entity. 'unknown' indicates that the
mandatory duplex mode could not be determined. Management control of the duplex mode is accomplished through
the MAU MIB. When an interface does not support auto-negotiation, or when auto-negotiation is not enabled, the
duplex mode is controlled using MAU default type. When auto-negotiation is supported and enabled, duplex mode
is controlled using if MAU auto-negotiation advertised bits. In either case, the mandatory operating duplex mode is
reflected both in this object and in ifMauType.
14 ethernet ports are supported.
Port 1 : Internal port used for management
Port 2 : External port used for management
Port 3 : Used for Layer 2 Control Protocol traffic to BRAS
Ports 4-14 : Not used
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.12-1 "Ethernet Dot3 Status Command" Resource Parameters
Resource Identifier Type Description
(stats-index) Format: index of the interface to an
<Eqpt::EthernetId> ethernet-like medium
Field type <Eqpt::EthernetId>
- ehternet id
Command Output
Table 64.12-2 "Ethernet Dot3 Status Command" Display parameters
Specific Information
name Type Description
align-err Parameter type: <Counter> A count of frames received on a
- counter particular interface that are not an
integral number of octets in
length and do not pass the FCS
check.
This element is always shown.
fcs-err Parameter type: <Counter> A count of frames received on a
- counter particular interface that are not an
integral number of octets in
length and do not pass the FCS
check.
This element is always shown.
single-coll-frame Parameter type: <Counter> A count of successfully
- counter transmitted frames on a particular
interface for which transmission
is inhibited by exactly one
collision.
This element is always shown.
multiple-coll-frame Parameter type: <Counter> A count of successfully
Command Description
This command displays the Ethernet MAU parameters.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.13-1 "Interface MAU Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface to which the MAU is
- port to which the MAU is connected connected
- range: [1...2147483647]
index Parameter type: <Transport::Index> identify MAU, among others
Format: connected to same interface
- port to which the MAU is connected
- range: [1...2147483647]
Command Output
Table 64.13-2 "Interface MAU Status Command" Display parameters
Specific Information
name Type Description
type Parameter type: <Ether::MAUType> Specifies the MAU type. If the
( 10baset MAU type is unknown, then
| 100basetxhd unknown Mac type will be
| 100basetxfd returned. If the MAU is a link or
| 100basefxhd fiber type then media-available is
| 100basefxfd equivalent to the link test fail
| 1000basexhd state/low light function. For an
| 1000basexfd AUI or a coax (including
| 1000baselxhd broadband) MAU this indicates
| 1000baselxfd whether or not loopback is
| 1000basesxhd detected on the DI circuit. The
| 1000basesxfd value of this attribute persists
| 1000basethd between packets for MAU types
| 1000basetfd ) AUI, 10BASE5, 10BASE2,
Command Description
This command displays the Ethernet SFP parameters
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.14-1 "SFP status commands" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the sfp
<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 Parameter type: <Transport::Index> identify sfp, among others
Format: connected to same interface
- port to which the MAU is connected
- range: [1...2147483647]
Command Output
Table 64.14-2 "SFP status commands" Display parameters
Specific Information
name Type Description
sfp-type Parameter type: <Transport::SFPType> indicates the type of the sfp
( 1000base-sx This element is always shown.
| 1000base-lx
| 1000base-cx
| 1000base-t
| 100base-sx
Command Description
This command displays the related Dot3 collision status For SHub.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.15-1 "SHub Ethernet Dot3 Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) Format: index of the collision interface
- index of the collision interface
- range: [0...2147483647]
coll-count Parameter type: <Transport::CollisionCount> count of per-frame media
Format: collisions
- count of per-frame media collisions
- range: [0...16]
Command Output
Table 64.15-2 "SHub Ethernet Dot3 Status Command" Display parameters
Specific Information
name Type Description
frequencies Parameter type: <Counter> A count of individual MAC
- counter frames for which the transmission
(successful or otherwise) on a
particular interface occurs after
the frame has experienced exactly
the number of collisions as in
coll-count
This element is always shown.
Command Description
This command displays the Dot3 control status.
The functions-supported parameter give a list of the possible MAC Control functions implemented for this
interface. The rx-unknown-opcodes parameter gives a count of MAC Control frames received on this interface that
contain an opcode that is not supported by this device.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.16-1 "SHub Dot3 Control Status Command" Resource Parameters
Resource Identifier Type Description
(stats-index) Format: index of the interface to an
<Shub::NetworkPort> ethernet-like medium
Field type <Shub::NetworkPort>
- network port on Shub
Command Output
Table 64.16-2 "SHub Dot3 Control Status Command" Display parameters
Specific Information
name Type Description
functions-supported Parameter type: <Ether::Dot3ControlFuncSupport> A list of the possible MAC
- printable string Control functions implemented
for this interface.
This element is always shown.
rx-unknown-opcodes Parameter type: <Counter> A count of MAC Control frames
- counter received on this interface that
contain an opcode that is not
supported by this device.
This element is always shown.
Command Description
This command displays the Dot3 pause parameters.
The stats-index parameter gives a value that uniquely identifies an interface to an Ethernet-like medium. The
operator-mode parameter reflects the PAUSE mode in mandatory in use on this interface, as determined by either
(1) the result of the auto-negotiation function or (2) if auto-negotiation is not enabled or is not implemented for the
active MAU attached to this interface, by the value of pause admin mode.
The in-frames parameter gives a count of MAC Control frames received on this interface with an opcode indicating
the PAUSE operation. This counter does not increment when the interface is operating in half-duplex mode. The
out-frames parameter gives a count of MAC Control frames transmitted on this interface with an opcode indicating
the PAUSE operation. This counter does not increment when the interface is operating in half-duplex mode.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.17-1 "SHub Dot3 Pause Status Command" Resource Parameters
Resource Identifier Type Description
(stats-index) Format: index of the interface to an
<Shub::NetworkPort> ethernet-like medium
Field type <Shub::NetworkPort>
- network port on Shub
Command Output
Table 64.17-2 "SHub Dot3 Pause Status Command" Display parameters
Specific Information
name Type Description
operator-mode Parameter type: <Ether::Dot3PauseOperatorMode> specifies pause mode in use on
( disabled this interface
| enable-xmit This element is always shown.
| enable-rcv
| enable-xmit-rcv )
Possible values:
- disabled : disabled
- enable-xmit : enabled only in transmit direction
- enable-rcv : enabled only in receipt
Command Description
This command displays the statistics for a collection of Ethernet-like interfaces attached to a particular system.
There will be one row in this table for each Ethernet-like interface in the system. The stats-index parameter gives
an index value that uniquely identifies an interface to an Ethernet-like medium.
The alignment-error parameter gives a count of frames received on a particular interface that are not an integral
number of octets in length and do not pass the FCS check. The count represented by an instance of this object is
incremented when the alignmentError status is returned by the MAC service to the LLC. This counter does not
increment for 8-bit wide group encoding schemes. Discontinuities in the value of this counter can occur at
re-initialization of the management system.
The fcs-error parameter gives a count of frames received on a particular interface that are an integral number of
octets in length, but do not pass the FCS check. This count does not include frames received with frame-too-long or
frame-too-short error.
The single-collision-frame parameter gives a count of successfully transmitted frames on a particular interface for
which transmission is inhibited by exactly one collision. This counter does not increment when the interface is
operating in full-duplex mode. The multiple-collision-frame parameter gives a count of successfully transmitted
frames on a particular interface for which transmission is inhibited by more than one collision. This counter also
does not increment when the interface is operating in full-duplex mode.
The deferred-transmission parameter gives a count of frames for which the first transmission attempt on a
particular interface is delayed because the medium is busy. The count represented by an instance of this object
does not include frames involved in collisions. This counter does not increment when the interface is operating in
full-duplex mode.
The late-collision parameter gives the number of times that a collision is detected on a particular interface later
than one slotTime into the transmission of a packet. A (late) collision included in a count represented by an
instance of this object is also considered as a (generic) collision for purposes of other collision-related statistics.
This counter does not increment when the interface is operating in full-duplex mode.
The excessive-collision parameter gives a count of frames for which transmission on a particular interface fails due
to excessive collisions. This counter does not increment when the interface is operating in full-duplex mode.
The internal-mac-tx-error parameter gives a count of frames for which transmission on a particular interface fails
due to an internal MAC sublayer transmit error. A frame is only counted by an instance of this object if it is not
counted by the corresponding instance of either the dot3StatsLateCollisions object, the
dot3StatsExcessiveCollisions object, or the dot3StatsCarrierSenseErrors object. The precise meaning of the count
represented by an instance of this object is implementation-specific. In particular, an instance of this object may
represent a count of transmission errors on a particular interface that are not otherwise counted.
The frame-too-long parameter gives a count of frames received on a particular interface that exceed the maximum
permitted frame size. The count represented by an instance of this object is incremented when the frameTooLong
status is returned by the MAC service to the LLC.
The internal-mac-rx-error parameter gives a count of frames for which reception on a particular interface fails due
to an internal MAC sublayer receive error. A frame is only counted by an instance of this object if it is not counted
by the corresponding instance of either the frame too longs, the alignment errors, or the FCS errors object. The
precise meaning of the count represented by an instance of this object is implementation-specific. In particular, an
instance of this object may represent a count of receive errors on a particular interface that are not otherwise
counted.
The duplex-status parameter is the mandatory mode of operation of the MAC entity. "unknown" indicates that the
mandatory duplex mode could not be determined. Management control of the duplex mode is accomplished through
the MAU MIB. When an interface does not support auto-negotiation, or when auto-negotiation is not enabled, the
duplex mode is controlled using MAU default type. When auto-negotiation is supported and enabled, duplex mode
is controlled using MAU auto-negotiation advertised bits. In either case, the mandatory operating duplex mode is
reflected both in this object and in its MAU type.
The carrier-sense-error parameter gives the number of times that the carrier sense condition was lost or never
asserted when attempting to transmit a frame on a particular interface. The count represented by an instance of
this object is incremented at most once per transmission attempt, even if the carrier sense condition fluctuates
during a transmission attempt. This counter does not increment when the interface is operating in full-duplex mode.
The symbol-error parameter of an interface operating at 100 Mb/s gives the number of times there is an invalid
data symbol when a valid carrier is present. For an interface operating in half-duplex mode at 1000 Mb/s it is the
number of times the receiving media is non-idle (a carrier event) for a period of time equal to or greater than
slotTime, and during which there is at least one occurrence of an event that causes the PHY to indicate 'Data
reception error' or 'carrier extend error' on the GMII. For an interface operating in full-duplex mode at 1000 Mb/s
it gives the number of times the receiving media is non-idle a carrier event) for a period of time equal to or greater
than minimum frame size, and during which there is at least one occurrence of an event that causes the PHY to
indicate 'Data reception error' on the GMII. The count represented by an instance of this object is incremented at
most once per carrier event, even if multiple symbol errors occur during the carrier event. This count does not
increment if a collision is present.
The sqe-test-error parameter gives a count of times that the SQE TEST ERROR message is generated by the PLS
sublayer for a particular interface. This counter does not increment on interfaces operating at speeds greater than
10 Mb/s, or on interfaces operating in full-duplex mode.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.18-1 "SHub Ethernet Dot3 Status Command" Resource Parameters
Resource Identifier Type Description
(stats-index) Format: index of the interface to an
<Shub::NetworkPort> ethernet-like medium
Field type <Shub::NetworkPort>
- network port on Shub
Command Output
Table 64.18-2 "SHub Ethernet Dot3 Status Command" Display parameters
Specific Information
name Type Description
align-err Parameter type: <Counter> A count of frames received on a
- counter particular interface that has
alignment error status returned by
MAC service to the LLC(or other
MAC user).
This element is always shown.
fcs-err Parameter type: <Counter> A count of frames received on a
Command Description
This command displays the L2 filter information.
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.19-1 "SHub L2 Filter Status Command" Resource Parameters
Resource Identifier Type Description
(index-num) Format: L2 Filter rule number
- Filter rule number
- range: [1...65535]
Command Output
Table 64.19-2 "SHub L2 Filter Status Command" Display parameters
Specific Information
name Type Description
protocol-type Parameter type: <Sys::ProtocolType> Specifies the non IP protocol type
- message protocol type to be filtered.
- range: [0,1536...65535] This element is always shown.
dst-mac-addr Parameter type: <Vlan::MacAddr> Specifies the destination MAC
- mac address (aa:bb:cc:a1:02:03) address to be matched with the
- length: 6 packet.
This element is always shown.
src-mac-addr Parameter type: <Vlan::MacAddr> Specifies the source MAC
- mac address (aa:bb:cc:a1:02:03) address to be matched with the
- length: 6 packet.
This element is always shown.
vlan-id Parameter type: <Sys::FilterVlanId> Specifies the vlan id to be
- vlan id filtered.
- range: [0...4094] This element is always shown.
port Parameter type: <Shub::DataPort> Specifies the complete set of
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId> ports over which if the packet
| network : <Shub::NetworkPort> arrives the filter rule will be
| unassigned-link : <Shub::NoExtLink> ) applicable. If the incoming port
Command Description
This command displays the SHub rate information.
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.20-1 "SHub Rate Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: port for which the rate parameters
<Shub::NetworkPort> are displayed
Field type <Shub::NetworkPort>
- network port on Shub
Command Output
Table 64.20-2 "SHub Rate Status Command" Display parameters
Specific Information
name Type Description
dlf-limit Parameter type: <Sys::DlfStatus> Specifies destination lookup
( lookup-enabled failure packet transmission
| lookup-disabled ) control over the interface is
Possible values: enabled or not.
- lookup-enabled : enable this status This element is always shown.
- lookup-disabled : disable this status
bcast-limit Parameter type: <Sys::BcastStatus> Specifies broadcast packet
( bcast-pkt-enabled transmission control over the
| bcast-pkt-disabled ) interface is enabled or not.
Possible values: This element is always shown.
- bcast-pkt-enabled : enable this status
- bcast-pkt-disabled : disable this status
mcast-limit Parameter type: <Sys::McastStatus> Specifies multicast packet
( mcast-pkt-enabled transmission control over the
| mcast-pkt-disabled ) interface is enabled or not.
Possible values: This element is always shown.
- mcast-pkt-enabled : enable this status
Command Description
This command displays the Ethernet MAU parameters.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.21-1 "Interface MAU Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) Format: interface index of the mau
<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 Parameter type: <Transport::Index> identify MAU, among others
Format: connected to same interface
- port to which the MAU is connected
- range: [1...2147483647]
Command Output
Table 64.21-2 "Interface MAU Status Command" Display parameters
Specific Information
name Type Description
type Parameter type: <Ether::MAUType> Specifies the MAU type. If the
( 10baset MAU type is unknown, then
| 100basetxhd unknown Mac type will be
| 100basetxfd returned. If the MAU is a link or
| 100basefxhd fiber type then media-available is
| 100basefxfd equivalent to the link test fail
Command Description
This command displays the statistics for a collection of Ethernet-like interfaces attached to a particular system.
There will be one row in this table for each Ethernet-like interface in the system. The parameter stats-index gives
an index value that uniquely identifies an interface to an Ethernet-like medium.
The alignment-error parameter gives a count of frames received on a particular interface that are not an integral
number of octets in length and do not pass the FCS check. The count represented by an instance of this object is
incremented when the alignmentError status is returned by the MAC service to the LLC. This counter does not
increment for 8-bit wide group encoding schemes. Discontinuities in the value of this counter can occur at
re-initialization of the management system.
The fcs-error parameter gives a count of frames received on a particular interface that are an integral number of
octets in length, but do not pass the FCS check. This count does not include frames received with frame-too-long or
frame-too-short error.
The internal-mac-tx-error parameter gives a count of frames for which transmission on a particular interface fails
due to an internal MAC sublayer transmit error. A frame is only counted by an instance of this object if it is not
counted by the corresponding instance of either the late collisions object, the excessive collisions object, or the
carrier sense errors object. The precise meaning of the count represented by an instance of this object is
implementation-specific. In particular, an instance of this object may represent a count of transmission errors on a
particular interface that are not otherwise counted.
The internal-mac-rx-error parameter gives a count of frames for which reception on a particular interface fails due
to an internal MAC sublayer receive error. A frame is only counted by an instance of this object if it is not counted
by the corresponding instance of either the frame toolongs object, the alignment errors object, or the FCS errors
object. The precise meaning of the count represented by an instance of this object is implementation-specific. In
particular, an instance of this object may represent a count of receive errors on a particular interface that are not
otherwise counted.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 64.22-1 "Ethernet Lt Dot3 Status Command" Resource Parameters
Resource Identifier Type Description
(stats-index) Format: index of the interface to an
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / ethernet-like medium
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Command Output
Table 64.22-2 "Ethernet Lt Dot3 Status Command" Display parameters
Specific Information
name Type Description
align-err Parameter type: <Counter> A count of frames received on a
- counter particular interface that are not an
integral number of octets in
length and do not pass the FCS
check.
This element is always shown.
fcs-err Parameter type: <Counter> A count of frames received on a
- counter particular interface that are not an
integral number of octets in
length and do not pass the FCS
check.
This element is always shown.
internal-mac-tx-err Parameter type: <Counter> A count of frames for which
- counter transmission on a particular
interface fails due to an internal
MAC sublayer transmit error.
This element is only shown in
detail mode.
internal-mac-rx-err Parameter type: <Counter> A count of frames for which
- counter reception on a particular interface
fails due to an internal MAC
sublayer receive error.
This element is only shown in
detail mode.
Description
This chapter gives an overview of nodes that are handled by "DHCP Relay Status Commands".
Command Tree
----show
----dhcp-relay
----port
- (port-interface)
----bridgeport
- (port-interface)
----shub
----vrf-agent-stats
- (vrf)
Command Description
This command allows the operator to view the DHCP relay port counters.
User Level
The command can be accessed by operators with dhcp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 65.2-1 "DHCP Relay Port Statistics" Resource Parameters
Resource Identifier Type Description
(port-interface) Format: port number associated with
( atm-port : <Eqpt::RackId> / <Eqpt::ShelfId> / bridge port
<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> /
<Eqpt::PortId> )
Possible values:
- atm-port : atm port
- bridge-port : bridge port
Command Output
Table 65.2-2 "DHCP Relay Port Statistics" Display parameters
Specific Information
name Type Description
receive Parameter type: <Counter> number of upstream dhcp packets
- counter This element is always shown.
transmit Parameter type: <Counter> number of downstream dhcp
- counter messages
This element is always shown.
large-msg-drop Parameter type: <Counter> number of discarded upstream
- counter dhcp packets
This element is only shown in
detail mode.
untrust-agent-drop Parameter type: <Counter> number of discarded upstream
- counter dhcp packets untrusted
This element is only shown in
detail mode.
untrust-option-82 Parameter type: <Counter> nbr of discarded dhcp pkts with
- counter option 82 untrusted
This element is only shown in
detail mode.
long-option-82 Parameter type: <Counter> nbr of discarded upstream dhcp
- counter pkts without option 82
This element is only shown in
detail mode.
error-summary Parameter type: <Counter> Error summary for a port
- counter This element is always shown.
Command Description
Obsolete command, replaced by show dhcp-relay port.
This command allows the operator to view the DHCP relay port counters.
User Level
The command can be accessed by operators with dhcp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 65.3-1 "DHCP Relay Port Statistics" Resource Parameters
Resource Identifier Type Description
(port-interface) Format: port number associated with
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / bridge port
<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
Command Output
Table 65.3-2 "DHCP Relay Port Statistics" Display parameters
Specific Information
name Type Description
receive Parameter type: <Counter> number of upstream dhcp packets
Command Description
This command displays DHCP relay agent statistics for each VRF in the Shub.
User Level
The command can be accessed by operators with dhcp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 65.4-1 "SHub DHCP Relay Statistics" Resource Parameters
Resource Identifier Type Description
(vrf) Format: vrf for which the agent is running
- the vrf id which uniquely identify a vrf
- range: [0...127]
Command Output
Table 65.4-2 "SHub DHCP Relay Statistics" Display parameters
Specific Information
name Type Description
fwd-upstream Parameter type: <Counter> number of forwarded upstream
- counter dhcp packets
This element is always shown.
fwd-downstream Parameter type: <Counter> number of forwarded
- counter downstream dhcp packets
This element is always shown.
rx-upstream Parameter type: <Counter> number of received upstream
- counter dhcp packets
This element is always shown.
rx-downstream Parameter type: <Counter> number of received downstream
- counter dhcp packets
This element is always shown.
errors Parameter type: <Counter> number of erroneous dhcp
- counter packets discarded
This element is always shown.
Description
This chapter gives an overview of nodes that are handled by "Multicast Status Commands".
Command Tree
----show
----mcast
----active-groups
- (port)
- vlan-id
- mcast-grp-addr
- mcast-src-addr
----grp-membership
- (mcast-grp-addr)
- vlan-id
- mcast-src-addr
- port
----shub
----igs-vlan-grp
- (vlan-id)
- mcast-addr
- port
----active-streams
Command Description
This command shows per user interface the list of active multicast streams.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 66.2-1 "Multicast Active Groups Status 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> )
Possible values:
- vlan : vlan port
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 Output
Table 66.2-2 "Multicast Active Groups Status Command" Display parameters
Specific Information
name Type Description
state Parameter type: <Igmp::ActualState> The actual state of the multicast
( full-view stream
| pre-view This element is always shown.
| black-out )
Possible values:
- full-view : full view of the stream
- pre-view : preview of the stream
- black-out : no stream is viewed
curr-previewed-nbr Parameter type: <Igmp::PreviewNumber> number of pre-view sessions that
short name: prev-nbr - number of pre-view sessions already been viewed have already been viewed
- range: [0...1000] This element is always shown.
Command Description
This command shows per multicast stream the list of user interfaces to which the system is currently requested to
forward this stream.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 66.3-1 "Multicast Group Membership Status Command" Resource Parameters
Resource Identifier Type Description
(mcast-grp-addr) Format: multicast group 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]
mcast-src-addr Parameter type: <Ip::V4Address> the multicast group source
Format: address
- IPv4-address
port Parameter type: <Igmp::IgmpIfIndex> identifies a user interface
Format: receiving a multicast stream
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<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> /
Command Output
Table 66.3-2 "Multicast Group Membership Status Command" Display parameters
Specific Information
name Type Description
state Parameter type: <Igmp::GroupAddr2UserItfActualstate> the actual state of the multicast
( full-view stream
| pre-view This element is always shown.
| black-out )
Possible values:
- full-view : full view of the stream
- pre-view : preview of the stream
- black-out : no stream is viewed
Command Description
This command displays the VLAN list for the MAC multicast group.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> show mcast shub igs-vlan-grp [ (vlan-id) [ mcast-addr <Igmp::MulticastAddress> ] [ port <Shub::DataPort> ] ]
Command Parameters
Table 66.4-1 "Dynamic and Static-Dynamic Multicast VLAN FWD Port Status Command"
Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
mcast-addr Parameter type: <Igmp::MulticastAddress> multicast address
Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
port Parameter type: <Shub::DataPort> outbound port
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| unassigned-link : <Shub::NoExtLink> )
Possible values:
- lt : line board
- network : network port
- unassigned-link : unassigned external link
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
Field type <Shub::NoExtLink>
- unassigned external SFP port
Command Output
Table 66.4-2 "Dynamic and Static-Dynamic Multicast VLAN FWD Port Status Command" Display
parameters
Specific Information
name Type Description
status Parameter type: <Vlan::VlanMcastConfigStatus> The status of the igs-vlan
( dynamic multicast group
| static-dynamic ) This element is always shown.
Possible values:
- dynamic : dynamic entry
- static-dynamic : static dynamic entry
Command Description
This command displays the data for SHub multicast.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 66.5-2 "SHub Multicast Status Command" Display parameters
Specific Information
name Type Description
count Parameter type: <Vlan::ActiveNrMcastEntries> number of active multicast
- a signed integer entries.
This element is always shown.
Description
This chapter gives an overview of nodes that are handled by "CPE Management Status Commands".
Command Tree
----show
----cpe-management
----snmpproxy-statistics
- (address)
----ipproxy-statistics
- (dslport)
Command Description
This chapter shows the global statistics and the statistics per CPE manager
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 67.2-1 "CPE Management Show Command" Resource Parameters
Resource Identifier Type Description
(address) Format: the IP address of a CPE manager
- IP address of CPE Management Station
Command Output
Table 67.2-2 "CPE Management Show Command" Display parameters
Common Information:cpeproxy
name Type Description
rx-drop-msgs-cpe Parameter type: <Counter> the number of discarded msgs
- counter received from CPEs
This element is only shown in
detail mode.
Specific Information
name Type Description
rx-msgs Parameter type: <Counter> the number of received msgs
- counter from a CPE manager
This element is always shown.
tx-msgs Parameter type: <Counter> the number of msgs sent to a CPE
- counter manager
This element is always shown.
rx-drop-msgs Parameter type: <Counter> the number of discarded msgs
- counter received from a CPE manager
This element is always shown.
Command Description
This command shows the statistics per ipproxy session
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 67.3-1 "CPE IPProxy Management Statistics Show 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
Command Output
Table 67.3-2 "CPE IPProxy Management Statistics Show Command" Display parameters
Common Information:cpeproxy
name Type Description
rx-drop-pkts-session Parameter type: <Counter> number of discarded packets
- counter received from CPE Management
Module or CPEs
This element is only shown in
detail mode.
Specific Information
Description
This chapter gives an overview of nodes that are handled by "Session Status Commands".
Command Tree
----show
----session
- (id)
Command Description
This command displays the status of all sessions.
User Level
The command can be accessed and executed by an operator with admin privilege.
Command Syntax
The command has the following syntax:
Command Parameters
Table 68.2-1 "Session Status Command" Resource Parameters
Resource Identifier Type Description
(id) Format: the session number
- the session number
- range: [1...12]
Command Output
Table 68.2-2 "Session Status Command" Display parameters
Specific Information
name Type Description
operator Parameter type: <Sec::OperatorName> the name of the operator that is
- the name of an operator actually using the session
- range: [a-z0-9] This element is always shown.
- length: 1<=x<=11
from Parameter type: <Sec::LoginAddress> the ip-address from where the
- the address from where the operator logged in user is logged in
- length: x<=21 This element is always shown.
type Parameter type: <Sec::TerminalType> the type of connection use.
( craft Network means that any
| telnet supported connection type over ip
| unused is possible.
| test This element is always shown.
| ssh )
Possible values:
- craft : craft terminal
- telnet : telnet terminal
- unused : unused terminal
- test : test terminal
Description
This chapter gives an overview of nodes that are handled by "PPPoX-Relay Status Commands".
Command Tree
----show
----pppox-relay
----cross-connect
----statistics
----engine
- (vlan-id)
----client-port
- (client-port)
----monitor-statistics
----engine
- (vlan-id)
----client-port
- (client-port)
----session
----engine
- (vlan-id)
----client-port
- (client-port)
Command Description
This command displays the statistics for a particular VLAN ID.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 69.2-1 "PPPoX CC Engine Statistics" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: engine identification
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
Command Output
Table 69.2-2 "PPPoX CC Engine Statistics" Display parameters
Specific Information
name Type Description
engine-name Parameter type: <PPPoX::EngineName> name to identify the
- Engine Name engine/service
- length: 1<=x<=32 This element is always shown.
in-ctrl-frm Parameter type: <Counter> number of ingress control
- counter messages
This element is always shown.
out-ctrl-frm Parameter type: <Counter> number of egress control
Command Description
This command displays the statistics of a client port.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 69.3-1 "PPPoX CC Client Port Statistics" Resource Parameters
Resource Identifier Type Description
(client-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> )
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 Output
Table 69.3-2 "PPPoX CC Client Port Statistics" Display parameters
Specific Information
name Type Description
in-ctrl-frm Parameter type: <Counter> number of ingress control
- counter messages
This element is always shown.
out-ctrl-frm Parameter type: <Counter> number of egress control
Command Description
This command displays the engine monitor statistics for a particular VLAN ID and lists the statistics of a
configured engine with a monitor enabled.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 69.4-1 "PPPoX CC Engine Monitor Statistics" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: engine identification
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
Command Output
Table 69.4-2 "PPPoX CC Engine Monitor Statistics" Display parameters
Specific Information
name Type Description
generic-err-cnt Parameter type: <Counter> nbr of discovery msgs that
- counter carried the Generic Error tag
This element is always shown.
inv-serv-name Parameter type: <Counter> nbr of PAD-S msgs containing
- counter Service-Name-Error tag
This element is always shown.
Command Description
This command shows the client port monitor statistics and lists the statistics of a configured client port with a
monitor enabled.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 69.5-1 "PPPoX CC Client Port Monitor Statistics" Resource Parameters
Resource Identifier Type Description
(client-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> )
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 Output
Table 69.5-2 "PPPoX CC Client Port Monitor Statistics" Display parameters
Specific Information
name Type Description
unexp-ctrl-msg Parameter type: <Counter> number of unexpected control
- counter messages discarded
This element is always shown.
unexp-data-pkts Parameter type: <Counter> number of discarded data packets
Command Description
This command displays session data for the engine.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 69.6-1 "PPPoX CC Session Engine Status Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: engine identification
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
Command Output
Table 69.6-2 "PPPoX CC Session Engine Status Command" Display parameters
Specific Information
name Type Description
server-mac-addr Parameter type: <Vlan::MacAddr> mac-addr of the PPPoE Server of
- mac address (aa:bb:cc:a1:02:03) this PPP cross-connection
- length: 6 This element is always shown.
ext-session-id Parameter type: <SignedInteger> PPPoE session id of this PPP
- a signed integer cross-connection
This element is always shown.
client-port Parameter type: <Itf::AtmPvc> Index to which the PPPoE client
Command Description
This command displays session data for the client port.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 69.7-1 "PPPoX CC Session Client Port Status Command" Resource Parameters
Resource Identifier Type Description
(client-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> )
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 Output
Table 69.7-2 "PPPoX CC Session Client Port Status Command" Display parameters
Specific Information
name Type Description
server-mac-addr Parameter type: <Vlan::MacAddr> mac-addr of the PPPoE server of
Description
This chapter gives an overview of nodes that are handled by "OSPF Status Commands".
Command Tree
----show
----ospf
----area
- (area-id)
----link-state-adv
----link-type
- (link-type)
- area-id
- router-id
- itf-ip-addr
----asbr-external
- (itf-ip-addr)
- router-id
----interface
- (ip-addr)
----neighbour
- (ip-address)
----routing-table
- (destination)
- mask
- peer
----statistics
----status
Command Description
This command displays the values of the area identifier, spf-runs, number of link state advertisements in the
link-state database, and link-state-checksum.
This command also displays the number of border routers in the area, number of the AS border router, number of
OSPF interfaces in the area, total number of interfaces in the area, total number of networks in the area, and
number of NSSA translator events in the area.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 70.2-1 "OSPF Area Status Command" Resource Parameters
Resource Identifier Type Description
(area-id) Format: ospf area identifier
- IPv4-address
Command Output
Table 70.2-2 "OSPF Area Status Command" Display parameters
Specific Information
name Type Description
spf-runs Parameter type: <Counter> nbr of times the intra-area route
- counter table has been calculated
This element is always shown.
nbr-lsa Parameter type: <Gauge> nbr of lsa in this area's link-state
- gauge database
This element is always shown.
lsa-checksum Parameter type: <SignedInteger> checksums contained in this
- a signed integer area's link-state database
This element is always shown.
area-bdr-rtrs Parameter type: <Gauge> nbr of area border routers in this
- gauge area
This element is only shown in
detail mode.
as-bdr-rtrs Parameter type: <Gauge> nbr of autonomous sys border
- gauge routers in this area
Command Description
This command displays the general information of OSPF link state advertisements based on the interface type.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
> show ospf link-state-adv link-type [ (link-type) [ area-id <Ip::V4Address> ] [ router-id <Ip::V4Address> ] [
itf-ip-addr <Ip::V4Address> ] ]
Command Parameters
Table 70.3-1 "OSPF LSA Status Command" Resource Parameters
Resource Identifier Type Description
(link-type) Format: filter for the ospf database
( router
| network
| summary
| asbr-summary
| nssa )
Possible values:
- router : router link
- network : network link
- summary : summary link
- asbr-summary : assummary link
- nssa : nssa external link
area-id Parameter type: <Ip::V4Address> ospf area identifier
Format:
- IPv4-address
router-id Parameter type: <Ip::V4Address> originating router identifier
Format:
- IPv4-address
itf-ip-addr Parameter type: <Ip::V4Address> link state identifier
Format:
- IPv4-address
Command Output
Table 70.3-2 "OSPF LSA Status Command" Display parameters
Specific Information
Command Description
This command displays the values of the link state database of the OSPF process.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 70.4-1 "OSPF External Link State Status Command" Resource Parameters
Resource Identifier Type Description
(itf-ip-addr) Format: external link state identifier
- IPv4-address
router-id Parameter type: <Ip::V4Address> originating router identifier, a 32
Format: bit number
- IPv4-address
Command Output
Table 70.4-2 "OSPF External Link State Status Command" Display parameters
Specific Information
name Type Description
age Parameter type: <Ospf::LsAge> age of the link state
- age of the link state advertisement advertisement in seconds
- unit: sec This element is always shown.
- range: [0...3600]
sequence Parameter type: <SignedInteger> identifies the old and recent
- a signed integer advertisements
This element is only shown in
detail mode.
checksum Parameter type: <SignedInteger> checksum of the complete
- a signed integer contents of the advertisement
This element is only shown in
detail mode.
advertisement Parameter type: <Ospf::ExtAdvtsmnt> entire link state advertisement,
- entire link state advertisement of external links including its header
- length: 1<=x<=36 This element is only shown in
detail mode.
Command Description
This command displays the values of the OSPF interface.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 70.5-1 "OSPF Interface Status Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: ip address of the interface
- IPv4-address
Command Output
Table 70.5-2 "OSPF Interface Status Command" Display parameters
Specific Information
name Type Description
oper-status Parameter type: <Ospf::OperStatus> operational status of the interface
( operup This element is always shown.
| operdown
| loopback
| unloop )
Possible values:
- operup : operational status up
- operdown : operational status down
- loopback : operational status loopback
- unloop : operational status unloop
designated-router Parameter type: <Ip::V4Address> ip address of the designated
- IPv4-address router
This element is always shown.
bkp-designated-router Parameter type: <Ip::V4Address> ip address of the backup
- IPv4-address designated router
This element is only shown in
detail mode.
events Parameter type: <Counter> nbr of times this OSPF interface
- counter has changed its state
Command Description
This command displays OSPF neighbor information.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 70.6-1 "OSPF Neighbor Status Command" Resource Parameters
Resource Identifier Type Description
(ip-address) Format: neighbour ip
- IPv4-address
Command Output
Table 70.6-2 "OSPF Neighbor Status Command" Display parameters
Specific Information
name Type Description
router-id Parameter type: <Ip::V4Address> a 32-bit integer identifying the
- IPv4-address neighboring router
This element is always shown.
state Parameter type: <Ospf::NbrState> state of the relationship with this
( down neighbor
| attempt This element is always shown.
| init
| two-way
| exchange-start
| exchange
| loading
| full )
Possible values:
- down : down
- attempt : attempt
- init : init
- two-way : two-way
- exchange-start : exchange-start
- exchange : exchange
Command Description
This command displays information about a single route.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 70.7-1 "OSPF Routing Status Command" Resource Parameters
Resource Identifier Type Description
(destination) Format: ip address of the route
- IPv4-address
mask Parameter type: <Ip::V4Address> ip address mask of the route
Format:
- IPv4-address
peer Parameter type: <Ip::V4Address> ip next hop of the route
Format:
- IPv4-address
Command Output
Table 70.7-2 "OSPF Routing Status Command" Display parameters
Specific Information
name Type Description
interface Parameter type: <SignedInteger> interface index associated with
- a signed integer the route
This element is always shown.
area-id Parameter type: <Ip::V4Address> area id associated with the route
- IPv4-address This element is always shown.
metric Parameter type: <Ospf::RouteCost> type 1 metrics expressed in the
- Type 1 external metrics same units as OSPF itf cost
- length: x<=16777215 This element is always shown.
route-type Parameter type: <Ospf::RouteType> type of the route
( intraarea This element is only shown in
| interarea detail mode.
| type1-external
| type2-external )
Command Description
This command displays various statistics, counts, and external link-state advertisement counts.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 70.8-2 "OSPF Statistics" Display parameters
Specific Information
name Type Description
nbr-ext-lsa Parameter type: <Gauge> nbr of ext link-state
- gauge advertisements in the link-state
database
This element is always shown.
tx-new-lsas Parameter type: <Counter> nbr of new link-state
- counter advertisements that have been
originated
This element is always shown.
rx-new-lsas Parameter type: <Counter> nbr of link-state advertisements
- counter received to be new instantiations
This element is always shown.
tx-pkts Parameter type: <Counter> total no. of packets transmitted
- counter This element is always shown.
rx-pkts Parameter type: <Counter> total no. of packets received
- counter This element is always shown.
discard-pkts Parameter type: <Counter> total no. of packets discarded
- counter This element is always shown.
Command Description
This command displays the OSPF parameter status.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 70.9-2 "OSPF Parameter Status Command" Display parameters
Specific Information
name Type Description
router-id Parameter type: <Ip::V4Address> a 32-bit integer identifying the
- IPv4-address router in the Autonomous Sys
This element is always shown.
version Parameter type: <Ospf::Version> current version number of the
version2 OSPF protocol is 2
Possible values: This element is always shown.
- version2 : version number
area-bdr-rtr-stat Parameter type: <Ospf::AreaRtrStat> indicates whether the router is an
( area-bdr-rtr-stat area border router
| no-area-bdr-rtr-stat ) This element is always shown.
Possible values:
- area-bdr-rtr-stat : set area-bdr-rtr-stat value true
- no-area-bdr-rtr-stat : set area-bdr-rtr-stat value false
as-bdr-rtr-stat Parameter type: <Ospf::AsRtrStat> indicates whether the router is an
( as-bdr-rtr-stat Autonomous Sys border router
| no-as-bdr-rtr-stat ) This element is always shown.
Possible values:
- as-bdr-rtr-stat : set as-bdr-rtr-stat value true
- no-as-bdr-rtr-stat : set as-bdr-rtr-stat value false
ext-lsa-chcksm Parameter type: <SignedInteger> a 32-bit LS checksums of the
- a signed integer external link-state advertisements
This element is always shown.
overflow-state Parameter type: <Ospf::OvflwState> indicates the router overflow state
( overflow-state This element is always shown.
| no-overflow-state )
Possible values:
- overflow-state : set overflow-state value true
- no-overflow-state : set overflow-state value false
Description
This chapter gives an overview of nodes that are handled by "RIP Status Commands".
Command Tree
----show
----rip
----statistics
- (ip-addr)
----peer
- (peer-ip-addr)
----routing-table
- (destination)
- mask
- peer
----global
Command Description
This command displays the RIP interface status.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 71.2-1 "RIP Statistics Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: show statistics of a specific IP
- IPv4-address interface
Command Output
Table 71.2-2 "RIP Statistics Command" Display parameters
Specific Information
name Type Description
periodical-update Parameter type: <Counter> total nbr of periodic RIP updates
- counter sent on this interface
This element is always shown.
rx-bad-pkts Parameter type: <Counter> number of RIP response pkts
- counter which were discarded
This element is always shown.
rx-bad-routes Parameter type: <Counter> number of routes in valid RIP
- counter packets which were ignored
This element is always shown.
updates-sent Parameter type: <Counter> number of triggered RIP updates
- counter sent on this interface
This element is only shown in
detail mode.
Command Description
This command displays information about a single routing peer.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 71.3-1 "RIP Peer Status Command" Resource Parameters
Resource Identifier Type Description
(peer-ip-addr) Format: IP identifying the remote peer
- IPv4-address
Command Output
Table 71.3-2 "RIP Peer Status Command" Display parameters
Specific Information
name Type Description
peer-version Parameter type: <SignedInteger> version number in the header of
- a signed integer the last RIP packet
This element is always shown.
last-updt-rx Parameter type: <TimeTicks> most recent RIP update received
- a timeout value from the system
- unit: msec This element is always shown.
rx-bad-pkts Parameter type: <Counter> number of RIP response pkts
- counter discarded as invalid
This element is always shown.
rx-bad-routes Parameter type: <Counter> number of routes that were
- counter ignored
This element is always shown.
Command Description
This command displays a list of routes in the local routing table.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 71.4-1 "RIP Routing Status Command" Resource Parameters
Resource Identifier Type Description
(destination) Format: IP address of the destination
- IPv4-address network
mask Parameter type: <Ip::V4Address> mask for the destination network
Format:
- IPv4-address
peer Parameter type: <Ip::V4Address> nexthop address where datagrams
Format: are to be forwarded
- IPv4-address
Command Output
Table 71.4-2 "RIP Routing Status Command" Display parameters
Specific Information
name Type Description
gateway Parameter type: <Ip::V4Address> gateway address where
- IPv4-address datagrams are to be forwarded
This element is always shown.
vlan-id Parameter type: <Itf::ShubVlanAlias> vlan through which the route is
- an alias for a vlan learnt
This element is always shown.
metric Parameter type: <SignedInteger> reachability cost for the
- a signed integer destination
This element is always shown.
change-time Parameter type: <SignedInteger> time when the route is installed
- a signed integer This element is only shown in
detail mode.
valid Parameter type: <SignedInteger> row status for particular route
Command Description
This command displays information regarding the sum of all the interface-related counters.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 71.5-2 "RIP Global Status Command" Display parameters
Specific Information
name Type Description
periodic-updates Parameter type: <Counter> total nbr of periodic RIP updates
- counter sent from this router
This element is always shown.
dropped-pkts Parameter type: <Counter> number of packets dropped
- counter This element is always shown.
route-change Parameter type: <Counter> number of routes changed
- counter This element is always shown.
global-queries Parameter type: <Counter> number of responses sent to RIP
- counter queries
This element is always shown.
Description
This chapter gives an overview of nodes that are handled by "Cluster Status Commands".
Command Tree
----show
----cluster
----counter
- (counter)
----neighbour
- (port-id)
----device
- (device)
----connect
- (device-id)
- port-id
Command Description
This command shows the counter of the port.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 72.2-1 "Cluster Port Counter Status Command" Resource Parameters
Resource Identifier Type Description
(counter) Format: the interface index
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Command Output
Table 72.2-2 "Cluster Port Counter Status Command" Display parameters
Specific Information
name Type Description
disc-in Parameter type: <Counter> The number of received
- counter neighbour discovery packets on
the port
This element is always shown.
disc-out Parameter type: <Counter> The number of transmitted
- counter neighbour discovery packets on
the port.
This element is always shown.
disc-discard Parameter type: <Counter> The number of discard neighbour
- counter discovery packets due to invalid
packets on the port.
This element is always shown.
top-req-in Parameter type: <Counter> The number of received topology
- counter request packets on the port.
This element is always shown.
top-req-out Parameter type: <Counter> The number of transmitted
- counter topology request packets on the
Command Description
This command shows the neighbor info.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 72.3-1 "Neighbor Device Status Command" Resource Parameters
Resource Identifier Type Description
(port-id) Format: interface index
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Command Output
Table 72.3-2 "Neighbor Device Status Command" Display parameters
Specific Information
name Type Description
device Parameter type: <Cluster::MacAddr> The neighbor device MAC
- binary string of 06 bytes address on the port.
- length: 6 This element is always shown.
port Parameter type: <Shub::NetworkPort> The port id of neighbor node
<Shub::NetworkPort> connected on the port.
Field type <Shub::NetworkPort> This element is always shown.
- network port on Shub
host Parameter type: <Cluster::HostName> The host name of neighbour node
- the cluster namer on the port.
- length: x<=255 This element is only shown in
detail mode.
description Parameter type: <Cluster::neighbourSystemDescription> The system description of
- a printable string neighbor node on the port.
- length: x<=255 This element is only shown in
detail mode.
stp Parameter type: <Cluster::neighbourPortSTPState> The stp state of the current port.
( disabled This element is always shown.
Command Description
This command shows the information of nodes within the connected environment.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 72.4-1 "Topology Device Status Command" Resource Parameters
Resource Identifier Type Description
(device) Format: device id
- binary string of 06 bytes
- length: 6
Command Output
Table 72.4-2 "Topology Device Status Command" Display parameters
Specific Information
name Type Description
host Parameter type: <Cluster::topologyHostName> The host name of connected
- a printable string node.
- length: x<=255 This element is only shown in
detail mode.
description Parameter type: <Cluster::topoloygSystemDescription> The ystem description of
- a printable string connected node.
- length: x<=255 This element is only shown in
detail mode.
cluster-name Parameter type: <Cluster::topologyClusterName> The cluster name of connected
- a printable string node.
- length: x<=255 This element is only shown in
detail mode.
cluster-role Parameter type: <Cluster::topologyClusterRole> The role of connected node.
( command This element is always shown.
| member
| backup
| candidate )
Possible values:
Command Description
This command shows the connected information of nodes within the connected environment in which the command
node is.
User Level
The command can be accessed by operators with equipment privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 72.5-1 "Topology Connect Status Command" Resource Parameters
Resource Identifier Type Description
(device-id) Format: native device id
- binary string of 06 bytes
- length: 6
port-id Parameter type: <Shub::NetworkPort> native port id
Format:
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Command Output
Table 72.5-2 "Topology Connect Status Command" Display parameters
Specific Information
name Type Description
peer-device Parameter type: <Cluster::peerDeviceID> The device MAC address of
- binary string of 06 bytes connected node with the native
- length: 6 node.
This element is always shown.
peer-port Parameter type: <Shub::NetworkPort> The device MAC address of
<Shub::NetworkPort> connected node with the native
Field type <Shub::NetworkPort> node.
- network port on Shub This element is always shown.
stp-state Parameter type: <Cluster::portSTPstate> The STP state of port.
( disabled This element is always shown.
| blocking
| listening
Description
This chapter gives an overview of nodes that are handled by "SHDSL Status Commands".
Command Tree
----show
----shdsl
----inventory
- (if-index)
- unit-id
----span-status
- (if-index)
----unit-status
- (if-index)
- unit-id
----segment-status
- (if-index)
- unit-id
- side
- wire-pair
----segment-counters
----current-15min
- (if-index)
- unit-id
- side
- wire-pair
----current-1day
- (if-index)
- unit-id
- side
- wire-pair
----previous-15min
- (if-index)
- unit-id
- side
- wire-pair
- int-no
----previous-1day
- (if-index)
- unit-id
- side
- wire-pair
- int-no
----span-counters
----current-15min
- (if-index)
----current-1day
- (if-index)
----previous-15min
- (if-index)
- interval-number
----previous-1day
- (if-index)
- interval-number
Command Description
This command displays the SHDSL inventory status.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 73.2-1 "SHDSL Inventory Status 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 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
Command Output
Table 73.2-2 "SHDSL Inventory Status Command" Display parameters
Specific Information
name Type Description
version Parameter type: <Shdsl::UnitShdslStdVersion> the SHDSL standard version for
- an SHDSL unit standard version this unit
- range: [0...255] This element is always shown.
Command Description
This command displays the SHDSL span status.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 73.3-1 "SHDSL Span Status 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
Command Output
Table 73.3-2 "SHDSL Span Status Command" Display parameters
Specific Information
name Type Description
state Parameter type: <Shdsl::SpanState> the overall state of this SHDSL
( unknown span
| unequipped This element is always shown.
| faulty
| idle
| startup
| active )
Possible values:
- unknown : the state is unknown
- unequipped : the state is unequipped
- faulty : the state is faulty
Command Description
This command displays the SHDSL unit status.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 73.4-1 "SHDSL Unit Status 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 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
Command Output
Table 73.4-2 "SHDSL Unit Status Command" Display parameters
Specific Information
name Type Description
dc-pow Parameter type: <Shdsl::UnitDCPowering> the powering mode of this
( local-pow SHDSL span
| span-pow ) This element is always shown.
Command Description
This command displays the status of individual segment end points in an SHDSL span.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show shdsl segment-status [ (if-index) [ unit-id <Shdsl::UnitId> ] [ side <Shdsl::SegmentSide> ] [ wire-pair
<Shdsl::SegmentTerminationWirePair> ] ]
Command Parameters
Table 73.5-1 "SHDSL Segment Status 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 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
side Parameter type: <Shdsl::SegmentSide> the particular side of an SHDSL
Format: unit in an SHDSL segment
( network
| customer )
Possible values:
- network : the network side
- customer : the customer side
wire-pair Parameter type: <Shdsl::SegmentTerminationWirePair> the particular wire pair of an
Format: SHDSL segment
( one
Command Output
Table 73.5-2 "SHDSL Segment Status Command" Display parameters
Specific Information
name Type Description
seg-st-losw Parameter type: <Shdsl::LOSW> loss of word
( no-losw This element is only shown in
| losw ) detail mode.
Possible values:
- no-losw : no loss of word
- losw : loss of word
seg-st-lp-attn Parameter type: <Shdsl::LpAttn> loop attenuation alarm
( no-lp-attn This element is only shown in
| lp-attn ) detail mode.
Possible values:
- no-lp-attn : no loop attenuation
- lp-attn : loop attenuation
seg-st-snr Parameter type: <Shdsl::SNR> snr margin alarm
( no-snr This element is only shown in
| snr ) detail mode.
Possible values:
- no-snr : no snr margin alarm
- snr : snr margin alarm
seg-st-dc Parameter type: <Shdsl::DC> dc continuity fault
( no-dc This element is only shown in
| dc ) detail mode.
Possible values:
- no-dc : no dc continuity fault
- dc : dc continuity fault
seg-st-dev Parameter type: <Shdsl::Dev> device fault
( no-dev This element is only shown in
| dev ) detail mode.
Possible values:
- no-dev : no device fault
- dev : device fault
seg-st-conf Parameter type: <Shdsl::Conf> configuration error
( no-conf This element is only shown in
| conf ) detail mode.
Possible values:
- no-conf : configuration error
- conf : configuration error
seg-st-lp-act Parameter type: <Shdsl::LpAct> loopback active
( no-lp-act This element is only shown in
| lp-act ) detail mode.
Possible values:
- no-lp-act : loopback active
- lp-act : loopback active
Command Description
This command displays the operational data of individual segment end points in an SHDSL span.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show shdsl segment-counters current-15min [ (if-index) [ unit-id <Shdsl::UnitId> ] [ side <Shdsl::SegmentSide>
] [ wire-pair <Shdsl::SegmentTerminationWirePair> ] ]
Command Parameters
Table 73.6-1 "SHDSL Segment Counters Current Interval Status 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 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
side Parameter type: <Shdsl::SegmentSide> the particular side of an SHDSL
Format: unit in an SHDSL segment
( network
| customer )
Possible values:
- network : the network side
- customer : the customer side
Command Output
Table 73.6-2 "SHDSL Segment Counters Current Interval Status Command" Display parameters
Specific Information
name Type Description
time-el Parameter type: the elapsed seconds in the current
<Shdsl::SegmentTermCurr15MTimeElapsed> 15-minute interval
- an elapsed seconds in the current 15-minute interval This element is always shown.
- unit: sec
- range: [0...900]
es Parameter type: <Counter> number of errored seconds
- counter This element is always shown.
ses Parameter type: <Counter> number of severely errored
- counter seconds
This element is always shown.
crc Parameter type: <Counter> number of CRC anomalies
- counter This element is always shown.
losws Parameter type: <Counter> number of loss of sync word
- counter This element is always shown.
uas Parameter type: <Counter> number of unavailable seconds
- counter This element is always shown.
va-int Parameter type: the number of previous intervals
<Shdsl::SegmentTermCurr15MValidIntervals> for which data has been stored
- a number of previous intervals for which data has been This element is always shown.
stored
- range: [0...96]
Command Description
This command displays the current day counters of individual segment end points in an SHDSL span.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show shdsl segment-counters current-1day [ (if-index) [ unit-id <Shdsl::UnitId> ] [ side <Shdsl::SegmentSide> ]
[ wire-pair <Shdsl::SegmentTerminationWirePair> ] ]
Command Parameters
Table 73.7-1 "SHDSL Segment Counters Current Day Status 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 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
side Parameter type: <Shdsl::SegmentSide> the particular side of an SHDSL
Format: unit in an SHDSL segment
( network
| customer )
Possible values:
- network : the network side
- customer : the customer side
Command Output
Table 73.7-2 "SHDSL Segment Counters Current Day Status Command" Display parameters
Specific Information
name Type Description
time-el Parameter type: the elapsed seconds in the current
<Shdsl::SegmentTermCurr1DTimeElapsed> day interval
- an elapsed seconds in the current day interval This element is always shown.
- unit: sec
- range: [0...86400]
es Parameter type: <Counter> number of errored seconds
- counter This element is always shown.
ses Parameter type: <Counter> number of severely errored
- counter seconds
This element is always shown.
crc Parameter type: <Counter> number of CRC anomalies
- counter This element is always shown.
losws Parameter type: <Counter> number of loss of sync word
- counter This element is always shown.
uas Parameter type: <Counter> number of unavailable seconds
- counter This element is always shown.
va-int Parameter type: the number of previous intervals
<Shdsl::SegmentTermCurr1DValidIntervals> for which data has been stored
- a number of previous intervals for which data has been This element is always shown.
stored
- range: [0...30]
Command Description
This command displays the previous interval counters of individual segment end points in an SHDSL span.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 73.8-1 "SHDSL Segment Counters Previous Interval Status 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 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
side Parameter type: <Shdsl::SegmentSide> the particular side of an SHDSL
Format: unit in an SHDSL segment
( network
| customer )
Possible values:
- network : the network side
- customer : the customer side
Command Output
Table 73.8-2 "SHDSL Segment Counters Previous Interval Status Command" Display parameters
Specific Information
name Type Description
mon-sec Parameter type: <Shdsl::PreviousIntevalMoniSecs> number of actually monitored
- a monitored seconds number seconds in this interval
- unit: sec This element is always shown.
- range: [0...900]
es Parameter type: <Counter> number of errored seconds
- counter This element is always shown.
ses Parameter type: <Counter> number of severely errored
- counter seconds
This element is always shown.
crc Parameter type: <Counter> number of CRC anomalies
- counter This element is always shown.
losws Parameter type: <Counter> number of loss of sync word
- counter This element is always shown.
uas Parameter type: <Counter> number of unavailable seconds
- counter This element is always shown.
Command Description
This command displays the previous day counters of individual segment end points in an SHDSL span.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show shdsl segment-counters previous-1day [ (if-index) [ unit-id <Shdsl::UnitId> ] [ side <Shdsl::SegmentSide>
] [ wire-pair <Shdsl::SegmentTerminationWirePair> ] [ int-no <Shdsl::Interval1DayNumber> ] ]
Command Parameters
Table 73.9-1 "SHDSL Segment Counters Previous Day Status 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 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
side Parameter type: <Shdsl::SegmentSide> the particular side of an SHDSL
Format: unit in an SHDSL segment
( network
| customer )
Possible values:
- network : the network side
- customer : the customer side
Command Output
Table 73.9-2 "SHDSL Segment Counters Previous Day Status Command" Display parameters
Specific Information
name Type Description
mon-sec Parameter type: <Shdsl::PreviousInteval1DayMoniSecs> number of actually monitored
- a monitored seconds number seconds in this interval
- unit: sec This element is always shown.
- range: [0...86400]
es Parameter type: <Counter> number of errored seconds
- counter This element is always shown.
ses Parameter type: <Counter> number of severely errored
- counter seconds
This element is always shown.
crc Parameter type: <Counter> number of CRC anomalies
- counter This element is always shown.
losws Parameter type: <Counter> number of loss of sync word
- counter This element is always shown.
uas Parameter type: <Counter> number of unavailable seconds
- counter This element is always shown.
Command Description
This command displays the current interval performance data of an SHDSL span.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 73.10-1 "SHDSL Span Current Interval Performance Data Status 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
Command Output
Table 73.10-2 "SHDSL Span Current Interval Performance Data Status Command" Display
parameters
Specific Information
name Type Description
time-el Parameter type: <Shdsl::PMCurr15MinTimeElapsed> the elapsed seconds in the current
- an elapsed seconds in the current 15-minute interval 15-minute interval
- unit: sec This element is always shown.
- range: [0...900]
re-init Parameter type: <Counter> number of total reinitializations
Command Description
This command displays the current day performance data of an SHDSL span.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 73.11-1 "SHDSL Span Current Day Performance Data Status 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
Command Output
Table 73.11-2 "SHDSL Span Current Day Performance Data Status Command" Display
parameters
Specific Information
name Type Description
time-el Parameter type: <Shdsl::PMCurr1DayTimeElapsed> the elapsed seconds in the current
- an elapsed seconds in the current day interval day interval
- unit: sec This element is always shown.
- range: [0...86400]
re-init Parameter type: <Counter> number of total reinitializations
Command Description
This command displays the previous interval performance data of an SHDSL span.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 73.12-1 "SHDSL Span Previous Interval Performance Data Status 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
interval-number Parameter type: <Shdsl::PM15MinIntervalNumber> the performance interval number
Format:
- a performance interval number
- range: [1...96]
Command Output
Table 73.12-2 "SHDSL Span Previous Interval Performance Data Status Command" Display
parameters
Specific Information
name Type Description
moni-secs Parameter type: <Shdsl::PM15MinIntevalMoniSecs> number of actually monitored
Command Description
This command displays the previous day performance data of an SHDSL span.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 73.13-1 "SHDSL Span Previous Day Performance Data Status 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
interval-number Parameter type: <Shdsl::PM1DayIntervalNumber> the performance interval number
Format:
- a performance interval number
- range: [1...30]
Command Output
Table 73.13-2 "SHDSL Span Previous Day Performance Data Status Command" Display
parameters
Specific Information
name Type Description
moni-secs Parameter type: <Shdsl::PM1DayIntevalMoniSecs> number of actually monitored
Description
This chapter gives an overview of nodes that are handled by "IMA Status Commands".
Command Tree
----show
----ima
----group
----state
- (if-index)
----counters
----near-end
----current-interval
- (if-index)
----previous-interval
- (if-index)
- interval-no
----far-end
----current-interval
- (if-index)
----previous-interval
- (if-index)
- interval-no
----link
----state
- (if-index)
----counters
----near-end
----current-interval
- (if-index)
----previous-interval
- (if-index)
- interval-no
----far-end
----current-interval
- (if-index)
----previous-interval
- (if-index)
- interval-no
Command Description
This command displays the IMA group status.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 74.2-1 "IMA Group Status 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
Command Output
Table 74.2-2 "IMA Group Status Command" Display parameters
Specific Information
name Type Description
grp-if-index Parameter type: <Itf::ImaLine> the logical interface number
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / assigned to this IMA group
<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
Command Description
This command displays the IMA groups near-end current interval status.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 74.3-1 "IMA Group Near-End Current Interval Performance Data Status 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
Command Output
Table 74.3-2 "IMA Group Near-End Current Interval Performance Data Status Command"
Display parameters
Specific Information
name Type Description
time-el Parameter type: <Ima::GroupCurrentTimeElapsed> the number of time elapsed in the
- a number of time elapsed in a current interval current interval
- range: [0...899] This element is always shown.
valid-interval Parameter type: <Ima::GroupCurrentValidIntervals> the number of previous valid
- a number of previous valid intervals intervals
Command Description
This command displays the IMA groups near-end previous interval status.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show ima group counters near-end previous-interval [ (if-index) [ interval-no <Ima::GroupIntervalNumber> ] ]
Command Parameters
Table 74.4-1 "IMA Group Near-End Previous Interval Performance Data Status 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
interval-no Parameter type: <Ima::GroupIntervalNumber> the number of the interval
Format: number
- a number of a interval number
- range: [1...32]
Command Output
Table 74.4-2 "IMA Group Near-End Previous Interval Performance Data Status Command"
Display parameters
Specific Information
name Type Description
uas Parameter type: <Gauge> the number of unavailable
Command Description
This command displays the IMA groups far-end current interval status.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 74.5-1 "IMA Group Far-End Current Interval Performance Data Status 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
Command Output
Table 74.5-2 "IMA Group Far-End Current Interval Performance Data Status Command" Display
parameters
Specific Information
name Type Description
time-el Parameter type: <Ima::GroupFarEndTimeElapsed> the number of time elapsed in the
- a number of time elapsed in a current interval far end interval
- range: [0...899] This element is always shown.
valid-interval Parameter type: <Ima::GroupFarEndValidIntervals> the number of the far end valid
- a number of previous valid intervals intervals
Command Description
This command displays the IMA groups far-end previous interval status.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show ima group counters far-end previous-interval [ (if-index) [ interval-no <Ima::GroupFarEndIntervalNumber>
]]
Command Parameters
Table 74.6-1 "IMA Group Far-End Previous Interval Performance Data Status 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
interval-no Parameter type: <Ima::GroupFarEndIntervalNumber> the number of the previous
Format: interval number
- a number of a previous interval number
- range: [1...32]
Command Output
Table 74.6-2 "IMA Group Far-End Previous Interval Performance Data Status Command" Display
parameters
Specific Information
Command Description
This command displays the IMA link status.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 74.7-1 "IMA Link Status 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
Command Output
Table 74.7-2 "IMA Link Status Command" Display parameters
Specific Information
name Type Description
ne-tx-state Parameter type: <Ima::LinkState> the mandatory state of the
( not-in-grp near-end transmit link
| uus-not-gi-rea This element is only shown in
| uus-fau detail mode.
| uus-mis-con
| uus-blk
| uus-fail
| use
| act )
Possible values:
- not-in-grp : not in group
Command Description
This command displays the IMA links near-end current interval status.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 74.8-1 "IMA Link Near-End Current Interval Performance Data Status 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
Command Output
Table 74.8-2 "IMA Link Near-End Current Interval Performance Data Status Command" Display
parameters
Specific Information
name Type Description
time-el Parameter type: <Ima::LinkCurrentTimeElapsed> the number of time elapsed in the
- a number of time elapsed in a current interval of a link current interval of the link
- range: [0...899] This element is always shown.
valid-interval Parameter type: <Ima::LinkCurrentValidIntervals> the number of previous valid
- a number of previous valid intervals of a link intervals of the link
Command Description
This command displays the IMA links near-end previous interval status.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show ima link counters near-end previous-interval [ (if-index) [ interval-no <Ima::LinkIntervalNumber> ] ]
Command Parameters
Table 74.9-1 "IMA Link Near-End Previous Interval Performance Data Status 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
interval-no Parameter type: <Ima::LinkIntervalNumber> the number of the interval value
Format: in the link
- a number of a interval number in a link
- range: [1...32]
Command Output
Table 74.9-2 "IMA Link Near-End Previous Interval Performance Data Status Command" Display
parameters
Specific Information
name Type Description
iv Parameter type: <Gauge> the number of ima violation
Command Description
This command displays the IMA links far-end current interval status.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 74.10-1 "IMA Link Far-End Current Interval Performance Data Status 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
Command Output
Table 74.10-2 "IMA Link Far-End Current Interval Performance Data Status Command" Display
parameters
Specific Information
name Type Description
time-el Parameter type: <Ima::LinkFarEndTimeElapsed> the number of time elapsed of the
- a number of time elapsed of a link in a far end interval link in the far end interval
- range: [0...899] This element is always shown.
valid-interval Parameter type: <Ima::LinkFarEndValidIntervals> the number of the far end valid
- a number of a far end valid intervals of a link intervals of the link
Command Description
This command displays the IMA links far-end previous interval status.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
> show ima link counters far-end previous-interval [ (if-index) [ interval-no <Ima::LinkFarEndIntervalNumber> ] ]
Command Parameters
Table 74.11-1 "IMA Link Far-End Previous Interval Performance Data Status 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
interval-no Parameter type: <Ima::LinkFarEndIntervalNumber> the number of the previous
Format: interval number in the far end
- a number of a interval number in a far end link link
- range: [1...32]
Command Output
Table 74.11-2 "IMA Link Far-End Previous Interval Performance Data Status Command" Display
parameters
Specific Information
name Type Description
ses Parameter type: <Gauge> the number of severely errored
Description
This chapter gives an overview of nodes that are handled by "Voice Show Commands".
Command Tree
----show
----voice
----sip
----server
- (name)
----server-useragent
- (name)
----user-agent
- (name)
----dialplan
- (name)
----termination
- (termination)
----dialplan-useragent
- (name)
----termination-useragent
- (name)
Command Description
This command allows the operator to show the Voice Sip Server profile.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 75.2-1 "Voice Sip Server Show Commands" Resource Parameters
Resource Identifier Type Description
(name) Format: uniquely identify of this voice
- uniquely identifies this voice server server
- length: 1<=x<=32
Command Output
Table 75.2-2 "Voice Sip Server Show Commands" Display parameters
Specific Information
name Type Description
oper-status Parameter type: <Sip::ServerOperStatus> the operational status of server
( up This element is always shown.
| down )
Possible values:
- up : the status of the server opera is up
- down : the status of the server opera is down
Command Description
This command allows the operator show the Voice Sip server and associated user agent profile.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 75.3-1 "Voice Sip server and associated user agent Show Commands" Resource Parameters
Resource Identifier Type Description
(name) Format: the name of this voice sip server
- uniquely identifies this voice server
- length: 1<=x<=32
Command Output
Table 75.3-2 "Voice Sip server and associated user agent Show Commands" Display parameters
Specific Information
name Type Description
user-agent-name Parameter type: <Sip::UserAgentName> the name of associated user agent
- uniquely identifies the User Agent This element is always shown.
- length: x<=32
Command Description
This command allows the operator to show the Voice Sip user agent profile.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 75.4-1 "Voice User Agent Show Commands" Resource Parameters
Resource Identifier Type Description
(name) Format: uniquely identify of this user
- uniquely identifies the User Agent agent
- length: x<=32
Command Output
Table 75.4-2 "Voice User Agent Show Commands" Display parameters
Specific Information
name Type Description
oper-status Parameter type: <Sip::UserAgentOperStatus> the opera status of user agent
( up This element is always shown.
| down )
Possible values:
- up : the status of the user agent operation is up
- down : the status of the user agent operation is down
Command Description
This command allows the operator to show the Voice Sip dial plan profile.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 75.5-1 "Voice Dialplan Show Commands" Resource Parameters
Resource Identifier Type Description
(name) Format: the uniquely identify of this voice
- uniquely identifies the dial plan application dial plan within its
- length: 1<=x<=32 scope
Command Output
Table 75.5-2 "Voice Dialplan Show Commands" Display parameters
Specific Information
name Type Description
ref-count Parameter type: <Sip::DialPlanUsedStatus> the number of terminations using
- number of terminations associated with this dial plan this dial plan
- range: [0...65535] This element is always shown.
Command Description
This command allows the operator to show the Voice Sip termination profile.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 75.6-1 "Voice Sip Termination Show Commands" Resource Parameters
Resource Identifier Type Description
(termination) 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 Output
Table 75.6-2 "Voice Sip Termination Show Commands" Display parameters
Specific Information
name Type Description
oper-status Parameter type: <Sip::TermOperStatus> the operational status of
( up application server
| down ) This element is always shown.
Possible values:
- up : the status of the termination opera is up
- down : the status of the termination is down
call-status Parameter type: <Sip::TermCallStatus> the call status of a termination
( unknown This element is always shown.
| idle-onhook
| off-hook
Command Description
This command allows the operator to show the Voice Sip dialplan and associated user agent profile.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 75.7-1 "Voice Sip Dialplan and associated User Agent Show Commands" Resource
Parameters
Resource Identifier Type Description
(name) Format: the name of this dial plan
- uniquely identifies the dial plan
- length: 1<=x<=32
Command Output
Table 75.7-2 "Voice Sip Dialplan and associated User Agent Show Commands" Display parameters
Specific Information
name Type Description
user-agent-name Parameter type: <Sip::UserAgentName> the name of associated user agent
- uniquely identifies the User Agent This element is always shown.
- length: x<=32
Command Description
This command allows the operator to show the Voice Sip termination and associated user agent profile.
User Level
The command can be accessed by operators with xdsl privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 75.8-1 "Voice termination and associated user agent Show Commands" Resource Parameters
Resource Identifier Type Description
(name) Format: the name of this user agent
- uniquely identifies the User Agent
- length: x<=32
Command Output
Table 75.8-2 "Voice termination and associated user agent Show Commands" Display parameters
Specific Information
name Type Description
index Parameter type: <Itf::PotsLine> the if-index of associated
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / termination
<Eqpt::PortId> This element is always shown.
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 "L2CP Status Commands".
Command Tree
----show
----l2cp
----session-status
- (index)
----session-peers
- (index)
----session-stats
- (index)
Command Description
This command allows the operator to display the L2CP session status.
It shows the status of the GSMP Adjacency Protocol.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 76.2-1 "L2CP Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index to the l2cp session table
- identity of the l2cp session
- range: [1...255]
Command Output
Table 76.2-2 "L2CP Status Command" Display parameters
Specific Information
name Type Description
state Parameter type: <L2cp::State> state of the l2cp session
( null This element is always shown.
| sync-sent
| sync-rcvd
| estab )
Possible values:
- null : null state
- sync-sent : sync sent state
- sync-rcvd : sync received state
- estab : established state
gsmp-version Parameter type: <L2cp::Version> version of gsmp protocol
- version of the GSMP protocol This element is always shown.
- range: [3]
gsmp-sub-version Parameter type: <L2cp::SubVersion> sub version of gsmp protocol
- sub version of the GSMP protocol This element is always shown.
- range: [1]
topo-discovery Parameter type: <L2cp::AccessTopologyDiscovery> access topology discovery is
Command Description
This command allows the operator to display the L2CP session peers.
This command shows the identity of the peers.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 76.3-1 "L2CP Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index to the l2cp session table
- identity of the l2cp session
- range: [1...255]
Command Output
Table 76.3-2 "L2CP Status Command" Display parameters
Specific Information
name Type Description
dslam-name Parameter type: <L2cp::DslamName> the name of the DSLAM
- a mac-address (example : 01:02:03:04:05:06) This element is always shown.
- length: 6
bras-name Parameter type: <L2cp::DslamName> the name of the BRAS
- a mac-address (example : 01:02:03:04:05:06) This element is always shown.
- length: 6
vrf-id Parameter type: <L2cp::VrfIndex> vrf containing own IP address
- the VRF ID which uniquely identify a VRF and route table to be used for the
- range: [0] connectivity to the GSMP peer.
This element is always shown.
dslam-ip-address Parameter type: <L2cp::InetAddress> IPv4 address used for the GSMP
- IPv4-address session peer
This element is always shown.
bras-ip-address Parameter type: <L2cp::InetAddress> IPv4 address used for the GSMP
- IPv4-address session peer
This element is always shown.
dslam-instance Parameter type: <L2cp::Instance> instance number used by the
Command Description
This command allows the operator to display the L2CP session statistics.
The operator may also want to see real activity by checking traffic counters for L2CP messagesvia this show
command.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 76.4-1 "L2CP Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index to the l2cp session table
- identity of the l2cp session
- range: [1...255]
Command Output
Table 76.4-2 "L2CP Status Command" Display parameters
Specific Information
name Type Description
sent-msgs Parameter type: <Counter> number of messages that have
- counter been sent in this session
This element is always shown.
rcvd-valid-msgs Parameter type: <Counter> number of messages that have
- counter been received and processed in
this session
This element is always shown.
discarded-msgs Parameter type: <Counter> number of messages that in this
- counter session have been received and
discarded.
This element is always shown.
Description
This chapter gives an overview of nodes that are handled by "MSTP Status Commands".
Command Tree
----show
----mstp
----bridge
----instance
- (instance)
----network-port
- (port)
----port-instance
- (network-port)
- instance
Command Description
This command displays all common spanning tree instances for the whole bridge.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 77.2-2 "SHub MSTP Bridge Status Command" Display parameters
Specific Information
name Type Description
root-id Parameter type: <Shub::MstpBridgeId> the bridgeId of the CIST root
- the mstp bridge id used in the PDUs originated by
- length: 8 this node.
This element is only shown in
detail mode.
root-cost Parameter type: <Shub::MstpRootCost> cost of the path to the CIST Root
- root cost seen from the bridge
This element is only shown in
detail mode.
root-port Parameter type: <Shub::MstpZeroNetworkPort> port which offers the lowest path
( network : <Shub::MstpNetworkPort> cost to the Root bridge
| none ) This element is only shown in
Possible values: detail mode.
- none : no port
- network : network port
Field type <Shub::MstpNetworkPort>
- Network Port on Shub
hold-time Parameter type: <Shub::MstpInteger> interval between no more then
- a signed integer two PDUs are transmitted
This element is only shown in
detail mode.
max-age Parameter type: <Shub::MstpInteger> max age of STP information
- a signed integer learned on a port before it is
discarded
This element is only shown in
detail mode.
hello-time Parameter type: <Shub::MstpInteger> time between transmission of
- a signed integer PDUs on a port when it is the
Command Description
This command displays all parameters of a multiple spanning tree instance.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 77.3-1 "SHub MSTP Instance Status Command" Resource Parameters
Resource Identifier Type Description
(instance) Format: mstp instance number
- MSTP Instance
- range: [1...16]
Command Output
Table 77.3-2 "SHub MSTP Instance Status Command" Display parameters
Specific Information
name Type Description
root-cost Parameter type: <Shub::MstpRootCost> cost of the path to the MSTI
short name: root/cost - root cost Regional Root seen by the bridge
This element is always shown.
root-port Parameter type: <Shub::MstpZeroNetworkPort> port which offers the lowest path
short name: root/port ( network : <Shub::MstpNetworkPort> cost to the MSTI Region Root
| none ) bridge
Possible values: This element is always shown.
- none : no port
- network : network port
Field type <Shub::MstpNetworkPort>
- Network Port on Shub
old-designated-root Parameter type: <Shub::MstpBridgeId> the bridge id of the old root of the
- the mstp bridge id mstp instance
- length: 8 This element is always shown.
regional-root-id Parameter type: <Shub::MstpBridgeId> the bridgeId of the MSTI regional
- the mstp bridge id root id used in the PDUs
- length: 8 originated by this node.
This element is always shown.
Command Description
This command displays all mstp network port information.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 77.4-1 "SHub MSTP Network Port Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: port number
<Shub::MstpNetworkPort>
Field type <Shub::MstpNetworkPort>
- Network Port on Shub
Command Output
Table 77.4-2 "SHub MSTP Network Port Status Command" Display parameters
Specific Information
name Type Description
state Parameter type: <Shub::MstpPortState> state of the port
( disabled This element is always shown.
| discarding
| learning
| forwarding )
Possible values:
- disabled : disabled
- discarding : discarding
- learning : learning
- forwarding : forwarding
p2p-port Parameter type: <Shub::Boolean> point-to-point status of the LAN
short name: port/p2p ( yes segment
| no ) This element is always shown.
Possible values:
- yes : true
- no : false
edge-port Parameter type: <Shub::Boolean> operational value of the edge port
Command Description
This command displays all mstp port instances.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 77.5-1 "SHub MSTP Port Instance Status Command" Resource Parameters
Resource Identifier Type Description
(network-port) Format: port number
<Shub::MstpNetworkPort>
Field type <Shub::MstpNetworkPort>
- Network Port on Shub
instance Parameter type: <Shub::MstpInstance> mstp instance
Format:
- MSTP Instance
- range: [1...16]
Command Output
Table 77.5-2 "SHub MSTP Port Instance Status Command" Display parameters
Specific Information
name Type Description
state Parameter type: <Shub::MstpPortState> state of the port
( disabled This element is always shown.
| discarding
| learning
| forwarding )
Possible values:
- disabled : disabled
- discarding : discarding
- learning : learning
- forwarding : forwarding
designated-root Parameter type: <Shub::MstpBridgeId> bridge identifier of the MSTI
short name: - the mstp bridge id regional root
designated/root - length: 8 This element is always shown.
Description
This chapter gives an overview of nodes that are handled by "Ethernet Lt Configuration Data Status Commands".
Command Tree
----show
----config-data-port
- (if-index)
----interface-port
- [no] admin-state
- [no] link-updown-trap
- [no] user
- [no] severity
----igmp
- (port)
- perm-pkg-bitmap
- max-num-group
----security-pae
- (port)
- [no] controlled-port
- [no] quiet-period
- [no] tx-period
- [no] supp-timeout
- [no] server-timeout
- [no] max-req
- [no] authentication
- [no] init-authreq-off
- [no] handshake
- [no] handshake-period
- [no] initialize
----bridge-port
- (port)
- pvid
- default-priority
- mac-learn-off
- max-unicast-mac
- accept-frame-type
- prio-regen-prof
- qos-profile
----qos
- scheduler-profile
- cac-profile
----pppoe
- (port)
- max-num-session
- ppp-profile-name
Command Description
This command displays the Ethernet port interface configuration data.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 78.2-1 "Ethernet Port Interface Configuration Status 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 78.2-2 "Ethernet Port Interface Configuration Status Command" Command Parameters
Parameter Type Description
[no] admin-state Parameter type: <Eth::EthAdminStatus> optional parameter with default
Format: value: "admin-down"
( up the state of the interface
| down )
Possible values:
- up : admin status is up
- down : admin status is down
[no] link-updown-trap Parameter type: <Itf::ifLinkUpDownTrapEnable> optional parameter with default
Format: value: "no-link-updown-trap"
( link-updown-trap indicates whether
Command Description
This command displays the Ethernet IGMP configuration data.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 78.3-1 "Ethernet IGMP Configuration Status 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
(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>
| 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> )
Possible values:
- vlan : vlan port
Command Description
This command displays the Ethernet security PAE configuration data.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 78.4-1 "Ethernet Security PAE Configuration Status 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
(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> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Command Description
This command displays the Bridge Port configured data.
User Level
The command can be accessed by operators with vlan privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 78.5-1 "Ethernet BridgePort Configuration Status 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
(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> )
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 displays the Ethernet QoS configuration data.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 78.6-1 "Ethernet QoS Configuration Status 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 78.6-2 "Ethernet QoS Configuration Status Command" Command Parameters
Parameter Type Description
scheduler-profile Parameter type: <Qos::ProfileName> optional parameter
Format: the name of the scheduler profile
name : <Qos::IgnoredQosProfileName> to be mapped on this dsl link
Possible values:
- name : enter profile name to be associated
Field type <Qos::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64
cac-profile Parameter type: <Qos::ProfileName> optional parameter
Format: the name of the cac profile to be
name : <Qos::IgnoredQosProfileName> mapped on this dsl link
Possible values:
- name : enter profile name to be associated
Field type <Qos::IgnoredQosProfileName>
- name of the QoS profile
Command Description
This command displays the Ethernet PPPoE configuration data.
User Level
The command can be accessed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 78.7-1 "Ethernet PPPoE Configuration Status 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
(port) Format: the pppox port interafce
( <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>
Description
This chapter gives an overview of nodes that are handled by "Ethernet Status Commands".
Command Tree
----show
----ethernet
----counters
----near-end
----line
----current-interval
- (if-index)
----current-1day
- (if-index)
----previous-interval
- (if-index)
- interval-no
----previous-1day
- (if-index)
- interval-no
----eth-int
- (if-index)
Command Description
Represents for the current interval the FCS failure count.
Represents for the current interval the frame too Long count.
Represents for interval MAC sublayer transmit error.
Represents for intervall MAC sublayer receive error.
Measured in seconds, that statistics for this entry have been counted.
Indicates the validity of the corresponding PM data.
Store the time interval.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 79.2-1 "Ethernet Counters Near End Line Current 15 Min" 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
Command Output
Table 79.2-2 "Ethernet Counters Near End Line Current 15 Min" Display parameters
Specific Information
name Type Description
los Parameter type: <Counter> Represents for the current 15
- counter minute interval the LOS failure
count
This element is always shown.
fcs Parameter type: <Counter> Represents for the current 15
- counter minute interval the FCS failure
count
This element is always shown.
too-long Parameter type: <Counter> Represents for the current 15
- counter minute interval the frame too
Long count
This element is always shown.
mac-trans Parameter type: <Counter> Represents for the internal MAC
- counter sublayer transmit error
This element is always shown.
mac-rec Parameter type: <Counter> Represents for the internal MAC
- counter sublayer receive error
This element is always shown.
mea-time Parameter type: <ETHITF::MeaTime> Measured in seconds, that
- the specification of measuredtime statistics for this entry have been
- range: [0...86400] counted
This element is always shown.
inv-data-flag Parameter type: <ETHITF::DataFlag> Indicates the validity of the
- the specification of invalid-data-flag corresponding PM data
- range: [0...1] This element is always shown.
val-int Parameter type: <ETHITF::Val15m> Store the time interval
- the specification of validintervals This element is always shown.
- range: [0...96]
Command Description
Represents for the current 1day the FCS failure count.
Represents for the current 1 day the frame too Long count.
Represents for 1day MAC sublayer transmit error.
Represents for 1dayl MAC sublayer receive error.
Measured in seconds, that statistics for this entry have been counted.
Indicates the validity of the corresponding PM data.
Store the time interval.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 79.3-1 "Ethernet Counters Near End Line Current Day" 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
Command Output
Table 79.3-2 "Ethernet Counters Near End Line Current Day" Display parameters
Specific Information
name Type Description
los Parameter type: <Counter> Represents for the current 1day
Command Description
Represents for the previous interval the FCS failure count.
Represents for the previous interval the frame too Long count.
Represents for previous interval MAC sublayer transmit error.
Represents for previous interval MAC sublayer receive error.
Measured in seconds, that statistics for this entry have been counted.
Indicates the validity of the corresponding PM data.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 79.4-1 "Ethernet Counters Near End Line Previous 15 Min" 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
interval-no Parameter type: <ETHITF::IntervalNumber15min> interface index of the port
Format:
- the specification of 15min-interval-number
- range: [1...96]
Command Output
Table 79.4-2 "Ethernet Counters Near End Line Previous 15 Min" Display parameters
Specific Information
name Type Description
los Parameter type: <Counter> Represents for the previous 15
- counter minute interval the LOS failure
count
This element is always shown.
fcs Parameter type: <Counter> Represents for the previous 15
- counter minute interval the FCS failure
count
This element is always shown.
too-long Parameter type: <Counter> Represents for the previous 15
- counter minute interval the frame too
Long count
This element is always shown.
mac-trans Parameter type: <Counter> Represents for the internal MAC
- counter sublayer transmit error
This element is always shown.
mac-rec Parameter type: <Counter> Represents for the internal MAC
- counter sublayer receive error
This element is always shown.
mea-time Parameter type: <ETHITF::MeaTime> Measured in seconds, that
- the specification of measuredtime statistics for this entry have been
- range: [0...86400] counted
This element is always shown.
inv-data-flag Parameter type: <ETHITF::DataFlag> Indicates the validity of the
- the specification of invalid-data-flag corresponding PM data
- range: [0...1] This element is always shown.
Command Description
Represents for the previous 1day the FCS failure count.
Represents for the previous 1 day the frame too Long count.
Represents for previous 1day MAC sublayer transmit error.
Represents for previous 1day MAC sublayer receive error.
Measured in seconds, that statistics for this entry have been counted.
Indicates the validity of the corresponding PM data.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
> show ethernet counters near-end line previous-1day [ (if-index) [ interval-no <ETHITF::IntervalNumber1day> ] ]
Command Parameters
Table 79.5-1 "Ethernet Counters Near End Line Previous Day" 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
interval-no Parameter type: <ETHITF::IntervalNumber1day> interface index of the port
Format:
- the specification of 1day-valid-intervals
- range: [0...30]
Command Output
Table 79.5-2 "Ethernet Counters Near End Line Previous Day" Display parameters
Specific Information
name Type Description
los Parameter type: <Counter> Represents for the previous 1day
- counter the LOS failure count
This element is always shown.
fcs Parameter type: <Counter> Represents for the previous 1day
- counter the FCS failure count
This element is always shown.
too-long Parameter type: <Counter> Represents for the previous 1day
- counter the frame too Long count
This element is always shown.
mac-trans Parameter type: <Counter> Represents for the Previous 1 day
- counter MAC sublayer transmit error
This element is always shown.
mac-rec Parameter type: <Counter> Represents for the previous 1day
- counter MAC sublayer receive error
This element is always shown.
mea-time Parameter type: <ETHITF::MeaTime> Measured in seconds, that
- the specification of measuredtime statistics for this entry have been
- range: [0...86400] counted
This element is always shown.
inv-data-flag Parameter type: <ETHITF::DataFlag> Indicates the validity of the
- the specification of invalid-data-flag corresponding PM data
- range: [0...1] This element is always shown.
Command Description
This command displays the number of available pm intervals per ethernet interface.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 79.6-1 "Ethernet PM Interval Per Interface Status 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
Command Output
Table 79.6-2 "Ethernet PM Interval Per Interface Status Command" Display parameters
Specific Information
name Type Description
cur-int-elapsedtime Parameter type: <SignedInteger> nbr of sec elapsed in cur intvl
- a signed integer err-measurement
This element is always shown.
cur-1day-elapsedtime Parameter type: <SignedInteger> nbr of sec elapsed in cur one day
- a signed integer err-measurement
This element is always shown.
valid-intervals Parameter type: <SignedInteger> nbr of prev intvl for which valid
Description
This chapter gives an overview of nodes that are handled by "Ethernet Lt Operational Data Status Commands".
Command Tree
----show
----oper-data-port
- (if-index)
----ethernet
- admin-state
- opr-state
----bridge-port
- (port)
- pvid
- default-priority
- qos-profile
----interface-port
- [no] admin-state
- oper-state
----igmp
- (port)
- curr-num-group
- curr-preview-num
- curr-uncfg-num
----ip-bridge-port
- (ip-bridge-port)
- rx-pkts
- rx-drop-pkts
- tx-pkts
----qos
- frame-net-bw
- m-cast-avail-bw
- m-cast-used-bw
Command Description
This command displays the Ethernet Port Operational data.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 80.2-1 "Ethernet Port Operational Status 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 80.2-2 "Ethernet Port Operational Status Command" Command Parameters
Parameter Type Description
admin-state Parameter type: <Itf::ifAdminStatus> optional parameter
Format: specifies state of the interface
( up
| down )
Possible values:
- up : admin status is up
- down : admin status is down
opr-state Parameter type: <ETHITF::combinedCol> optional parameter
Format: current operational state of the
( up interface.
| down
| testing
| unknown
| dormant )
Possible values:
Command Description
This command displays the Bridge Port Operational data.
User Level
The command can be accessed by operators with atm privileges.
Command Syntax
The command has the following syntax:
> show oper-data-port (if-index) bridge-port [ (port) ] pvid <Vlan::StackedVlan> default-priority <Vlan::Priority>
qos-profile <PPPoE::SnmpAdminString>
Command Parameters
Table 80.3-1 "Ethernet BridgePort Operational Status 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
(port) Format: identity of the PVC
( <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>
Command Description
This command displays the Ethernet port interface operational data.
User Level
The command can be accessed by operators with transport privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 80.4-1 "Ethernet Port Interface Operational Status 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 80.4-2 "Ethernet Port Interface Operational Status Command" Command Parameters
Parameter Type Description
[no] admin-state Parameter type: <Eth::EthAdminStatus> optional parameter with default
Format: value: "admin-down"
( up the desired state of the interface
| down )
Possible values:
- up : admin status is up
- down : admin status is down
oper-state Parameter type: <Itf::ifOperStatus> optional parameter
Format: the operational state of the
( up interface
| down
Command Description
This command displays the Ethernet IGMP operational data.
User Level
The command can be accessed by operators with igmp privileges.
Command Syntax
The command has the following syntax:
> show oper-data-port (if-index) igmp [ (port) ] curr-num-group <Gauge> curr-preview-num <Counter>
curr-uncfg-num <Counter>
Command Parameters
Table 80.5-1 "Ethernet IGMP Operational Status 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
(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>
| 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> )
Possible values:
- vlan : vlan port
Command Description
This command displays the Ethernet Port Ip Bridge Operational data.
User Level
The command can be accessed by operators with ip privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 80.6-1 "Ethernet Port Ip Bridge Operational Status 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
(ip-bridge-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> )
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>
Command Description
This command displays the Ethernet QoS operational data.
User Level
The command can be accessed by operators with qos privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 80.7-1 "Ethernet QoS Opertaional Status 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 80.7-2 "Ethernet QoS Opertaional Status Command" Command Parameters
Parameter Type Description
frame-net-bw Parameter type: <SignedInteger> optional parameter
Format: Represents the approximate
- a signed integer bandwidth available for Ethernet
frames, which is guaranteed to be
available by the physical layer.
This approximation is made by
the configurable ATM overhead
factor.
m-cast-avail-bw Parameter type: <SignedInteger> optional parameter
Format: Represents the bandwidth
- a signed integer available for multicast services,
calculated by the ISAM. This
value is what is left from
frame-net-bw after deducting
Description
This chapter gives an overview of nodes that are handled by "Security Status Commands".
Command Tree
----show
----security
----operator
- (name)
----aaa
----domain
- (name)
----user-session
- (index)
- user
- domain
----conn-profile
- (name)
----ip-addr-pool
- (name)
- vrf-index
----ip-pool-status
- (ip-addr)
----number-addr
----radius
----auth-server
----auth-stats
- (name)
- vrf-index
----state
- (name)
- vrf-index
----acc-server
----acc-stats
- (name)
- vrf-index
----state
- (name)
- vrf-index
----dyn-authclient-stats
- (name)
- vrf-index
----next-free-index
- (name)
----radius-client
----pae
----authenticator
- (port)
----eapol-stats
- (port)
----diagnostics
- (port)
----session-stats
- (port)
----port-details
- (port)
----mac-address
- (last-src-mac)
----ssh
----server
Command Description
This command displays information about operators managed by the local authentication server. Operators
managed by a remote authentication server (for example Radius) are never shown.
User Level
The command can be accessed by operators with all,admin privileges.
Operators without security read or write permissions can never see the information about other operators.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.2-1 "Operator Information Status 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
Command Output
Table 81.2-2 "Operator Information Status Command" Display parameters
Specific Information
name Type Description
last-login Parameter type: <Sys::Time> the time of the last successfull
- the time (yyyy-mm-dd:hour:minutes:secs) login
- unit: UTC This element is always shown.
last-failed Parameter type: <Sys::Time> the time of the last unsuccessfull
- the time (yyyy-mm-dd:hour:minutes:secs) login attempt
- unit: UTC This element is always shown.
failed-logins Parameter type: <UnsignedInteger> the number of unsuccessfull login
- an unsigned integer attempts since the last successfull
login
This element is always shown.
last-passwd-change Parameter type: <Sys::Time> the time the password was
- the time (yyyy-mm-dd:hour:minutes:secs) changed for the last time. It does
- unit: UTC not matter if the change was
made by this operator itself or by
another operator.
Command Description
This command displays the domain status.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.3-1 "Domain Status Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the domain
- name of the domain
- length: 1<=x<=64
Command Output
Table 81.3-2 "Domain Status Command" Display parameters
Specific Information
name Type Description
active-sessions Parameter type: <Gauge> the number of active sessions
- gauge This element is always shown.
Command Description
This command displays the details of user sessions.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
> show security aaa user-session [ (index) [ user <Aaa::DisplayString> ] [ domain <Aaa::DisplayString> ] ]
Command Parameters
Table 81.4-1 "User Sessions Status Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index to the domain user session
- a signed integer table
user Parameter type: <Aaa::DisplayString> user name
Format:
- a description
- length: 1<=x<=64
domain Parameter type: <Aaa::DisplayString> domain name
Format:
- a description
- length: 1<=x<=64
Command Output
Table 81.4-2 "User Sessions Status Command" Display parameters
Specific Information
name Type Description
interface Parameter type: <Itf::ComplexPortType> the interface on which the session
( xdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> / is established.
<Eqpt::SlotId> / <Eqpt::PortId> This element is only shown in
| xdsl-channel : <Eqpt::RackId> / <Eqpt::ShelfId> / detail mode.
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-if : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
Command Description
This command displays the status of connection profiles.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.5-1 "Connection Profile Status 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
Command Output
Table 81.5-2 "Connection Profile Status Command" Display parameters
Specific Information
name Type Description
number-of-users Parameter type: <AsamProfileRefCount> The number of entities using this
- number of entities using this particular profile profile. The profile can only be
- range: [0...65535] deleted when this number is 0.
This element is always shown.
index Parameter type: <AsamProfileIndex> connection profile index
- a profile index This element is always shown.
- range: [1...65535]
Command Description
This command displays the status of the local IP address pool management.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.6-1 "Local IP Pool Status Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the IP pool
- name of the Ip pool
- length: 1<=x<=64
vrf-index Parameter type: <Aaa::VrfIndex> vrf associated with this pool
Format:
- a vrf index
- range: [0...127]
(ip-addr) Format: ip pool address
- IPv4-address
Command Output
Table 81.6-2 "Local IP Pool Status Command" Display parameters
Specific Information
name Type Description
status Parameter type: <Aaa::IpPoolStatus> Specifies the status of the
( allocated specified IP address whether
| locally-reserved allocated or reserved(locally or
| remotely-reserved ) remotely).
Possible values: This element is always shown.
- allocated :
- locally-reserved :
- remotely-reserved :
Command Description
This command displays the IP address pool parameters.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.7-1 "IP Address Status Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the IP pool
- name of the Ip pool
- length: 1<=x<=64
vrf-index Parameter type: <Aaa::VrfIndex> vrf associated with this pool
Format:
- a vrf index
- range: [0...127]
Command Output
Table 81.7-2 "IP Address Status Command" Display parameters
Specific Information
name Type Description
free Parameter type: <Gauge> The number of IpAddresses that
- gauge are still free and can be used for
allocation.
This element is always shown.
reserved Parameter type: <Gauge> The number of IpAddresses that
- gauge are reserved (either locally or
remotely) and cannot be used for
allocation.
This element is always shown.
allocated Parameter type: <Gauge> The number of IpAddresses that
- gauge are allocated to existing user
sessions.
This element is always shown.
Command Description
This command displays the details of RADIUS authentication server statistics.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.8-1 "RADIUS Authentication Server Statistics 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]
Command Output
Table 81.8-2 "RADIUS Authentication Server Statistics Command" Display parameters
Specific Information
name Type Description
auth-server-id Parameter type: <Aaa::RadAuthServerIndex> authentication server id
- uniquely identify a radius auth server This element is always shown.
- range: [1...256]
rndtrp-time Parameter type: <TimeTicks> The time interval between the
short name: rndtrp - a timeout value most recent
- unit: msec Access-Reply/Access-Challenge
and the Access-Request that
matched it from this RADIUS
authentication server.
This element is always shown.
num-access-req Parameter type: <Counter> The number of RADIUS
Command Description
This command displays the state of the RADIUS authentication server.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.9-1 "RADIUS Authentication Server Status 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]
Command Output
Table 81.9-2 "RADIUS Authentication Server Status Command" Display parameters
Specific Information
name Type Description
auth-state Parameter type: <Aaa::OperState> The operational state of the
( up authentication server.
| down This element is always shown.
| unknown )
Possible values:
- up : Operational state up
- down : Operational state down
- unknown : Operational state unknown
Command Description
This command displays the RADIUS accounting server statistics.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.10-1 "RADIUS Accounting Server Statistics 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]
Command Output
Table 81.10-2 "RADIUS Accounting Server Statistics Command" Display parameters
Specific Information
name Type Description
rndtrip-time Parameter type: <TimeTicks> The time interval between the
short name: rndtp - a timeout value most recent accounting-response
- unit: msec and the accounting-request that
matched it from this RADIUS
accounting server.
This element is always shown.
num-acc-req Parameter type: <Counter> The number of RADIUS
short name: num-acrq - counter accounting-request packets sent.
This does not include
retransmissions.
This element is always shown.
Command Description
This command displays the state of the RADIUS accounting server.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.11-1 "RADIUS Accounting Server Status 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]
Command Output
Table 81.11-2 "RADIUS Accounting Server Status Command" Display parameters
Specific Information
name Type Description
acc-state Parameter type: <Aaa::OperState> Specifies the operational state of
( up the accounting server.
| down This element is always shown.
| unknown )
Possible values:
- up : Operational state up
- down : Operational state down
- unknown : Operational state unknown
Command Description
This command displays the statistics of the RADIUS Dynamic Authentication Client.
The conceptual table lists the statistics of the RADIUS Dynamic Authorization Clients with which the server shares
a secret.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.12-1 "RADIUS Dynamic Authentication Client Status 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]
Command Output
Table 81.12-2 "RADIUS Dynamic Authentication Client Status Command" Display parameters
Specific Information
name Type Description
num-disconnect-reqs Parameter type: <Counter> The number of RADIUS
- counter Disconnect-Request packets
recieved from this Dynamic
Authorization Client.
This element is always shown.
num-disconnect-acks Parameter type: <Counter> The number of RADIUS
- counter Disconnect-ACK packets sent to
this Dynamic Authorization
Client.
Command Description
This command displays the next available index.
The index is used to uniquely identify an entry in this table. The next-free-index shows the unique number in a
RADIUS policy that can be used to create a new entry in the RADIUS server. The value 0 indicates that no
unassigned entry is available. To obtain the RADIUS server index value for a new entry, the manager issues a
management protocol retrieval operation to obtain the current value of this object. After each retrieval, the agent
modifies the value to the next unassigned index.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.13-1 "RADIUS Next Available Index Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of the RADIUS policy
- name of the radius policy
- length: 1<=x<=64
Command Output
Table 81.13-2 "RADIUS Next Available Index Command" Display parameters
Specific Information
name Type Description
next-free-index Parameter type: <Aaa::RadServerSetNextFreeIndex> A unique number within a radius
- unique nbr in radius policy for creating radServerSet. policy that can be used for
- range: [0...2] creating a new radus server set.
This element is always shown.
Command Description
This command displays the RADIUS client parameters.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 81.14-2 "RADIUS Client Status Command" Display parameters
Specific Information
name Type Description
auth-invl-server-addr Parameter type: <Counter> The number of RADIUS
- counter Access-Response packets
received from unknown
addresses.
This element is always shown.
acc-invl-server-addr Parameter type: <Counter> The number of RADIUS
- counter Accounting-Response packets
received from unknown
addresses.
This element is always shown.
dynauth-ser-inv-addr Parameter type: <Counter> The number of RADIUS
- counter Disconnect-Request packets
received from unknown
addresses.
This element is always shown.
acc-ser-get-nxt-idx Parameter type: <Aaa::RadAccServerGetNextFreeIndex> The next free index value that can
- next free index for creating a radius accounting server be used for creating a new entry
- range: [0...256] in the radius accounting server.
This element is always shown.
dyn-auth-get-nxt-idx Parameter type: The next free index value that can
<Aaa::RadDynAuthClentGetNextFreeIndex> be used for creating a new entry
- next free index for creating a radius dyn auth client in the radius dyn auth client.
- range: [0...256] This element is always shown.
Command Description
This command displays the details of authentication configuration.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.15-1 "PAE Authenticator Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: the identification of the bridge
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / port
<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
Command Output
Table 81.15-2 "PAE Authenticator Status Command" Display parameters
Specific Information
name Type Description
auth-pae-state Parameter type: <Aaa::AuthPaeState> the current state of the
( initialize authenticator PAE state machine
| disconnected This element is always shown.
| connecting
| authenticating
Command Description
This command displays EAPOL statistics.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.16-1 "EAPOL Statistics 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> )
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 Output
Table 81.16-2 "EAPOL Statistics Command" Display parameters
Specific Information
name Type Description
rx-frames Parameter type: <Counter> the number of valid EAPOL
- counter frames of any type that have been
received by this Authenticator
This element is always shown.
Command Description
This command displays diagnostic information.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.17-1 "Diagnostic Information Status Command" Resource Parameters
Resource Identifier Type Description
(port) Format: the identification of the bridge
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / port
<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
Command Output
Table 81.17-2 "Diagnostic Information Status Command" Display parameters
Specific Information
name Type Description
to-connecting-cnt Parameter type: <Counter> the number of times that the state
- counter machine transitions to the
CONNECTING state from any
other state
This element is always shown.
Command Description
This command displays statistics for the sessions.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.18-1 "Session Statistics Command" Resource Parameters
Resource Identifier Type Description
(port) Format: the identification of the bridge
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / port
<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
Command Output
Table 81.18-2 "Session Statistics Command" Display parameters
Specific Information
name Type Description
rx-octets Parameter type: <Counter> the number of octets transmitted
- counter in user data frames on this port
during the session
This element is always shown.
Command Description
This command displays the PAE system parameters for a port or virtual channel
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.19-1 "PAE Port System Status 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> )
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 Output
Table 81.19-2 "PAE Port System Status Command" Display parameters
Specific Information
name Type Description
prot-ver Parameter type: <SignedInteger> The protocol version associated
- a signed integer with this Port.
This element is always shown.
capabilities Parameter type: <Aaa::Capabilities> Indicates the PAE functionality
Command Description
This command displays the EAPOL data for each MAC address.
User Level
The command can be accessed by operators with aaa privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 81.20-1 "MAC Address related EAPOL Status Command" Resource Parameters
Resource Identifier Type Description
(last-src-mac) Format: the source MAC address carried
- mac address (aa:bb:cc:a1:02:03) in the most recently received
- length: 6 EAPOL frame
Command Output
Table 81.20-2 "MAC Address related EAPOL Status Command" Display parameters
Specific Information
name Type Description
port Parameter type: <Itf::BridgePort> the port identification
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / This element is always shown.
<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
Command Description
This command displays the SSH Server related parameters
User Level
The command can be accessed by operators with all privileges.
Command Syntax
The command has the following syntax:
Command Output
Table 81.21-2 "SSH Server Status Command" Display parameters
Specific Information
name Type Description
public-key Parameter type: <PrintableString> public key of the server
- printable string This element is always shown.
Description
This chapter gives an overview of nodes that are handled by "Alarm Management Commands".
Command Tree
----admin
----alarm
- (clr-logging)
- (clr-persist-loss)
- (clr-shub-config-loss)
----snap-shot
- (start)
----shub
----snap-shot
- (start)
----delta-log
- (clr-indeterminate)
- (clr-warning)
- (clr-minor)
- (clr-major)
- (clr-critical)
----log
- (clr-error-log)
- (clr-set-log-table)
Command Description
This command allows the operator to manage alarms.
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 82.2-2 "Alarm Management Command" Command Parameters
Parameter Type Description
(clr-logging) Format: optional parameter
clr-logging clear log table - logging will start
Possible values: from index 1
- clr-logging : clear log table - logging will start from index
1
(clr-persist-loss) Format: optional parameter
clr-persist-loss clear the loss of persistent data
Possible values: alarm
- clr-persist-loss : clear the loss of persistent data alarm
(clr-shub-config-loss) Format: optional parameter
clr-shub-config-loss clear the shub configuration loss
Possible values: alarm
- clr-shub-config-loss : clear the shub configuration loss
alarm
Command Description
This command allows the operator to create a snapshot for a particular severity level.
The owner-id can be read by other users to see who has created the snapshot.
This command will fail if the snapshot is already in use. The snapshot is only kept for a limited time and is
automatically cleared.
The snapshot is displayed with the show alarm snapshot command.
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 82.3-2 "Snapshot Management Command" Command Parameters
Parameter Type Description
(start) Format: optional parameter
( start : indeterminate : <Alarm::alarmSnapShotOwner> start or stop the snap shot
| start : warning : <Alarm::alarmSnapShotOwner>
| start : minor : <Alarm::alarmSnapShotOwner>
| start : major : <Alarm::alarmSnapShotOwner>
| start : critical : <Alarm::alarmSnapShotOwner>
| start : <SignedInteger> : <Alarm::alarmSnapShotOwner>
| stop )
Possible values:
- start : start reading the snap shot table
- stop : stop reading the snap shot table
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
Field type <SignedInteger>
- a signed integer
Field type <Alarm::alarmSnapShotOwner>
- string to identify the owner (example: Tom)
Command Description
This command creates a snapshot for a particular severity level.
The command will fail if the snapshot is already in use. The snapshot is only kept for a limited time and is
automatically cleared.
The snapshot is displayed with the show alarm shub snapshot command.
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 82.4-2 "SHub Snapshot Management Command" Command Parameters
Parameter Type Description
(start) Format: optional parameter
( start : indeterminate : <Alarm::alarmSnapShotOwner> start or stop the snap shot
| start : warning : <Alarm::alarmSnapShotOwner>
| start : minor : <Alarm::alarmSnapShotOwner>
| start : major : <Alarm::alarmSnapShotOwner>
| start : critical : <Alarm::alarmSnapShotOwner>
| start : <SignedInteger> : <Alarm::alarmSnapShotOwner>
| stop )
Possible values:
- start : start reading the snap shot table
- stop : stop reading the snap shot table
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
Field type <SignedInteger>
- a signed integer
Field type <Alarm::alarmSnapShotOwner>
- string to identify the owner (example: Tom)
Command Description
This command allows the operator to manage the alarm delta logs.
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 82.5-2 "Alarm Delta Log Management Command" Command Parameters
Parameter Type Description
(clr-indeterminate) Format: optional parameter
clr-indeterminate clear indeterminate delta-log
Possible values: table - set index to 1
- clr-indeterminate : clear indeterminate delta-log table -
loggin will start from index 1
(clr-warning) Format: optional parameter
clr-warning clear warning delta-log table - set
Possible values: index to 1
- clr-warning : clear warning delta-log table - set index to 1
(clr-minor) Format: optional parameter
clr-minor clear minor delta-log table - set
Possible values: index to 1
- clr-minor : clear minor delta-log table - set index to 1
(clr-major) Format: optional parameter
clr-major clear major delta-log table - set
Possible values: index to 1
- clr-major : clear major delta-log table - set index to 1
(clr-critical) Format: optional parameter
clr-critical clear critical delta-log table - set
Possible values: index to 1
- clr-critical : clear critical delta-log table - set index to 1
Command Description
This command allows the operator to manage logs.
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 82.6-2 "Log Management Command" Command Parameters
Parameter Type Description
(clr-error-log) Format: optional parameter
clr-error-log clear the error log : index starts
Possible values: from 1
- clr-error-log : clear the error log : index starts from 1
(clr-set-log-table) Format: optional parameter
clr-set-log-table clear the set log table : index
Possible values: starts from 1
- clr-set-log-table : clear the set log table : index starts from
1
Description
This chapter gives an overview of nodes that are handled by "ATM Management Commands".
Command Tree
----admin
----atm
----port
- (port)
- f5-loopback-ete
Command Description
This command allows the operator to configure ATM port management. An f5 loopback end-to-end test can be
started by giving the parameter f5-loopback-ete a value of start.
The result of this test is displayed with the info command.
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 83.2-1 "ATM Port Management Command" Resource Parameters
Resource Identifier Type Description
(port) Format: the port under test
( <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 83.2-2 "ATM Port Management Command" Command Parameters
Parameter Type Description
f5-loopback-ete Parameter type: <Atm::F5LoopbackTestStatus> optional parameter
Format: the f5 end-to-end loopback test
start
Possible values:
- start : start the test
Description
This chapter gives an overview of nodes that are handled by "IGMP Management Commands".
Command Tree
----admin
----igmp
- (clear-all-stats)
- (clear-preview-cntr)
- (collect-cdr)
----mcast-src
- (slot-index)
- address
- (clear-statistics)
----module
- (slot-index)
- (clear-statistics)
----shub
----bundle
- (bundle-name)
- (clear-statistics)
----mcast-src
- (src)
- vlan-id
- ip-addr
- (clear-statistics)
----cac
----clear-stats
- (clear-stats)
----vlan
- clear-stats
----channel
- (port)
- (clear-statistics)
Command Description
This command allows the operator to manage IGMP.
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 84.2-2 "IGMP Management Command" Command Parameters
Parameter Type Description
(clear-all-stats) Format: optional parameter
clear-all-stats clears all statistics
Possible values:
- clear-all-stats : clear all statistics
(clear-preview-cntr) Format: optional parameter
reset-pre-count reset preview time for all mcast
Possible values: src in 1day/1wk/1month
- reset-pre-count : reset all preview time for all multicast
source
(collect-cdr) Format: optional parameter
collect-cdr to trigger to collect CDRs
Possible values: manually
- collect-cdr : trigger to collect CDRs manually
Command Description
This command allows the operator to manage the IGMP multicast sources.
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 84.3-1 "IGMP Multicast Sources Management Command" Resource Parameters
Resource Identifier Type Description
(slot-index) Format: identify an IGMP module by the
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> logical 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
address Parameter type: <Igmp::MulticastAddress> mcast src address in network-byte
Format: order (big-endian)
- multicast-address (range: 224.0.0.3....239.255.255.255)
Table 84.3-2 "IGMP Multicast Sources Management Command" Command Parameters
Parameter Type Description
(clear-statistics) Format: optional parameter
clear-statistics clear the statistics
Possible values:
- clear-statistics : clear the statistics
Command Description
This command allows the operator to manage IGMP related to a slot.
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 84.4-1 "IGMP Slot Management Command" Resource Parameters
Resource Identifier Type Description
(slot-index) Format: identify an IGMP module by the
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> logical slot id
| <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 84.4-2 "IGMP Slot Management Command" Command Parameters
Parameter Type Description
(clear-statistics) Format: optional parameter
clear-statistics clear the statistics
Possible values:
- clear-statistics : clear the statistics
Command Description
This command allows the operator to manage IGMP CAC bundle level stauts, clear bundle entry status.
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 84.5-1 "Shub IGMP CAC Bundle Management Command" Resource Parameters
Resource Identifier Type Description
(bundle-name) Format: name of this bundle
- the name of the bundle
- length: x<=32
Table 84.5-2 "Shub IGMP CAC Bundle Management Command" Command Parameters
Parameter Type Description
(clear-statistics) Format: optional parameter
clear-statistics clear the statistics
Possible values:
- clear-statistics : clear the statistics
Command Description
This command allows the operator to manage IGMP CAC Source status, clear source entry status.
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:
> admin igmp shub mcast-src (src) vlan-id <Igmp::McastSrcVLANID> ip-addr <Ip::V4Address> [ (clear-statistics)
]
Command Parameters
Table 84.6-1 "Shub IGMP CAC Source Management 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 addr of mcast servr in
Format: network-byte order(big-enaian)
- IPv4-address
Table 84.6-2 "Shub IGMP CAC Source Management Command" Command Parameters
Parameter Type Description
(clear-statistics) Format: optional parameter
clear-statistics clear the statistics
Possible values:
- clear-statistics : clear the statistics
Command Description
This command allows the operator to manage CAC system level status, clear the system,all bundle or all source
status.
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 84.7-2 "Shub IGMP CAC System Management Command" Command Parameters
Parameter Type Description
(clear-stats) Format: optional parameter
( all clear the cac related statistics
| system counters
| bundle
| mcast-src )
Possible values:
- all : clear all statistics
- system : clear system object statistics
- bundle : clear all bundle table statistics
- mcast-src : clear all channel source table statistics
Command Description
This command allows the operator to manage VLAN system clear statistics 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 84.8-2 "Shub IGMP VLAN System Management Command" Command Parameters
Parameter Type Description
clear-stats Parameter type: <Igmp::igmpClearStats> optional parameter
Format: clears all the IGMP statistics for
- clears all the IGMP statistics for the given Vlan the given Vlan
- range: [0...4094]
Command Description
This command allows the operator to manage the IGMP channel.
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 84.9-1 "IGMP Channel Management 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> )
Possible values:
- vlan : vlan port
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
Description
This chapter gives an overview of nodes that are handled by "PPPoX Management Commands".
Command Tree
----admin
----pppox-relay
----engine
- (vlan-id)
- (remove-all-ports)
Command Description
This command deletes all ports for a specific engine.
User Level
The command can be accessed by operators with ppoe privileges, and executed by operators with ppoe privileges.
Command Syntax
The command has the following syntax:
Command Parameters
Table 85.2-1 "PPPoX Engine Port Management Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan identity
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
Table 85.2-2 "PPPoX Engine Port Management Command" Command Parameters
Parameter Type Description
(remove-all-ports) Format: optional parameter
remove-all-ports remove all ports for a specific
Possible values: engine
- remove-all-ports : remove all ports
Description
This chapter gives an overview of nodes that are handled by "xDSL Management Commands".
Command Tree
----admin
----xdsl-line
- (if-index)
- loop-diagnostic
Command Description
This node allows the operator do manage an xDSL Line.
Loop Diagnostic Indications:
start : start diagnostics on XDSL line.
stop : stop diagnostics on XDSL line.
completed : diagnostic results ready for retrieval.
failed : diagnostic failed.
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 86.2-1 "xDSL Line Management 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 86.2-2 "xDSL Line Management Command" Command Parameters
Parameter Type Description
loop-diagnostic Parameter type: <Xdsl::LoopDiagMode> optional parameter
Format: controls the loop diagnostic test
( stop
| start )
Possible values:
- stop : stop the loop diagnostic test
- start : start the diagnostic test
Description
This chapter gives an overview of nodes that are handled by "Software Management Commands".
Command Tree
----admin
----software-mngt
- (clr-db-rollback-alrm)
- (clr-sw-rollback-alrm)
----oswp
- (index)
- download
- activate
- (commit)
- (abort-download)
----database
- download
- upload
----disk-file
- (path)
- (remove)
----shub
- select-config
----database
- (save)
----sw-package
- (package)
- (download)
----boot-rom
- (package)
Command Description
This command allows the operator to manage the software of the system.
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 87.2-2 "Software Management Command" Command Parameters
Parameter Type Description
(clr-db-rollback-alrm) Format: optional parameter
clr-db-rollback-alrm clear the implicit database
Possible values: rollback alarm
- clr-db-rollback-alrm : clear the implicit database rollback
alarm
(clr-sw-rollback-alrm) Format: optional parameter
clr-sw-rollback-alrm clear the implicit software
Possible values: rollback alarm
- clr-sw-rollback-alrm : clear the implicit software rollback
alarm
Command Description
This command allows the operator to manage the OSWP software packages.
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 87.3-1 "OSWP Software Management Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index to the swm oswp table
- id of one of the two oswps
- range: [1...2]
Table 87.3-2 "OSWP Software Management Command" Command Parameters
Parameter Type Description
download Parameter type: <SwMngt::oswpName> optional parameter
Format: download a software package
- path and name of the oswp ,file name less than 160 char
- range: [a-zA-Z0-9-_./]
- length: 1<=x<=255
activate Parameter type: <SwMngt::activationType> optional parameter
Format: activate an OSWP package
( with-linked-db
| with-default-db
| clear-db )
Possible values:
- with-linked-db : activate OSWP with linked database
- with-default-db : activate OSWP with default database
- clear-db : ISAM shutdown => only NT plugout/re-plugin
possible!
(commit) Format: optional parameter
commit commit the OSWP
Possible values:
- commit : commit the OSWP
(abort-download) Format: optional parameter
abort-download abort the download of an oswp
Command Description
This command allows the operator to manage the system database.
The database file name should be either dm.tar or dm_complete.tar.
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 87.4-2 "Database Management Command" Command Parameters
Parameter Type Description
download Parameter type: <SwMngt::DownloadServerId> optional parameter
Format: download the database
<Ip::V4Address> : <SwMngt::path>
Field type <Ip::V4Address>
- IPv4-address
Field type <SwMngt::path>
- path for the db (example: /path_to_db/file_name)
- range: [a-zA-Z0-9-_./]
- length: 1<=x<=255
upload Parameter type: <SwMngt::UploadServerId> optional parameter
Format: upload the database
( actual-active : <Ip::V4Address> : <SwMngt::path>
| preferred-active : <Ip::V4Address> : <SwMngt::path>
| previous-active : <Ip::V4Address> : <SwMngt::path>
| failed-active : <Ip::V4Address> : <SwMngt::path>
| actual-not-active : <Ip::V4Address> : <SwMngt::path>
| preferred-not-active : <Ip::V4Address> : <SwMngt::path>
| previous-not-active : <Ip::V4Address> : <SwMngt::path>
| failed-not-active : <Ip::V4Address> : <SwMngt::path> )
Possible values:
- actual-active : actual database for active OSWP
- preferred-active : preferable database for active OSWP
- previous-active : previous database for active OSWP
- failed-active : failed databse for active OSWP
- actual-not-active : actual database for not-active OSWP
- preferred-not-active : preferable database for not-active
Command Description
This command manages disk and descriptor files.
A disk file contains information about the different software files and descriptor files that are stored on the file disk.
It also contains information such as the file name, file size, file type, file availability status, and file format.
The operator can remove an unused file from the disk by specifying the file name, which is unique over all unit
types and over all SWP types for all releases.
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 87.5-1 "File Management Command" Resource Parameters
Resource Identifier Type Description
(path) Format: an absolute file name
- an absolute file name
- range: [.-z]
- length: 1<=x<=256
Table 87.5-2 "File Management Command" Command Parameters
Parameter Type Description
(remove) Format: optional parameter
remove remove the file
Possible values:
- remove : remove the file
Command Description
This command allows the operator to manage the software on the SHub.
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 87.6-2 "SHub Software Management Command" Command Parameters
Parameter Type Description
select-config Parameter type: <SwMngt::ReqOSPDevice> optional parameter
Format: select the configuration to be
( config-1 used
| config-2
| tftp )
Possible values:
- config-1 : sets config1 version in BSP
- config-2 : sets config2 version in BSP
- tftp : sets tftp version in BSP
Command Description
This command allows the operator to manage the database on the SHub.
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 87.7-2 "SHub Database Management Command" Command Parameters
Parameter Type Description
(save) Format: optional parameter
save save the database
Possible values:
- save : save the database
Command Description
This command allows the operator to manage the software package on the SHub.
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 87.8-1 "SHub Software Package Administration Command" Resource Parameters
Resource Identifier Type Description
(package) Format: the identification of the software
<Ip::V4Address> : <Sys::FileName> package
Field type <Ip::V4Address>
- IPv4-address
Field type <Sys::FileName>
- name
- length: 1<=x<=256
Table 87.8-2 "SHub Software Package Administration Command" Command Parameters
Parameter Type Description
(download) Format: optional parameter
download download the package
Possible values:
- download : download the package
Command Description
This command updates the SHub boot ROM.
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 87.9-2 "Update the SHub Boot ROM Command" Command Parameters
Parameter Type Description
(package) Format: optional parameter
<Ip::V4Address> : <Sys::FileName> the identification of the bootrom
Field type <Ip::V4Address> image
- IPv4-address
Field type <Sys::FileName>
- name
- length: 1<=x<=256
Description
This chapter gives an overview of nodes that are handled by "OSPF Management Commands".
Command Tree
----admin
----ospf
----interface
- (ip-addr)
- md5-key
- accept-expires
- generate-expires
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:
Command Parameters
Table 88.2-1 "OSPF Interface MD5 Key Management Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: ip address identifying the
- IPv4-address interface
md5-key Parameter type: <Ospf::Md5KeyIndex> the number of the md5 key
Format:
- the number of the MD5 key
- range: [1...5]
Table 88.2-2 "OSPF Interface MD5 Key Management Command" Command Parameters
Parameter Type Description
accept-expires Parameter type: <Ospf::MD5expiryDelay> optional parameter
Format: set the delay before the key
( now expires for accepting
| never
| <Ospf::MD5expiryDelay> )
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> mandatory parameter
Format: set the delay before the key
( now expires for generating
| never
Description
This chapter gives an overview of nodes that are handled by "RIP Management Commands".
Command Tree
----admin
----rip
----interface
- (ip-addr)
- md5-key
- expires
Command Description
This command allows the operator to manage 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:
Command Parameters
Table 89.2-1 "RIP Interface MD5 Key Management Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: interface IP address
- IPv4-address
md5-key Parameter type: <Rip::Md5KeyIndex> the number of the md5 key
Format:
- the number of the MD5 key
- range: [1...5]
Table 89.2-2 "RIP Interface MD5 Key Management Command" Command Parameters
Parameter Type Description
expires Parameter type: <Rip::MD5expiryDelay> optional parameter
Format: set the delay before the key
( never expires
| <Rip::MD5expiryDelay> )
Possible values:
- never : the key will never expire
Field type <Rip::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [0...2147483647]
Description
This chapter gives an overview of nodes that are handled by "SHDSL Management Commands".
Command Tree
----admin
----shdsl-seg
- (if-index)
- unit-id
- side
- [no] soft-restart
Command Description
This node allows the operator manage an SHDSL Segment.
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 90.2-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 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
side Parameter type: <Shdsl::SegmentSide> the particular side of an SHDSL
Format: unit in an SHDSL segment
( network
| customer )
Possible values:
- network : the network side
- customer : the customer side
Table 90.2-2 "SHDSL Segment Configuration Command" Command Parameters
Parameter Type Description
[no] soft-restart Parameter type: boolean optional parameter
Description
This chapter gives an overview of nodes that are handled by "Session Management Commands".
Command Tree
----admin
----session
- (id)
- (disconnect)
Command Description
This command allows the operator to discontinue (or forcely terminate) an existing CLI session.
The operator can learn about established CLI sessions using the "show session" command.
User Level
The command can be accessed and executed by an operator with admin privilege.
Command Syntax
The command has the following syntax:
Command Parameters
Table 91.2-1 "Forced Disconnect Session Command" Resource Parameters
Resource Identifier Type Description
(id) Format: the session number
- the session number
- range: [1...12]
Table 91.2-2 "Forced Disconnect Session Command" Command Parameters
Parameter Type Description
(disconnect) Format: optional parameter
disconnect : <Sec::DisconnectMessage> disconnect the session with a
Possible values: given message
- disconnect : disconnect the session
Field type <Sec::DisconnectMessage>
- disconnect msg to specify reason for forced termination
Description
This chapter gives an overview of nodes that are handled by "System Management Commands".
Command Tree
----admin
----system
----syslog
----destination
- (name)
- (rotate)
----security
----ssh
- generate-key
Command Description
This command allows the operator to rotate the log files explicitly.This is applicable if the destination type is
configured as file.
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 92.2-1 "SYSLOG Management 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 92.2-2 "SYSLOG Management command" Command Parameters
Parameter Type Description
(rotate) Format: optional parameter
rotate enforce the rotation of the log
Possible values: files
- rotate : enforce the rotation of the log files
Command Description
This command allows the operator to generate the public/private server key-pair.
The RSA key generation is not yet supported.
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 92.3-2 "Secure Shell Server Key Regeneration Command" Command Parameters
Parameter Type Description
generate-key Parameter type: <SSH::RegenerateKey> optional parameter
Format: to generate ssh server key-pair
( dsa
| rsa )
Possible values:
- dsa : generate a dsa key-pair
- rsa : generate a rsa key-pair (not supported at present)
Description
This chapter gives an overview of nodes that are handled by "Equipment Management Commands".
Command Tree
----admin
----equipment
- (prepare-sys-shutdown)
- reboot-shub
- reboot-isam
----slot
- (index)
- reboot
- [no] overrule-sw
----port
- (port)
- copy-to-port
Command Description
This command allows the operator to manage the node: prepare the system for shutdown, reset the node or reset
the SHUB.
Note: a reset of the SHUB only applies in case the node is equipped with an ECNT-A. In all other cases, an attempt
to reset the SHUB will be rejected.
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 93.2-2 "Equipment Management Command" Command Parameters
Parameter Type Description
(prepare-sys-shutdown) Format: optional parameter
prepare-sys-shutdown prepare the system for shutdown
Possible values:
- prepare-sys-shutdown : prepare the system for shutdown
reboot-shub Parameter type: <Sys::RestartValue> optional parameter
Format: reboot the shub
( systemreset
| applicationreset )
Possible values:
- systemreset : restart the entire switch
- applicationreset : only restart the application modules,
excluding the BCM driver and VxWorks
reboot-isam Parameter type: <Equipm::SystemRestart> optional parameter
Format: reboot the isam (with shub)
( with-self-test
| without-self-test
| hot-restart )
Possible values:
- with-self-test : restart with selftest
- without-self-test : restart without selftest
- hot-restart : reboot, but don't touch the hardware
Command Description
This command allows the operator to manage a slot and the units in the 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 93.3-1 "Slot Management Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the identification of the slot
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu 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 93.3-2 "Slot Management Command" Command Parameters
Parameter Type Description
reboot Parameter type: <Equipm::BoardRestart> optional parameter
Format: reboot the card in the slot
Command Description
This command allows the operator to manage SHub ports.
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 93.4-1 "SHub Port Management Command" Resource Parameters
Resource Identifier Type Description
(port) Format: identification of a port
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Table 93.4-2 "SHub Port Management Command" Command Parameters
Parameter Type Description
copy-to-port Parameter type: <Shub::NetworkPort> optional parameter
Format: copy the port to another port
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Description
This chapter gives an overview of nodes that are handled by "Bridge Management Commands".
Command Tree
----admin
----bridge
----learned-unicast-mac
- (unicast-mac-address)
- vlan-id
- port
- (delete)
----vlan-id
- (id)
- (delete-member-ports)
Command Description
This command allows the operator to remove dynamically learned MAC addresses.
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 94.2-1 "Learned Unicast MAC Address Management Command" Resource Parameters
Resource Identifier Type Description
(unicast-mac-address) Format: unicast mac address
- mac address (aa:bb:cc:a1:02:03)
- length: 6
vlan-id Parameter type: <Vlan::StackedVlan> vlan id
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
port Parameter type: <Itf::AtmInterfaceVpiVci> identification of a port
Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
Command Description
This command allows the operator to remove the association between a VLAN and all its member ports.
This command is the only means to remove dynamic associations.
Removal of the port VLAN association includes removal of all MAC addresses from the filtering database for these
port-VLAN associations.
Any outstanding duplicate MAC alarms for the port are cleared.
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 94.3-1 "VLAN Management Command" Resource Parameters
Resource Identifier Type Description
(id) Format: vlan id
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4097]
Field type <Vlan::CVlanIndex>
- customer vlan identy
- range: [0...4093,4097]
Table 94.3-2 "VLAN Management Command" Command Parameters
Parameter Type Description
(delete-member-ports) Format: optional parameter
delete-member-ports remove association between a
Possible values: vlan and all it's bridge ports
- delete-member-ports : remove associated bridge ports
Description
This chapter gives an overview of nodes that are handled by "Trap Management Commands".
Command Tree
----admin
----trap
----manager
- (address)
- (reset-trap-buffer)
Command Description
This command allows the operator to manage a trap manager.
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 95.2-1 "Trap Manager Management 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]
Table 95.2-2 "Trap Manager Management Command" Command Parameters
Parameter Type Description
(reset-trap-buffer) Format: optional parameter
reset-trap-buffer reset the trap buffer
Possible values:
- reset-trap-buffer : reset the trap buffer
Description
This chapter gives an overview of nodes that are handled by "IP Management Commands".
Command Tree
----admin
----ip
----vrf-media
- (vrf-slot)
- ip-address
- (remove)
----vrf-stats
- (vrf-id)
----interface
----user
----port
- (port-interface)
- reset
----bridgeport
- (port-interface)
- reset
----vlan-itf-delete
- (vlanid)
Command Description
This command allows the operator to manage the slot-related 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 96.2-1 "Slot-related VRF Management Command" Resource Parameters
Resource Identifier Type Description
(vrf-slot) Format: equipment slot ID.
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> :
<Eqpt::VrfId>
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::VrfId>
- VRF id
ip-address Parameter type: <Ip::V4AddressHex> ip address
Format:
- IPv4-address
Table 96.2-2 "Slot-related VRF Management Command" Command Parameters
Parameter Type Description
(remove) Format: optional parameter
remove remove the entry
Possible values:
- remove : remove the entry
Command Description
This command allows the operator to reset the VRF interface counters.
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:
> admin ip vrf-stats (vrf-id) interface user port (port-interface) reset <Vrf::AdminCounter>
Command Parameters
Table 96.3-1 "IP VRF Interface Reset Management Command" Resource Parameters
Resource Identifier Type Description
(vrf-id) 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> /
<Eqpt::PortId> )
Command Description
Obsolete command, replaced by admin ip vrf-stats (vrf-id) interface user port.
This command allows the operator to reset VRF user interface bridge port counters.
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:
> admin ip vrf-stats (vrf-id) interface user bridgeport (port-interface) reset <Vrf::AdminCounter>
Obsolete command, replaced by admin ip vrf-stats (vrf-id) interface user port.
Command Parameters
Table 96.4-1 "IP VRF Interface bridgeport Reset Management Command" Resource Parameters
Resource Identifier Type Description
(vrf-id) 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 96.4-2 "IP VRF Interface bridgeport Reset Management Command" Command Parameters
Command Description
This command is used only to delete an unassociated vlan interface with a vrf in router mode.
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 this admin command only to remove the unassociated vlan interface.
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 96.5-1 "Vlan Interface Delete Command" Resource Parameters
Resource Identifier Type Description
(vlanid) Format: vlan id
- vlan id
- range: [1...4093]
Description
This chapter gives an overview of nodes that are handled by "DHCP Management Command".
Command Tree
----admin
----dhcp-relay
----user-port
- (user-port)
- (reset-counters)
Command Description
This command allows the operator to manage the DHCP relay user port commands.
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 97.2-1 "DHCP Relay User Port Management Command" Resource Parameters
Resource Identifier Type Description
(user-port) 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> /
<Eqpt::PortId> )
Possible values:
- atm-port : atm port
- bridge-port : bridge port
Description
This chapter gives an overview of nodes that are handled by "Transport Management Commands".
Command Tree
----admin
----transport
----ip-net-to-media
- (interface-name)
- network-addr
- phy-addr
- (delete)
Command Description
This command allows the operator to delete the IP address out of the ARP table.
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 98.2-1 "IP Net-to-media Management Command" Resource Parameters
Resource Identifier Type Description
(interface-name) Format: name of the interface
eth1
Possible values:
- eth1 : control interface
network-addr Parameter type: <Ip::V4AddressHex> ip addr corresponding to
Format: media-dependent physical addr
- IPv4-address
phy-addr Parameter type: <Sys::MacAddr> media-dependent physical addr
Format:
- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Table 98.2-2 "IP Net-to-media Management Command" Command Parameters
Parameter Type Description
(delete) Format: optional parameter
delete delete a ip-net-to-media
Possible values:
- delete : delete a ip-net to media entry
Description
This chapter gives an overview of nodes that are handled by "SNTP Management Commands".
Command Tree
----admin
----sntp
- system-time
Command Description
This node allows the operator to manage SNTP.
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 99.2-2 "SNTP Management Command" Command Parameters
Parameter Type Description
system-time Parameter type: <Sys::timeInSecs> optional parameter
Format: set the system time
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Description
This chapter gives an overview of nodes that are handled by "Transactions Management Commands".
Command Tree
----admin
----transaction
- configure-lock
Command Description
This command allows the operator to manage transactions.
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 100.2-2 "Transaction Configuration Management Command" Command Parameters
Parameter Type Description
configure-lock Parameter type: <Trans::ownerIpAddr> optional parameter
Format: changes the status of the
( acquire configuration lock
| release )
Possible values:
- acquire : prevents other managers from configuring
- release : allow other managers to configure
Description
This chapter gives an overview of nodes that are handled by "Security Management Commands".
Command Tree
----admin
----security
----ext-authenticator
- (port)
- (clear-statistics)
Command Description
This command allows the operator to manage a port or virtual channel in the scope of 802.1x 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 101.2-1 "Security 802.1x Port Authentication Management 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> )
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 101.2-2 "Security 802.1x Port Authentication Management Command" Command
Parameters
Parameter Type Description
(clear-statistics) Format: optional parameter
clear-statistics clear non-accounting statistics
Possible values:
- clear-statistics : clear non-accounting statistics
Description
This chapter gives an overview of nodes that are handled by "MSTP Bridge Management Commands".
Command Tree
----admin
----mstp
----port
- (network-port)
- (clear-protocols)
Command Description
This command allows the operator to manage MSTP related to a 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:
Command Parameters
Table 102.2-1 "Port-related MSTP Management Command" Resource Parameters
Resource Identifier Type Description
(network-port) Format: the identification of a network
<Shub::MstpNetworkPort> port
Field type <Shub::MstpNetworkPort>
- Network Port on Shub
Table 102.2-2 "Port-related MSTP Management Command" Command Parameters
Parameter Type Description
(clear-protocols) Format: optional parameter
clear-protocols clear the list of detected protocols
Possible values:
- clear-protocols : clear the list of detected protocols
Description
This chapter gives an overview of nodes that are handled by "Ping Commands".
Command Tree
----ping
- (ip-addr)
- [no] timeout
- [no] tries
- [no] mtu-size
----vrf
- (vrf)
- [no] timeout
- [no] tries
- [no] mtu-size
Command Description
This command allows the operator to ping another host.
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:
> ping (ip-addr) [ no timeout | timeout <Ip::PingTimeout> ] [ no tries | tries <Ip::PingTries> ] [ no mtu-size |
mtu-size <Ip::PingMtu> ]
Command Parameters
Table 103.2-1 "Ping Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: the ip-address of the node to be
- IPv4-address pinged
Table 103.2-2 "Ping Command" Command Parameters
Parameter Type Description
[no] timeout Parameter type: <Ip::PingTimeout> optional parameter with default
Format: value: 1L
- the maximum time to wait for a response the maximum time to wait for a
- unit: sec response
- range: [1...100]
[no] tries Parameter type: <Ip::PingTries> optional parameter with default
Format: value: 5L
- the number of times the node must be pinged the number of times the node
- range: [1...100] must be pinged
[no] mtu-size Parameter type: <Ip::PingMtu> optional parameter with default
Format: value: 500L
- the size of the data portion of the ping PDU the size of the data portion of the
- unit: bytes ping PDU
- range: [8...2080]
Command Output
Table 103.2-3 "Ping Command" Display parameters
Specific Information
name Type Description
received Parameter type: <Counter> total number of packets received
Command Description
This command allows the operator to ping another host in a given SHUB VRF.
Note: If iSAM in IP aware bridging mode,SHUB acting as dhcp relay agent, a direct subnet route from LT vrf to
shub IP address is mandatory,then ping to CPE WAN IP @ through shub vrf will be sucess else ping to CPE WAN
IP @ through shub vrf will fail. Only one active telnet session is allowed at a particular instance to Ping an IP
Address through SHUB VRF.
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:
> ping (ip-addr) vrf (vrf) [ no timeout | timeout <Ip::PingTimeout> ] [ no tries | tries <Ip::PingTries> ] [ no mtu-size
| mtu-size <Ip::PingMtu> ]
Command Parameters
Table 103.3-1 "Ping Per Vrf Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: the ip-address of the node to be
- IPv4-address pinged
(vrf) Format: the vrf number
- the vrf id which uniquely identify a vrf
- range: [0...127]
Table 103.3-2 "Ping Per Vrf Command" Command Parameters
Parameter Type Description
[no] timeout Parameter type: <Ip::PingTimeout> optional parameter with default
Format: value: 1L
- the maximum time to wait for a response the maximum time to wait for a
- unit: sec response
- range: [1...100]
[no] tries Parameter type: <Ip::PingTries> optional parameter with default
Format: value: 5L
- the number of times the node must be pinged the number of times the node
- range: [1...100] must be pinged
[no] mtu-size Parameter type: <Ip::PingMtu> optional parameter with default
Format: value: 500L
- the size of the data portion of the ping PDU the size of the data portion of the
- unit: bytes ping PDU
- range: [8...2080]
Command Output
Table 103.3-3 "Ping Per Vrf Command" Display parameters
Specific Information
name Type Description
received Parameter type: <Counter> total number of packets received
- counter back
This element is always shown.
sent Parameter type: <UnsignedSignedInteger> total number of packets sent to
- an unsigned integer the destination
This element is always shown.
loss Parameter type: <UnsignedSignedInteger> percentage of lost packets
- an unsigned integer This element is always shown.
mean-delay Parameter type: <Ip::PingDelay> the average round trip delay
- the average round trip delay This element is always shown.
- unit: millisec
max-delay Parameter type: <Ip::PingDelay> the maximum round trip delay
- the average round trip delay This element is always shown.
- unit: millisec
min-delay Parameter type: <Ip::PingDelay> the minimum round trip delay
- the average round trip delay This element is always shown.
- unit: millisec
Description
This chapter gives an overview of nodes that are handled by "Traceroute Commands".
Command Tree
----traceroute
- (ip-addr)
- [no] first-hop
- [no] last-hop
- [no] timeout
- [no] mtu-size
----vrf
- (vrf)
- [no] first-hop
- [no] last-hop
- [no] timeout
- [no] mtu-size
Command Description
This command allows the operator to determine the route to a destination address.
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 104.2-1 "Traceroute Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: the ip-address of the destination
- IPv4-address node
Table 104.2-2 "Traceroute Command" Command Parameters
Parameter Type Description
[no] first-hop Parameter type: <Ip::TracerouteTTL> optional parameter with default
Format: value: 1L
- time-to-live value of IP-header the first hop to try
- range: [1...99]
[no] last-hop Parameter type: <Ip::TracerouteTTL> optional parameter with default
Format: value: 99L
- time-to-live value of IP-header the last hop to try
- range: [1...99]
[no] timeout Parameter type: <Ip::TracerouteTimeout> optional parameter with default
Format: value: 1L
- the maximum time to wait for a response the maximum time to wait for a
- unit: sec response
- range: [1...100]
[no] mtu-size Parameter type: <Ip::TracerouteMtu> optional parameter with default
Format: value: 64L
- the size of the data portion of the PDU the size of the data portion of the
- unit: bytes PDU
- range: [1...100]
Command Output
Table 104.2-3 "Traceroute Command" Display parameters
Specific Information
name Type Description
hop Parameter type: <Ip::TracerouteTTL> the hop number in the route
- time-to-live value of IP-header towards the destination
- range: [1...99] This element is always shown.
hop-ip-addr Parameter type: <Ip::V4AddressOrNotFound> the ip-address of the intermediate
( not-found node or hop
| <Ip::V4Address> ) This element is always shown.
Possible values:
- not-found : ip-address was not found
Field type <Ip::V4Address>
- IPv4-address
delay-1 Parameter type: <Ip::TraceReachTime> the time to receive the response
( no-response on the first request
| unreachable This element is always shown.
| <Ip::TraceReachTime> )
Possible values:
- no-response : no response
- unreachable : unreachable
Field type <Ip::TraceReachTime>
- the time to reach this node if at all successful
- unit: msec
- range: [-2...2147483647]
delay-2 Parameter type: <Ip::TraceReachTime> the time to receive the response
( no-response on the second request
| unreachable This element is always shown.
| <Ip::TraceReachTime> )
Possible values:
- no-response : no response
- unreachable : unreachable
Field type <Ip::TraceReachTime>
- the time to reach this node if at all successful
- unit: msec
- range: [-2...2147483647]
delay-3 Parameter type: <Ip::TraceReachTime> the time to receive the response
( no-response on the third request
| unreachable This element is always shown.
| <Ip::TraceReachTime> )
Possible values:
- no-response : no response
- unreachable : unreachable
Field type <Ip::TraceReachTime>
- the time to reach this node if at all successful
- unit: msec
- range: [-2...2147483647]
Command Description
This command allows the operator to determine the route to a destination address for a given SHUB VRF.
Note: If iSAM in IP aware bridging mode,SHUB acting as dhcp relay agent, a direct subnet route from LT vrf to
shub IP address is mandatory,then trace route to CPE WAN IP @ through shub vrf will be sucess else trace route
to CPE WAN IP @ through shub vrf will fail.
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:
> traceroute (ip-addr) vrf (vrf) [ no first-hop | first-hop <Ip::TracerouteTTL> ] [ no last-hop | last-hop
<Ip::TracerouteTTL> ] [ no timeout | timeout <Ip::TracerouteTimeout> ] [ no mtu-size | mtu-size
<Ip::TracerouteMtu> ]
Command Parameters
Table 104.3-1 "Traceroute Per Vrf Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) Format: the ip-address of the destination
- IPv4-address node
(vrf) Format: the vrf number
- the vrf id which uniquely identify a vrf
- range: [0...127]
Table 104.3-2 "Traceroute Per Vrf Command" Command Parameters
Parameter Type Description
[no] first-hop Parameter type: <Ip::TracerouteTTL> optional parameter with default
Format: value: 1L
- time-to-live value of IP-header the first hop to try
- range: [1...99]
[no] last-hop Parameter type: <Ip::TracerouteTTL> optional parameter with default
Format: value: 99L
- time-to-live value of IP-header the last hop to try
- range: [1...99]
[no] timeout Parameter type: <Ip::TracerouteTimeout> optional parameter with default
Format: value: 1L
- the maximum time to wait for a response the maximum time to wait for a
- unit: sec response
- range: [1...100]
[no] mtu-size Parameter type: <Ip::TracerouteMtu> optional parameter with default
Format: value: 64L
Command Output
Table 104.3-3 "Traceroute Per Vrf Command" Display parameters
Specific Information
name Type Description
hop Parameter type: <Ip::TracerouteTTL> the hop number in the route
- time-to-live value of IP-header towards the destination
- range: [1...99] This element is always shown.
hop-ip-addr Parameter type: <Ip::V4AddressOrNotFound> the ip-address of the intermediate
( not-found node or hop
| <Ip::V4Address> ) This element is always shown.
Possible values:
- not-found : ip-address was not found
Field type <Ip::V4Address>
- IPv4-address
delay-1 Parameter type: <Ip::VrfTraceReachTime> the time to receive the response
( no-response on the first request
| unreachable This element is always shown.
| <Ip::TraceReachTime> )
Possible values:
- no-response : no response
- unreachable : unreachable
Field type <Ip::TraceReachTime>
- the time to reach this node if at all successful
- unit: msec
- range: [-2...2147483647]
delay-2 Parameter type: <Ip::VrfTraceReachTime> the time to receive the response
( no-response on the second request
| unreachable This element is always shown.
| <Ip::TraceReachTime> )
Possible values:
- no-response : no response
- unreachable : unreachable
Field type <Ip::TraceReachTime>
- the time to reach this node if at all successful
- unit: msec
- range: [-2...2147483647]
delay-3 Parameter type: <Ip::VrfTraceReachTime> the time to receive the response
( no-response on the third request
| unreachable This element is always shown.
| <Ip::TraceReachTime> )
Possible values:
- no-response : no response
- unreachable : unreachable
Field type <Ip::TraceReachTime>
- the time to reach this node if at all successful
- unit: msec
- range: [-2...2147483647]
Command Description
This command displays the last commands entered at the terminal.
A maximum of 20 commands can be stored. A command that is identical to the previous command is not stored.
Commands containing syntax and semantic errors are also stored in the history buffer. This way a user can correct
a command without retyping the command completely.
Each command is preceeded by a sequence number.
The sequence number does not increment when a command is not stored because it is identical to the previous
command.
Example :
esam># history
1 : history
esam># echo "first command"
first command
esam># echo "second command"
second command
esam># echo "second command"
second command
esam># history
1 : history
2 : echo "first command"
3 : echo "second command"
4 : history
esam>#
User Level
The command can be accessed and executed by any operator.
This command can be executed by all users.
Command Syntax
The command has the following syntax:
> history
Command Description
This command echoes a string to the standard output.
User Level
The command can be accessed and executed by any operator.
This command can be accessed by any user.
Command Syntax
The command has the following syntax:
Command Parameters
Table 105.2-2 "Echo Command" Command Parameters
Options Type Description
[no] (message) Format: optional parameter with default
- a long message value: ""
- length: x<=512 the string to be echoed
Command Description
This command establishes a telnet session to another server.
The telnet session will last until the connection is closed by the telnet server or when the operator enters the
character Control-^.
The session inactivity-time protection will not put any messages on the screen when you are executing the telnet
command. Your connection will be broken without warning if the inactivity timeout expires.
User Level
The command can be accessed and executed by an operator with shub privilege.
This command can only be executed by users having read or write access to functions located in the SHub.
The command can only be executed from a telnet terminal, not from a craft terminal.
Command Syntax
The command has the following syntax:
Command Parameters
Table 105.3-2 "Telnet Command" Command Parameters
Options Type Description
(destination) Format: optional parameter
shub identification of the telnet server
Possible values:
- shub : the shub
Command Description
This command executes CLI commands found in a text file. A file containing CLI commands is called a script file.
A script file must follow the same syntax rules as commands entered interactively. Only the tab and the question
mark lose their special meaning in a script, so command expansion and single-line help are not available.
When initiating the execution of a script, the operator can choose how the system must behave in case of an error
in a CLI command. By default the script will be aborted. Other command-line options are: ignore the error and
proceed executing the script or prompt the operator. When prompted the operator can choose to either abort the
script or ignore the error and proceed. When prompted due to an error, the operator may wish to open a separate
CLI session to take some corrective action for the failed command and then revert to the session where the script is
running to continue with the next command.
A command may be preceded by a minus '-' to prevent the script from being aborted in case of a semantic error; for
example, when you try to delete a node instance that does not exist. In case a minus-sign precedes the command
and the error is a semantic error, then the operator will not be prompted.
By default, a command script does not interact with the user. The execution of the script will be aborted if a
command or filter requires interaction with the user. Interactivity can be enabled by specifying the interactive
option with the exec command.
The exec command may not be used in a command script, so command scripts may not be nested.
Script files are typically stored in the /var/cmd directory.
A script file can be used to restore a configuration. This can be done by reloading an initial and working
configuration script. Alternatively, the complete configuration of an existing system can be captured. A
configuration script is produced by means of the command info configure <configuration node> | tee <script
name> and the script is stored in file /var/cmd/<script name> . Subsequently, the retrieved file needs editing as the
output is not guaranteed to be in line with the CLI sequences required to configure a new system. The configuration
can then be restored on an empty system with the command exec /var/cmd/<script name> .
Warning: the /var/cmd is cleaned when the system resets, so the configuration file must be transferred to another
system with tftp before resetting the system.
Note: saving and restoring the configuration will not work for areas in which resource identifiers are assigned
dynamically by the system.
User Level
The command can be accessed and executed by any operator.
This command can be executed by all users. However, the execution of the script will be aborted when the CLI
parser tries to execute the first command in the script for which the user does not have authorization.
Command Syntax
The command has the following syntax:
Command Parameters
Command Description
This command pauses the execution for the specified number of seconds.
This command is typically used in scripts (see : the exec command).
User Level
The command can be accessed and executed by any operator.
This command can be executed by any user.
Command Syntax
The command has the following syntax:
Command Parameters
Table 105.5-2 "Sleep Command" Command Parameters
Options Type Description
(time) Format: optional parameter
- the period to sleep the period to sleep
- unit: sec
- range: [1...100]
Command Description
This command displays the structure of a node and its subnodes.
User Level
The command can be accessed and executed by any operator.
This command can be executed by any user on a node to which he has read or write access.
The output does not contain any information related to subnodes to which the user has no access.
Command Syntax
The command has the following syntax:
Command Parameters
Table 105.6-2 "Tree Command" Command Parameters
Options Type Description
[no] detail Parameter type: boolean optional parameter
show the details
Command Description
This command writes a message to the terminal of the addressee.
The message can be directed to a user, all user with the same user profile or to all users.
Messages are only delivered to users that are logged in. Users that are not logged in, will not receive the message.
The sender will also receive the message if it is one of the addressees.
User Level
The command can be accessed and executed by any operator.
This command can be used by any user.
Command Syntax
The command has the following syntax:
Command Parameters
Table 105.7-2 "Write Command" Command Parameters
Options Type Description
to Parameter type: <Option::MessageDestination> optional parameter
Format: the destination of the message
( all
| operator : <Sec::OperatorName>
| profile : <Sec::ProfileName> )
Possible values:
- all : all active sessions
- operator : all sessions of the operator with that name
- profile : all sessions of operators with that profile name
Field type <Sec::OperatorName>
- the name of an operator
- range: [a-z0-9]
- length: 1<=x<=11
Field type <Sec::ProfileName>
- the name of an operator profile
- range: [a-z0-9]
- length: 1<=x<=11
(message) Format: optional parameter
- a message the message
- length: x<=256
Command Description
This command logs the user out.
User Level
The command can be accessed and executed by any operator.
This command can be executed by any user.
Command Syntax
The command has the following syntax:
> logout
Command Description
This command gives the user detailed information on a subject.
By default the command gives information on the current node.
User Level
The command can be accessed and executed by any operator.
This command can be executed by each user. A user will only be able to get help for nodes for which he has read or
write access.
Command Syntax
The command has the following syntax:
> help
Command Description
This command shows the configuration of the current node and all of its subnodes.
The user can select three different output formats:
The default is hierarchical command format.
An other format is the flat command format. The output in this format can be saved in a file with the tee filter
and can be executed with the exec command. This way a saved configuration can be restored on an empty
system.
The other format is XML. The output in this format is much more suited as input for tools because it is less
sensitive to further changes.
User Level
The command can be accessed by any operator.
This command can be accessed in all nodes to which the user has read access. It is not available in admin and
show nodes or their subnodes.
The output will only contain information for the nodes for which the user has read access.
Command Syntax
The command has the following syntax:
Command Parameters
Table 105.10-2 "Info Command" Command Parameters
Options Type Description
[no] detail Parameter type: boolean optional parameter
show the details
(format) Format: optional parameter
( hierarchical the format in which the command
| flat output is printed
| xml )
Possible values:
- hierarchical : show the output in hierarchical command
format
- flat : show the output in flat command format
- xml : show the output in XML format
Command Description
This command changes the current position to the parent node of the current position. This command always
succeeds, even if the current position is the top node. The command has no effect in this case.
The option all changes the current position to the top node.
User Level
The command can be accessed and executed by any operator.
This command can be executed by all users
Command Syntax
The command has the following syntax:
Command Parameters
Table 105.11-2 "Exit Command" Command Parameters
Options Type Description
[no] all Parameter type: boolean optional parameter
set the current position to the top
node
Command Description
This command changes the current position to the previous position.
The command will always succeed, even if the previous position no longer exists. The command changes the
current position to the top node in that case.
User Level
The command can be accessed and executed by any operator.
The command can be executed by all users.
Command Syntax
The command has the following syntax:
> back
Command Description
This command deletes a file from the directory /var/cmd. Such file is typically created with the tee filter.
The command will always succeed, even if the specified file does not exist.
User Level
The command can be accessed and executed by any operator.
The command can be executed by all users.
Command Syntax
The command has the following syntax:
Command Parameters
Table 105.13-2 "Delete Command" Command Parameters
Options Type Description
(file) Format: optional parameter
- a file name (example : errors.log) the name of the file to be deleted
- range: [.0-z]
- length: 1<=x<=119
105.14 In Command
Command Description
This command can not be directly executed by the operator. It is the default command for all nodes when no node
attributes are specified, except for all subnodes of configure and the leaf nodes of show.
This command changes the position in the command tree to the current node instance.
User Level
The command can be accessed by any operator.
This command can be executed by any user for the nodes to which he has read or write access.
Command Description
This command can not be directly executed by the user. It is the default command for the configuration node and
most of its subnodes.
This command serves four purposes :
changing the current position in the command tree to a node instance.
creating a node instance. The current position will be changed to the newly created node instance.
modifying one or more attributes of a node instance. The current position in the command tree will be changed
to the modified node instance.
deleting a node instance.
The command changes the current position in the command tree to a node instance in case you specify an existing
node instance and no parameters. Example : configure equipment shelf 1/1. The last character in the default
prompt will be #.
The command creates a node instance in case the node is dynamic and the specified node instance does not exist.
Example : configure system security operator new_user password plain:"hallo#". Parameter values must be
supplied for all mandatory parameters. Parameter values may be supplied for optional parameters. The command
changes the current position in the command tree to the newly created node instance. The last character in the
default prompt will be $.
The command modifies the attributes of a node instance in case the node instance exists and if the user supplies
parameters. Example : configure system security operator existing_user description "a new description"
The command will delete a node instance when it is a dynamic node and the node name is preceed by no. Example
: configure system security no operator existing_user.
The command generates no output
Example 1 - change the current position to an existing static node :
esam# configure system security
esam>configure>system>security#
Example 2 - create a new dynamic node (note that one has to enter the mandatory parameters) :
esam>configure>system>security# operator new profile read password plain:&secret&
esam>configure>system>security>operator>new$
Example 4 - change to an existing dynamic node (note that the prompt is different with example 2) :
esam>configure>system>security>operator>new$ back
esam>configure>system>security# operator new
esam>configure>system>security>operator>new#
Example 7 - request help for a non-existing static node, no parameters or subnodes will be shown
esam>#configure igmp channel 1/1/6/1 ?
<CR> : execute command
esam>#configure igmp channel 1/1/6/1
User Level
The command can be accessed and executed by any operator.
A user can change the current position to each node to which he has read access.
A user can create, modify and delete nodes to which he has write access.
Command Description
This command can not be directly executed by the user. It is the default command for the admin node and most of
its subnodes.
This command serves two purposes :
changing the current position in the command tree to a node instance.
executing an action.
The command changes the current position in the command tree to a node instance in case you specify an existing
node instance and no parameters. From the moment you specify a parameter it will try to execute the
corresponding action.
User Level
The command can be accessed and executed by any operator.
A user can change the current position in the command tree to each node to which he has read access.
A user can execute the action in each node to which he has access.
Command Description
This command shows the runtime data and eventually some important configuration data.
This command can not be executed directly by the user. It is the default command for the leaf nodes of show. It
shows the runtime data.
User Level
The command can be accessed by any operator.
The user can execute this command for all nodes to which he has read access.
Command Parameters
Table 105.17-2 "Show Command" Command Parameters
Options Type Description
[no] detail Parameter type: boolean optional parameter
show the details
[no] xml Parameter type: boolean optional parameter
show the output in XML format
Command Description
This command shows the runtime data and eventually some important configuration data.
This command can not be executed directly by the user. It is the default command for some leaf nodes of show. It
shows the runtime data in a recursive way (similar to info.
User Level
The command can be accessed by any operator.
The user can execute this command for all nodes to which he has read access.
Command Parameters
Table 105.18-2 "Recursive Show Command" Command Parameters
Options Type Description
[no] detail Parameter type: boolean optional parameter
show the details
[no] xml Parameter type: boolean optional parameter
show the output in XML format
Command Description
This command executes a test and shows the test result.
This command can not be executed directly by the user. It is the default command for some leaf nodes of show. It
shows the final test results.
User Level
The command can be accessed by any operator.
The user can execute this command for all nodes to which he has read access.
Command Parameters
Table 105.19-2 "Sample Command" Command Parameters
Options Type Description
[no] detail Parameter type: boolean optional parameter
show the details
[no] xml Parameter type: boolean optional parameter
show the output in XML format
Command Description
This command can not be directly executed by the user. It is the default command for some leaf nodes in show.
This command starts a test and displays at regular time intervals during the specified time period the intermediate
results of the test.
The difference between poll and sample command is that, in poll command the intermediate results are shown
while in sample command only the final results are shown.
User Level
The command can be accessed and executed by any operator.
Command Parameters
Table 105.20-2 "Poll Command" Command Parameters
Options Type Description
[no] detail Parameter type: boolean optional parameter
show the details
[no] xml Parameter type: boolean optional parameter
show the output in XML format
[no] sample-interval Parameter type: <Option::SampleInterval> optional parameter with default
Format: value: 1
- the time between two samples the time between 2 samples
- unit: sec
- range: [1...60]
[no] number-of-samples Parameter type: <Option::SampleCount> optional parameter with default
Format: value: "unlimited"
( unlimited the number of samples to be
| <Option::SampleCount> ) taken
Possible values:
- unlimited : sampling continues until stopped by the user
Field type <Option::SampleCount>
- the number of samples to be taken
- range: [1...1000]
Command Description
This filter counts the number of output characters, words or lines and adds this information at the end of the
output.
User Level
This filter can be used by any user.
Command Syntax
The command has the following syntax:
Command Parameters
Table 106.1-2 "Count Filter" Command Parameters
Parameter Type Description
[no] lines Parameter type: boolean optional parameter
counts the number of lines
[no] words Parameter type: boolean optional parameter
counts the number of words
[no] characters Parameter type: boolean optional parameter
counts the number of characters
[no] summary Parameter type: boolean optional parameter
only the lines with the count
summary are printed
Command Description
This filter allows the user to filter selectively lines from the output based on the contents of these lines.
The user specifies a string with exact:.
He can then decide if a line that contains this string is kept (no skip) or discarded (skip) or he can use the filter to
keep all lines before the first match (before) or after (including) the first match (after).
The matching operation can be case-sensitive (no case-insensitive) or case-insensitive (case-insensitive).
User Level
This filter can be used by any user.
Command Syntax
The command has the following syntax:
Command Parameters
Table 106.2-2 "Match Filter" Command Parameters
Parameter Type Description
(pattern) Format: optional parameter
exact : <PrintableString> describes what
Possible values: needed(exact:|pattern:)<PrintableString>
- exact : exact:<PrintableString> the string must match
exactly
Field type <PrintableString>
- printable string
[no] case-insensitive Parameter type: boolean optional parameter
matching is case-insensitive
[no] (skip) Format: optional parameter with default
( skip value: "match"
| match matched lines are skipped
| before
| after )
Possible values:
- skip : matched lines are skipped
- match : matched lines are selected
- before : lines found before the first match are selected
- after : lines found after the first match are selected
Command Description
This filter writes the output also to a file. The file will be placed in the directory /var/cmd.
The user can decide if the output must be appended to the file or not.
User Level
This filter can be used by any operator.
Command Syntax
The command has the following syntax:
Command Parameters
Table 106.3-2 "Tee Filter" Command Parameters
Parameter Type Description
(file) Format: optional parameter
- a file name (example : info.log) the name of the file
- range: [.0-z]
- length: 1<=x<=13
[no] append Parameter type: boolean optional parameter
append if the file exists
107.1 More
Command Description
This printer allows the user to see the command output at the pace he wants.
User Level
This printer can be used by any user.
Command Syntax
The command has the following syntax:
> more
107.2 No-More
Command Description
This printer prints all output directly to the screen.
User Level
This printer can be used by any user.
Command Syntax
The command has the following syntax:
> no-more
107.3 Discard
Command Description
This printer discards all output. This can be usefull in some scripts.
User Level
This printer can be used by any operator.
Command Syntax
The command has the following syntax:
> discard
Error List
Error list for SNMP
Error Error Description
Number
0 No error
1 General error
2 Invalid Snmp Header
3 Index out of range
4 Community access Violation
5 Access violation
6 Invalid Type
7 Invalid Value
8 Out of Memory
9 Index != Index in entry
10 Cannot change existing row
11 Row not completely specified
12 Snmp Set During Transaction
13 Snmp Set while sets disabled
Error list for ATM MGT
Error Error Description
Number
Successful operation
1 parameter not in valid range
2 name & scope not unique
3 maximum number of profiles reached
4 object in use
5 initialization failure
6 object already exists
7 wrong Atm Interface Snmp configuration
8 wrong Atm Interface Type
9 wrong NgcrAdminWeight
10 wrong access profile index
11 Atm Itf not planned
12 Incoherence with Interface Management
13 Incoherence with ATM Mapper
14 Invalid object reference
15 Cast type mismatch
16 Traffic descriptor mismatch
17 Already crossconnected
18 Topology mismatch
19 Ctp not found
20 Already in requested state
21 Time out on LT reply
22 LT returned failure in reply
23 Wrong tp type
24 Ctp not crossconnected
25 atmItf not found
26 wrapper Failed
27 still Cross Connected
28 wrongly Cross Connected
29 max Nbr VpCtp Reached
30 max Nbr VpTtp Reached
31 max Nbr VcCtp Reached
Abbreviations
IP Internet protocol
Index
ABCDEFGHIJKLMNOPQRSTUVWX
area 513
A area-id
arp
1507
441
a43 125 arp-policy 425
a43c 125 artificial-noise-down 108
aaa 219 asbr-external 1509
aal5-encap-type 150 associated-dialplan 603
abr-type 511 associated-proxyserver 603
accept-expires 1751 associated-regserver 603
accept-frame-type 393 associated-slot 603
accept-starts 518 associate-vlan 415
access 280 atm 219
access-type 610 atm-based-dsl 183
acc-interval 256 atm-overhead-fact 313
acc-server 253 atm-peak-bit-rate 474
acc-stats 1686 atm-pvc 159
ack 189 atm-sus-bit-rate 474
action 1840 audible1 63
activate 295 audible2 63
active-groups 1473 audible3 63
active-streams 477 audible4 63
actor-key 408 audible5 63
actor-port-prio 408 authentication 233
actor-sys-prio 408 authenticator 260
actual-tps-tc-mode 1250 auth-server 251
address 601 auth-stats 1682
admin-p2p 416 auth-type 496
admin-state 1220 auto-backup-intvl 298
admin-status 83 autofetch 295
adsl2-plus 114 availability 1333
adsl-adsl2 110
adsl-band 118 B
advertise 522
ageing-time 392 b43 125
agent 501 back 1835
agent-ip-addr 505 backup 298
aggregate-addr 521 bandwidth 467
aggregate-list 1051 bcast-vlan 501
aggregation 556 board 1208
aggregator-info 1046 bonding-group 696
aggregator-port 408 bonding-mode 140
aggr-reprt-shaper 595 boot-rom 1748
alarm 46 boot-rom-status 1385
alarm-changes 887 bras-ip-address 595
alarm-profile 79 bridge 392
alive-timer 595 bridgeport 430
ansi-t1.424 1220 bridge-port 988
ansi-t1413 1220 bridge-port-fdb 1002
applique 81 buffer-occ-thresh 346
description1 63
description2 63 E
description3 63
description4 63 eapol-stats 1696
description5 63 echo 1822
descriptor-files 1370 efm-based-dsl 183
dest 1129 egress-port 385
destination 243 egress-rate 363
dest-ip-address 1119 encap-type 595
dest-proto 436 engine 487
device 1534 entry 48
dhcp 219 envbox 92
dhcp-linerate 374 environment 41
dhcp-session 1135 eo-conversion 691
diagnostics 1698 eps-quenchfactor 83
dialplan 609 eqpt-holder 665
dialplan-useragent 1607 equipment 219
digitmap 610 error 172
direction 86 es-day-farend 144
directory-number 611 es-day-nearend 144
direct-uri 611 es-farend 144
discard 1852 es-nearend 144
dis-frame-th 348 eth-efm-fact 313
disk-file 1744 ether-dot3 1437
dn-buf-thresh 346 ether-dot3lt 1462
dn-obc-thresh 346 ether-ifmau 1441
domain 260 ether-ifmault 1458
domain-name 264 ether-ifsfplt 1444
domain-server 606 ether-itf 675
dot1p-priority 333 ethernet 1657
dot1p-value 317 ethernet-bandwidth 1075
dot3-coll 1446 ether-sfp 736
dot3-control 1447 ether-shape-rate 177
dot3-pause 1448 ether-tca 734
dot3-status 1450 ethertype 333
download 1740 eth-int 1653
download-set 295 eth-peak-bit-rate 474
down-policer 341 eth-shub 950
down-policy 345 eth-sus-bit-rate 474
drop-rpt-network 463 etsi-dts 1220
dscp 323 etsi-ts 1220
dscp-contract 324 except-cdr-rate 454
dscp-map-dot1p 317 exec 1824
dscp-value 325 exit 1834
dslam-name 595 expires 554
dsl-bandwidth 1071 ext-authenticator 269
dsl-ctrl-pkt-policer 316 extern-aggr-addr 522
dsload-thresh 346 external-device 747
dsl-port 350 external-link-assign 87
dst-ip-addr 184 external-link-host 86
dst-mac-addr 333 external-link-remote 644
dup-mac 1009 ext-source 210
dup-mac-alarm 1009 ext-vlan-id 208
dup-port 1041
dup-vlan-id 1009
dyn-auth-client 255 F
dyn-authclient-stats 1689
f5-loopback-ete 1718
G I
g992-1-a 1220 icmp 163
g992-1-b 1220 id 177
g992-2-a 1220 idle-timeout 278
g992-3-a 1220 ieee-802.3ah 1220
g992-3-am 1220 if-table 1285
g992-3-b 1220 igmp 219
g992-3-l1 1220 igmp-version 446
g992-3-l2 1220 igs-stats 1408
g992-5-a 1220 igs-system 459
g992-5-am 1220 igs-vlan-grp 1477
g992-5-b 1220 ima-group 728
g993-2-12a 1220 ima-link 731
g993-2-12b 1220 imp-noise-prot-dn 99
g993-2-17a 1220 imp-noise-prot-up 99
g993-2-30a 1220 in 1837
g993-2-8a 1220 indeterminate 889
g993-2-8b 1220 indet-log-full-action 59
g993-2-8c 1220 index 1441
g993-2-8d 1220 info 1831
gateway-ip 606 init-authreq-off 1234
general 412 initialize 1234
generate-expires 1751 in-port 187
generate-key 1766 instance 414
generate-starts 518 interface 358
ghstone-set-pwr-ctrl 125 interface-atm-pvc 1228
ghstones-pwr-mode 118 interface-port 1230
glb-leave 459 interval 561
global 346 interval-no 1178
global-session 485 interval-num 1077
group 168 interval-number 1017
group-assembly-time 566 int-no 1560
group-name 235 intvl-number 970
group-profile 567 inventory 1541
grp-index 592 ip 162
grp-membership 1475 ip-addr 164
grp-to-package 1397 ip-address 251
gsmp-retry-time 595
junk-collection 553 M
K mac
mac-address
1000
1301
keep-alive-intvl 496 mac-filter 303
key 279 mac-learning 404
mac-learn-off 1237
major 922
L major-log-full-action 59
management 179
l0-time 102 manager 72
l2-agpow-red-tx 102 map-user-group 235
l2-agpw-to-red-tx 102 margin-down-curr 581
l2-filter 333 margin-down-worst 581
l2forward 745 margin-up-curr 581
l2-time 102 margin-up-worst 581
l3-filter 335 marker 1062
la 407 mask 1516
lacp-mode 408 match 1847
last-hop 1816 max-age 412
last-max-resp-tim 454 max-agpowlev-down 110
last-memb-cnt 454 max-agpowlev-up 110
layer2-oam 595 max-band 118
layer2-terminated 997 max-bitrate 471
layer3-itf 422 max-bitrate-down 99
learned-unicast-mac 1775 max-bitrate-up 99
leave-rsp-timer 461 max-bw 477
license 1353 max-cc 490
line 140 max-delay-down 99
line-feed 611 max-delay-up 99
link 572 max-dst-port 189
link-state-trap 156 max-freq 118
link-type 1507 max-hop-count 412
link-up-changes 1213 max-ingress-rate 369
link-updown-trap 1230 max-line-rate 581
linkup-record 1215 max-mcast-bandwidth 320
llu-relay 709 max-mcast-learn 459
load-thresh 348 max-nbr-pkts 306
local-loop 146 max-noise-down 102
vrf-mapping 1125
vrf-media 1123
vrf-next-index 1126
vrf-route 1119
vrf-statistics 1109
W
warning 900
warn-log-full-action 59
welcome-banner 216
wfq-q1-weight 319
window-size 72
wire-mode 581
wire-pair 1552
write 1828
write-view 229
X
xdsl 219
xdsl-bonding 566
xdsl-int 1141
xdsl-line 1735
xdsl-tca 686
Disclaimers
Alcatel-Lucent products are intended for commercial uses. Without the appropriate network design
engineering, they must not be sold, licensed or otherwise distributed for use in any hazardous
environments requiring fail-safe performance, such as in the operation of nuclear facilities, aircraft
navigation or communication systems, air traffic control, direct life-support machines, or weapons
systems, in which the failure of products could lead directly to death, personal injury, or severe physical
or environmental damage. The customer hereby agrees that the use, sale, license or other distribution
of the products for any such application without the prior written consent of Alcatel-Lucent, shall be at
the customer's sole risk. The customer hereby agrees to defend and hold Alcatel-Lucent harmless from
any claims for loss, cost, damage, expense or liability that may arise out of or in connection with the
use, sale, license or other distribution of the products in such applications.
This document may contain information regarding the use and installation of non-Alcatel-Lucent
products. Please note that this information is provided as a courtesy to assist you. While Alcatel-Lucent
tries to ensure that this information accurately reflects information provided by the supplier, please refer
to the materials provided with any non-Alcatel-Lucent product and contact the supplier for
confirmation. Alcatel-Lucent assumes no responsibility or liability for incorrect or incomplete
information provided about non-Alcatel-Lucent products.
However, this does not constitute a representation or warranty. The warranties provided for
Alcatel-Lucent products, if any, are set forth in contractual documentation entered into by
Alcatel-Lucent and its customers.
This document was originally written in English. If there is any conflict or inconsistency between the
English version and any other version of a document, the English version shall prevail.
Customer documentation
http://www.alcatel-lucent.com/osds
Product manuals and documentation updates are available through the Alcatel-Lucent Support
Documentation and Software Download service at alcatel-lucent.com. If you are a new user
and require access to this service, please contact your Alcatel-Lucent sales representative.
Technical support
http://www.alcatel-lucent.com/support