Professional Documents
Culture Documents
ISAM CLI Command Guide (ISAM+LAN Switch) PDF
ISAM CLI Command Guide (ISAM+LAN Switch) PDF
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.
Contents
1- ISAM CLI 1
1.1 Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.2 CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.3 Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.4 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.5 Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.6 Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.7 Getting help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.8 The CLI Prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.9 Entering CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2- CLI Information 13
2.1 Help Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.2 Logout Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.3 History Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.4 Echo Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.5 Telnet Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.6 Exec Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.7 Sleep Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.8 Tree Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
2.9 Poll Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
2.10 Write Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
2.11 Help Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.12 Info Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.13 Exit Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
2.14 Back Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
2.15 Delete Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.16 In Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
2.17 Configure Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
2.18 Action Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
2.19 Show Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
2.20 Discard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3- Environment Management 34
3.1 Environment Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Commands
Abbreviations 805
Index 807
1.1 Preface
Scope
This User Guide describes the Command Line Interface (CLI) commands supported by the Alcatel 7302 ISAM.
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 in two groups : global and environmental commands.
Global commands (like logout) can be entered in any context and have the same effect in each context.
Environmental commands (like info) can only be entered in some contexts (for example : info can not 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 even
creates this node if it did not exist before.
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.3 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
sub-node. 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 like configure and
show.
Node Creation
A sub-node of the configure node that corresponds to a configurable resource that an operator can create, is called
a dynamic node.
An operator can create such a dynamic node by navigating into 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 possibility to create nodes will of course be limited by the access rights of the user.
It is also possible that the system creates additional sub-nodes 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 sub-nodes. The possibility to delete nodes will of
course be 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.4 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 inbetween. 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 optionally a 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. As
example, we give some possible values for the parameter type ExtendedFileName (the first field is an enumeration
field with as 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, 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 may never be placed within double
quotes. Example: "1"/"1" is a valid shelf identifier, but "1/1" is not a valid shelf identifier.
A field value may 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 in case they contain special characters : double quote ", a
backslash \, a cross #, a space, a tab, a carriage return or a newline. \ is the escape character. \ char is equivalent to
char with 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.
Loops
The values of some resource identifiers may contain numerical ranges for some commands. Numerical ranges are
entered as [ start...end ] in which start and end are integers for which 0 <= end - start <= 1000.
The system will execute a command with a numerical range end - start times in which the numerical range is each
time replaced by a number out of the range.
Numerical ranges have following restrictions:
• One command can only contain 1 numerical range.
• Ranges between quotes are not interpreted as a numerical range.
• Command completion may refuse to work once a numerical range is entered.
• Commands that normally change the context, don't do this once they contain a numerical range.
1.5 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.6 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.
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 by operators with help priviliges.
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 cli commands
Command Description
This command logs the user out.
User Level
The command can be accessed by operators with help priviliges.
This command can be executed by any user.
Command Syntax
The command has the following syntax:
> help cli commands logout
Command Description
This command displays the last commands entered at the terminal.
Maximum 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. In this way a user can
correct a command without the need to retype it completely.
User Level
The command can be accessed by operators with help priviliges.
This command can be executed by all users.
Command Syntax
The command has the following syntax:
> help cli commands history
Command Description
This command echoes a string to the standard output.
User Level
The command can be accessed by operators with help priviliges.
This command can be accessed by any user.
Command Syntax
The command has the following syntax:
> help cli commands echo
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 by operators with help priviliges.
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:
> help cli commands telnet
Command Description
This command executes CLI commands found in a text file. A file containing CLI commands will be called further a
script file.
A script file must follow the same syntax rules as commands entered interactively. Only the tab and the question
mark loose their special meaning in a script, so command expansion and single-line help are not available.
The script will be aborted when one of the commands in the script fails. A command may be preceeded by a minus
'-' to prevent that the script is aborted in case of a semantic error : for example when you try to delete a node
instance which does not exist.
A command script may by default not interact with the user : the execution of the script will be aborted in case a
command or filter requires interaction with the user. Interactivity can be enabled by specifying the option
interactive 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 directory /var/cmd
A script file can be used to restore a configuration. The complete configuration of the system can be stored in a
script with the name /var/cmd/config with the command info configure | tee config. The configuration can be
restored on an empty system with the command exec /var/cmd/config.
Warning : the directory /var/cmd is cleaned when the system resets : so don't forget to transfer the configuration
file 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 by operators with help priviliges.
This command can be executed by all users. The execution of the script will however be aborted when the CLI
parser tries to execute the first command in the script for which the user has no authorization.
Command Syntax
The command has the following syntax:
> help cli commands exec
Command Description
This command pauzes 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 by operators with help priviliges.
This command can be executed by any user.
Command Syntax
The command has the following syntax:
> help cli commands sleep
Command Description
This command displays the structure of a node and its subnodes.
User Level
The command can be accessed by operators with help priviliges.
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:
> help cli commands tree
Command Description
This command can not be directly executed by the user. It is the default command for some nodes related to testing.
This command starts a test and displays during the specified time period the results of the test at regular time
intervals.
User Level
The command can be accessed by operators with help priviliges.
Command Syntax
The command has the following syntax:
> help cli commands poll
Command Description
This command writes a message to the terminal of the adressee.
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 by operators with help priviliges.
This command can be used by any user.
Command Syntax
The command has the following syntax:
> help cli commands write
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 by operators with help priviliges.
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 cli commands help
Command Description
This command shows the configuration of the current node and all its subnodes.
User Level
The command can be accessed by operators with help priviliges.
This command can be accessed in all nodes to which the user has read access. It is not available in admin and
show nodes and their subnodes.
The output will contain only information for the nodes for which the user has read access.
Command Syntax
The command has the following syntax:
> help cli commands info
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 by operators with help priviliges.
This command can be executed by all users
Command Syntax
The command has the following syntax:
> help cli commands exit
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 by operators with help priviliges.
The command can be executed by all users.
Command Syntax
The command has the following syntax:
> help cli commands 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 by operators with help priviliges.
The command can be executed by all users.
Command Syntax
The command has the following syntax:
> help cli commands delete
2.16 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.
User Level
The command can be accessed by operators with help priviliges.
This command can be executed by any user for the nodes to which he has read or write access.
Command Syntax
The command has the following syntax:
> help cli commands in
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 to a node.
• creating a node. The current position will be changed to the newly created node.
• modifying one or more attributes of a node. The current position will be changed to the modified node.
• deleting a node.
The command changes the current position to a node in case you specify an existing node and no parameters.
Example : configure equipment shelf 1/1. The last character in the default prompt will be #.
The command creates a node 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 to the newly created node. The last character in the default prompt will be $.
The command modifies the attributes of a node in case the node instance exists and if the user supplies parameters.
Example : configure system security operator existing description "a new description"
The command will delete a node when it is a dynamic node and the node name is preceed by no. Example :
configure system security no operator existing.
User Level
The command can be accessed by operators with help priviliges.
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 Syntax
The command has the following syntax:
> help cli commands configure
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 to a node.
• executing an action.
The command changes the current position to a node in case you specify an existing node 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 by operators with help priviliges.
A user can change the current position to each node to which he has read access.
A user can execute the action to each node to which he has access.
Command Syntax
The command has the following syntax:
> help cli commands action
Command Description
This command shows the runtime 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 operators with help priviliges.
The user can execute this command for all nodes to which he has read access.
Command Syntax
The command has the following syntax:
> help cli commands show
2.20 Discard
Command Description
This printer discards all output. This can be usefull in some scripts.
User Level
The command can be accessed by operators with help priviliges.
This printer can be used by any operator.
Command Syntax
The command has the following syntax:
> help cli printers discard
Command Description
This node allows to manage the session specific parameters. These parameters are only valid for this session. They
are lost from the moment 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.
How to specify a prompt is explained in the chapter ISAM CLI - The CLI Prompt.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> environment [ no prompt | prompt <Sec::Prompt> ][ no terminal-timeout |
terminal-timeout default | timeout : <Sec::InactivityTimeout> ][ no print | print
<Sec::EnvMore> ]
Command Parameters
Table 3.1-2 "Environment Configuration Command" Command Parameters
Parameter Type Description
prompt <Sec::Prompt> optional parameter with default value: ""
length: x<19 the specification of the prompt
terminal-timeout default | timeout : optional parameter with default value: "timeout :
<Sec::InactivityTimeout> 0"
unit: minutes the maximum time a terminal may be inactive
print <Sec::EnvMore> optional parameter with default value: "default"
Possible values are : specifies the way the output is printed on the
- more : the output is passed via the more terminal
filter
- no-more : the output is put directly on
the terminal
- default : use the method as specified by
the profile
Command Description
Operator can maintain a log containig all state changes of alarms by enabling logging mode and setting the
severity level equal to or higher than severity level for which operator is interested.
Alarm allows to keep track of XDSL lines regularly and maintain a log on it.
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> configure alarm log-sev-level <Alarm::alarmSeverity> log-full-action
<Alarm::alarmLogFullAction> non-itf-rep-sev-level <Alarm::alarmSeverity>
Command Parameters
Table 4.1-2 "Alarm Log Configuration Command" Command Parameters
Parameter Type Description
log-sev-level <Alarm::alarmSeverity> mandatory parameter
Possible values are : set the lowest severity level to log alarms
- 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 <Alarm::alarmLogFullAction> mandatory parameter
Possible values are : set the action if log buffer is full
- wrap : older log records are overwritten
by recent ones
- halt : logging is stopped until the log
buffer is reset
non-itf-rep-sev-level <Alarm::alarmSeverity> mandatory parameter
Possible values are : set minimum severity level to report non itf alarms
- indeterminate : not a definite known
severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
Command Description
Management of local alarms entries.
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> configure alarm entry (index) severity <Alarm::alarmSeverity> [ no service-affecting
| service-affecting ][ no reporting | reporting ][ no logging | logging ]
Command Parameters
Table 4.2-1 "Alarm Entries Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::alarmIndex> alarm type
Possible values are :
- eo-conv-loss : loss of signal in eo
conversion module
- eo-conv-tx : transmission fault in eo
conversion module
- xtca-ne-es : xdsl near end TCA alarm -
errored seconds in 15 min
- xtca-ne-ses : xdsl near end TCA alarm -
severely errored seconds in 15 min
- xtca-ne-uas : xdsl near end TCA alarm -
unavailable seconds in 15 min
- xtca-ne-day-es : xdsl near end TCA
alarm - errored seconds in 1 day
- xtca-ne-day-ses : xdsl near end TCA
alarm - severely errored seconds in 1 day
- xtca-ne-day-uas : xdsl near end TCA
alarm - unavailable seconds in 1 day
- xtca-fe-es : xdsl far end TCA alarm -
errored seconds in 15 min
- xtca-fe-ses : xdsl far end TCA alarm -
severely errored secs in 15 min
- xtca-fe-uas : xdsl far end TCA alarm -
unavailable seconds in 15 min
- xtca-fe-day-es : xdsl far end TCA alarm -
errored seconds in 1 day
- xtca-fe-day-ses : xdsl far end TCA alarm
- severely errored secs in 1 day
- xtca-fe-day-uas : xdsl far end TCA alarm
Command Description
Configuration of Buffer size in alarm table
Operator defines the action to be taken when the alarm log buffer is completely full. If set to Wrap, then older log
records are overwritten by recent ones. If it is set to Halt, then logging is stopped until the log buffer is reset
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> configure alarm delta-log indet-log-full-action <Alarm::alarmDeltaLogFullAction>
warn-log-full-action <Alarm::alarmDeltaLogFullAction> minor-log-full-action
<Alarm::alarmDeltaLogFullAction> major-log-full-action
<Alarm::alarmDeltaLogFullAction> crit-log-full-act <Alarm::alarmDeltaLogFullAction>
Command Parameters
Table 4.3-2 "Alarm Delta Log Configuration Command" Command Parameters
Parameter Type Description
indet-log-full-action <Alarm::alarmDeltaLogFullAction> mandatory parameter
Possible values are : set the action when indeterminate log buffer is full
- wrap : wrap around when log is full
- halt : halt logging when log is full
warn-log-full-action <Alarm::alarmDeltaLogFullAction> mandatory parameter
Possible values are : set the action when indeterminate delta log buffer is
- wrap : wrap around when log is full full
- halt : halt logging when log is full
minor-log-full-action <Alarm::alarmDeltaLogFullAction> mandatory parameter
Possible values are : set the action when minor delta log buffer is full
- wrap : wrap around when log is full
- halt : halt logging when log is full
major-log-full-action <Alarm::alarmDeltaLogFullAction> mandatory parameter
Possible values are : set action when major delta log buffer is full
- wrap : wrap around when log is full
- halt : halt logging when log is full
crit-log-full-act <Alarm::alarmDeltaLogFullAction> mandatory parameter
Possible values are : set action when critical delta log buffer is full
- wrap : wrap around when log is full
- halt : halt logging when log is full
Command Description
This node allows alarm SHub parameters to be configured.
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> configure alarm shub entry (index) severity <Alarm::alarmSeverity> [ no
service-affecting | service-affecting ][ no reporting | reporting ]
Command Parameters
Table 4.4-1 "SHub Alarm Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::ShubAlarmIndex> alarm type
Possible values are :
- 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 doen
status
- mac-conflict : MAC conflict
Table 4.4-2 "SHub Alarm Configuration Command" Command Parameters
Parameter Type Description
severity <Alarm::alarmSeverity> mandatory parameter
Possible values are : assign a severity level to this alarm
- indeterminate : not a definite known
severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
[ no ] <Alarm::alarmServAffect> optional parameter with default value:
service-affecting "noservice-affecting"
defines whether an alarm is service affecting or not
[ no ] reporting <Alarm::alarmRepMode> optional parameter with default value:
"noreporting"
enable or disable reporting of the alarm
Command Description
This node allows to define how important a given trap is.
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> configure trap definition (name) priority <Trap::Priority>
Command Parameters
Table 5.1-1 "Trap Definition Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <Trap::Name> the name of the trap
Possible values are :
- cold-start : entry for cold start trap
- link-down : entry for link down trap
- link-up : entry for link up trap
- auth-failure : entry for authentication
failure trap
- change-occured : entry for change
occured trap
- init-started : entry for initialization
started trap
- lic-key-chg-occr : entry for license key
change occured trap
Table 5.1-2 "Trap Definition Configuration Command" Command Parameters
Parameter Type Description
priority <Trap::Priority> mandatory parameter
Possible values are : the trap priority
- urgent : urgent - needs to be informed
immediately
- high : high priority trap
- medium : medium priority trap
- low : low priority trap
Command Description
This command allows to configure a SNMP manager. This SNMP manager will receive traps when an event
occures in the system.
The manager can be easily flooded by events in case something happens with the system. This command allows to
specify in which traps the manager is interested (trap filtering) and how the traps must be spread in time (trap
shaping).
Traps that can not be delivered will be dropped.
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> configure trap [[no] manager (address) [ no priority | priority <Trap::Priority> ][
no cold-start-trap | cold-start-trap ][ no link-down-trap | link-down-trap ][ no
link-up-trap | link-up-trap ][ no auth-fail-trap | auth-fail-trap ][ no change-trap |
change-trap ][ no init-started-trap | init-started-trap ][ no phys-line-trap |
phys-line-trap ][ no eqpt-change-trap | eqpt-change-trap ][ no success-set-trap |
success-set-trap ][ no other-alarm-trap | other-alarm-trap ][ no warning-trap |
warning-trap ][ no minor-trap | minor-trap ][ no major-trap | major-trap ][ no
critical-trap | critical-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 5.2-1 "Trap Manager Configuration Command" Resource Parameters
Resource Identifier Type Description
(address) <Ip::V4Address> : <Trap::Port> the address of the manager
<Ip::V4Address>: <Trap::Port>= range:
[1...65535]
Table 5.2-2 "Trap Manager Configuration Command" Command Parameters
Parameter Type Description
priority <Trap::Priority> optional parameter with default value: "medium"
Possible values are : lowest priority a trap should have to be reported
- urgent : urgent - needs to be informed
immediately
- high : high priority trap
- medium : medium priority trap
- low : low priority trap
[ no ] cold-start-trap <Trap::ColdStart> optional parameter with default value:
"no-cold-start"
enable sending cold start trap
[ no ] link-down-trap <Trap::LinkDown> optional parameter with default value:
Command Description
This node allows to configure a SNMP manager of the SHub.
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> configure trap shub [[no] manager (address) [ no cold-start-trap | cold-start-trap
][ no auth-fail-trap | auth-fail-trap ][ no change-trap | change-trap ][ no
community-string | community-string <PrintableString-0-255> ][ no snmp-version |
snmp-version <Snmp::SHubVersion> ][ no min-severity | min-severity
<Snmp::SHubAlarmSeverity> ]]
Command Parameters
Table 5.3-1 "SHub Trap Manager Configuration Command" Resource Parameters
Resource Identifier Type Description
(address) <Ip::V4Address> : <Trap::Port> address of the manager
<Ip::V4Address>: <Trap::Port>= range:
[1...65535]
Table 5.3-2 "SHub Trap Manager Configuration Command" Command Parameters
Parameter Type Description
[ no ] cold-start-trap <Trap::SHubColdStart> optional parameter with default value:
"no-cold-start"
enable sending cold start trap
[ no ] auth-fail-trap <Trap::SHubAuthenticationFailure> optional parameter with default value:
"no-auth-failure"
enable sending authentication failure trap
[ no ] change-trap <Trap::SHubChangeOccured> optional parameter with default value:
"no-change-trap"
enable sending of change occured trap
community-string <PrintableString-0-255> optional parameter with default value: "public"
length: x<255 the community string to be used
snmp-version <Snmp::SHubVersion> optional parameter with default value: "v2"
Possible values are : manager type
- v1 : snmp V1 manager type
- v2 : snmp V2 manager type
min-severity <Snmp::SHubAlarmSeverity> optional parameter with default value:
Possible values are : "indeterminate"
- indeterminate : indeterminate lowest severity an alarm must have, to be reported
- warning : warning
- minor : minor
- major : major
Command Description
This node allows 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.
User Level
The command can be accessed by operators with xdsl priviliges, and executed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> configure xdsl [[no] 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 activate | activate ]]
Command Parameters
Table 6.1-1 "Common XDSL Service Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Xdsl::ProfileIndex> index of the profile
range: [1...100]
Table 6.1-2 "Common XDSL Service Profile Configuration Command" Command Parameters
Parameter Type Description
name <AsamProfileName> mandatory parameter
range: [a-zA-Z0-9-_]length: 1<=x<32 profile name
(scope) <AsamProfileScope> optional parameter
Possible values are : scope of the profile
- local-profile : the local profile
- network-profile : the network profile
version <SignedInteger> optional parameter
version maintained by manager, usually 1 for new
profile
ra-mode-down <Xdsl::RAModeDownType> optional parameter with default value: "automatic"
Possible values are : rate adaptation mode for down stream
- operator-ctrld : operator controlled rate
adaptive mode in downstream
- automatic : automatic rate adaptive mode
at startup in downstream
ra-mode-up <Xdsl::RAModeUpType> optional parameter with default value: "automatic"
Command Description
This node allows 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).
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
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.
User Level
The command can be accessed by operators with xdsl priviliges, and executed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> configure xdsl [[no] spectrum-profile (index) name <AsamProfileName> [(scope)
][version <SignedInteger> ][ no op-mode | op-mode <Xdsl::OpModeTypeSpectrumPreDef> ][
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 modification | modification
<Xdsl::ModifyStatus> ][ no activate | activate ]]
Command Parameters
Table 6.2-1 "Common XDSL Spectrum Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Xdsl::ProfileIndex> index of the profile.
range: [1...100]
Table 6.2-2 "Common XDSL Spectrum Profile Configuration Command" Command Parameters
Command Description
This node allows 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 priviliges, and executed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) adsl-adsl2 [ no proprietary-feat |
proprietary-feat ][ no max-agpowlev-down | max-agpowlev-down <Xdsl::PowerLevel> ][ no
max-agpowlev-up | max-agpowlev-up <Xdsl::PowerLevel> ][ no max-psd-down | max-psd-down
<Xdsl::Adsl2PowerSpectralDensityDown> ][ no max-psd-up | max-psd-up
<Xdsl::Adsl2PowerSpectralDensityUp> ][ no pbo-mode | pbo-mode ][ no max-recv-power-up
| max-recv-power-up <Xdsl::RxPowerLevel> ]
Command Parameters
Table 6.3-1 "XDSL Spectrum Profile for ADSL/ADSL2 Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) <Xdsl::ProfileIndex> index of the profile.
range: [1...100]
Table 6.3-2 "XDSL Spectrum Profile for ADSL/ADSL2 Configuration Command" Command
Parameters
Parameter Type Description
[ no ] proprietary-feat <Xdsl::FeatureDisable> optional parameter with default value:
"no-proprietary"
enable proprietary features of the modem
max-agpowlev-down <Xdsl::PowerLevel> optional parameter with default value: 255
range: [0...255] unit: 1/10 * dBm maximum aggregate power allowed in downstream
max-agpowlev-up <Xdsl::PowerLevel> optional parameter with default value: 255
range: [0...255] unit: 1/10 * dBm maximum aggregate power allowed in upstream
max-psd-down <Xdsl::Adsl2PowerSpectralDensityDown> optional parameter with default value: -400
Command Description
This node allows 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 priviliges, and executed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) re-adsl [ no proprietary-feat |
proprietary-feat ][ no max-agpowlev-down | max-agpowlev-down <Xdsl::PowerLevel> ][ no
max-agpowlev-up | max-agpowlev-up <Xdsl::PowerLevel> ][ no max-psd-down | max-psd-down
<Xdsl::ReAdsl2PowerSpectralDensityDown> ][ no max-psd-up | max-psd-up
<Xdsl::ReAdsl2PowerSpectralDensityUp> ][ no pbo-mode | pbo-mode ][ no
max-recv-power-up | max-recv-power-up <Xdsl::RxPowerLevel> ]
Command Parameters
Table 6.4-1 "XDSL Spectrum Profile for RE-ADSL2 Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) <Xdsl::ProfileIndex> index of the profile.
range: [1...100]
Table 6.4-2 "XDSL Spectrum Profile for RE-ADSL2 Configuration Command" Command
Parameters
Parameter Type Description
[ no ] proprietary-feat <Xdsl::FeatureDisable> optional parameter with default value:
"no-proprietary"
enable proprietary features of the modem
max-agpowlev-down <Xdsl::PowerLevel> optional parameter with default value: 255
range: [0...255] unit: 1/10 * dBm maximum aggregate power allowed in downstream
max-agpowlev-up <Xdsl::PowerLevel> optional parameter with default value: 255
range: [0...255] unit: 1/10 * dBm maximum aggregate power allowed in upstream
max-psd-down <Xdsl::ReAdsl2PowerSpectralDensityDown>optional parameter with default value: -370
Command Description
This node allows 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 priviliges, and executed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) adsl2-plus [ no proprietaty-feat |
proprietaty-feat ][ no max-agpowlev-down | max-agpowlev-down <Xdsl::PowerLevel> ][ no
max-agpowlev-up | max-agpowlev-up <Xdsl::PowerLevel> ][ no max-psd-down | max-psd-down
<Xdsl::Adsl2PowerSpectralDensityDown> ][ no max-psd-up | max-psd-up
<Xdsl::Adsl2PowerSpectralDensityUp> ][ no pbo-mode | pbo-mode ][ no max-recv-power-up
| max-recv-power-up <Xdsl::RxPowerLevel> ]
Command Parameters
Table 6.5-1 "XDSL Spectrum Profile for ADSL2 Plus Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) <Xdsl::ProfileIndex> index of the profile.
range: [1...100]
Table 6.5-2 "XDSL Spectrum Profile for ADSL2 Plus Configuration Command" Command
Parameters
Parameter Type Description
[ no ] proprietaty-feat <Xdsl::FeatureDisable> optional parameter with default value:
"no-proprietary"
enable proprietary features of the modem
max-agpowlev-down <Xdsl::PowerLevel> optional parameter with default value: 255
range: [0...255] unit: 1/10 * dBm maximum aggregate power allowed in downstream
max-agpowlev-up <Xdsl::PowerLevel> optional parameter with default value: 255
range: [0...255] unit: 1/10 * dBm maximum aggregate power allowed in upstream
max-psd-down <Xdsl::Adsl2PowerSpectralDensityDown> optional parameter with default value: -400
Command Description
This node allows 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 priviliges, and executed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl [ no vdsl-band-plan | vdsl-band-plan
<Xdsl::VdslBandPlan> ][ no adsl-band | adsl-band ][ no max-agpowlev-down |
max-agpowlev-down <Xdsl::VdslPowerLevel> ][ no max-agpowlev-up | max-agpowlev-up
<Xdsl::VdslPowerLevel> ][ no psd-shape-down | psd-shape-down <Xdsl::VdslPsdShapeDown>
][ no psd-shape-up | psd-shape-up <Xdsl::VdslPsdShapeUp> ][ no pbo-mode | pbo-mode ][
no recv-psd-shape-up | recv-psd-shape-up <Xdsl::RxVdslPsdShapeUp> ]
Command Parameters
Table 6.6-1 "XDSL Spectrum Profile for VDSL Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Xdsl::ProfileIndex> index of the profile.
range: [1...100]
Table 6.6-2 "XDSL Spectrum Profile for VDSL Configuration Command" Command Parameters
Parameter Type Description
vdsl-band-plan <Xdsl::VdslBandPlan> optional parameter with default value:
Possible values are : "band-plan-B3"
- a4 : 4 bands of frequency 998 (ITU-T) the VDSL band plan
- a3 : 3 bands of frequency 998
- a2 : 2 bands of frequency 998
- b4 : 4 bands of frequency 997 (ITU-T)
- b3 : 3 bands of frequency 997
- b2 : 2 bands of frequency 997
- a3-china : 3 bands of china band plan 1
- a2-china : 2 bands of china band plan 1
Command Description
This node allows 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 priviliges, and executed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> configure xdsl line (if-index) service-profile <AsamProfilePointer> spectrum-profile
<AsamProfilePointer> [ no op-mode | op-mode <Xdsl::OpModeTypeLinePreDef> ][ no
carrier-data-mode | carrier-data-mode <Xdsl::CarrierDataMode> ][ no admin-up |
admin-up ]
Command Parameters
Table 6.7-1 "XDSL Line Configuration Command" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Table 6.7-2 "XDSL Line Configuration Command" Command Parameters
Parameter Type Description
service-profile <AsamProfilePointer> mandatory parameter
range: [0...65535] service profile to be configured on this port
spectrum-profile <AsamProfilePointer> mandatory parameter
range: [0...65535] spectrum profile to be configured on this port
op-mode <Xdsl::OpModeTypeLinePreDef> optional parameter with default value: "default"
Possible values are : operational mode allowed by this profile
- default : default value
- adsl-pots : adsl pots
- adsl-isdn : adsl isdn
- adsl2-pots : adsl2 pots
Command Description
This node allows 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 priviliges, and executed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> configure xdsl line (if-index) tca-line-threshold [ no enable | enable ][ no
es-nearend | es-nearend <Xdsl::IntervalTcaThreshold> ][ no ses-nearend | ses-nearend
<Xdsl::IntervalTcaThreshold> ][ no uas-nearend | uas-nearend
<Xdsl::IntervalTcaThreshold> ][ no es-day-nearend | es-day-nearend
<Xdsl::DayTcaThreshold> ][ no ses-day-nearend | ses-day-nearend
<Xdsl::DayTcaThreshold> ][ no uas-day-nearend | uas-day-nearend
<Xdsl::DayTcaThreshold> ][ no es-farend | es-farend <Xdsl::IntervalTcaThreshold> ][ no
ses-farend | ses-farend <Xdsl::IntervalTcaThreshold> ][ no uas-farend | uas-farend
<Xdsl::IntervalTcaThreshold> ][ no es-day-farend | es-day-farend
<Xdsl::DayTcaThreshold> ][ no ses-day-farend | ses-day-farend <Xdsl::DayTcaThreshold>
][ no uas-day-farend | uas-day-farend <Xdsl::DayTcaThreshold> ]
Command Parameters
Table 6.8-1 "XDSL Line TCA Threshold Configuration Command" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Table 6.8-2 "XDSL Line TCA Threshold Configuration Command" Command Parameters
Parameter Type Description
[ no ] enable <Xdsl::TcaEnable> optional parameter with default value: "disable"
enable the reporting of TCA's for this XDSL line
es-nearend <Xdsl::IntervalTcaThreshold> optional parameter with default value: 0
range: [0...900] errored seconds at the near end
ses-nearend <Xdsl::IntervalTcaThreshold> optional parameter with default value: 0
range: [0...900] severely errored seconds at the near end
uas-nearend <Xdsl::IntervalTcaThreshold> optional parameter with default value: 0
range: [0...900] unavailable seconds at the near end
es-day-nearend <Xdsl::DayTcaThreshold> optional parameter with default value: 0
range: [0...86400] errored seconds at the near end for a day
ses-day-nearend <Xdsl::DayTcaThreshold> optional parameter with default value: 0
range: [0...86400] severely errored seconds at the near end for a day
uas-day-nearend <Xdsl::DayTcaThreshold> optional parameter with default value: 0
range: [0...86400] unavailable seconds at the near end for a day
Command Description
This node allows the operator to configure a Permanent Virtual Connection.
User Level
The command can be accessed by operators with atm priviliges, and executed by operators with atm priviliges.
Command Syntax
The command has the following syntax:
> configure atm [[no] pvc (port-index) [ no admin-down | admin-down ][ no
aal5-encap-type | aal5-encap-type llc-snap | llc-snap-routed | llc-nlpid |
vc-mux-bridged-8023 | vc-mux-routed | vc-mux-pppoa | other | automatic | ppp | pppoa
]]
Command Parameters
Table 7.1-1 "ATM PVC Configuration Command" Resource Parameters
Resource Identifier Type Description
(port-index) <Eqpt::Rack> / <Eqpt::Shelf> / the atm static Interface with vpi and vci
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Table 7.1-2 "ATM PVC Configuration Command" Command Parameters
Parameter Type Description
[ no ] admin-down <Atm::adminStatus> optional parameter with default value: "admin-up"
enables or disables the traffic flow
aal5-encap-type llc-snap | llc-snap-routed | llc-nlpid | optional parameter with default value: "llc-snap"
vc-mux-bridged-8023 | vc-mux-routed | AAL5 service specific convergence sublayer encap
vc-mux-pppoa | other | automatic | ppp | type
pppoa
Possible values are :
- llc-snap : logical link control
encapsulation bridged protocol
- llc-snap-routed : logical link control
encapsulation routed protocol
- llc-nlpid : logical link control
encapsulation
- vc-mux-bridged-8023 : virtual channel
multiplex bridged protocol(ethernet)
- vc-mux-routed : virtual channel
multiplex routed protocol
- vc-mux-pppoa : virtual channel
multiplex pppoa protocol
- other : other encapsulation type
- automatic : automatic detection of
encapsulation type
Command Description
This node allows the operator to configure interface management parameters.
User Level
The command can be accessed by operators with equip priviliges, and executed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> configure interface port (port) [ no (admin-up) ][ no (link-updown-trap) ][ no user
| user <Itf::asamIfExtCustomerId> ][ no severity | severity
<Itf::asamIfExtAlmReportingSeverity> ]
Command Parameters
Table 8.1-1 "Network Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> / the interface index
<Eqpt::LtSlot> / <Eqpt::Port> | slip :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> | ethernet : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::NtSlot> :
<Itf::EthernetId> | pppoeses :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vci> : <PPPoE::LogicalSesId> |
ip-gateway : <Vrf::VrfIndex> |
xdsl-channel : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> | atm-if : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> | atm-pvc : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> : <Atm::vpi> : <Atm::vci> |
bridge-port : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> : <Atm::vpi> : <Atm::vci> |
pppoe : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci> | l2-vlan :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Vlan::VlanIndex> | ip :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Ip::LogicalId> |
sw-loopback : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::NtSlot>
Command Description
This node 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 equip priviliges, and executed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> configure interface alarm (index) [ no default-severity | default-severity
<Itf::asamIfExtAlmReportingSeverityDefault> ]
Command Parameters
Table 8.2-1 "Interface Alarm Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Itf::AlarmItfType> index of the IANA ifType
Table 8.2-2 "Interface Alarm Configuration Command" Command Parameters
Parameter Type Description
default-severity <Itf::asamIfExtAlmReportingSeverityDefault>
optional parameter with default value: "major"
Possible values are : default severity to be reported
- 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 node allows the operator to configure parameters related to SHub interface management.
User Level
The command can be accessed by operators with equip priviliges, and executed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> configure interface shub [[no] vlan-id (vlan-id) [ no mtu | mtu <Shub::ifMainMtu> ][
no admin-status | admin-status <Shub::AdminStatus> ]]
Command Parameters
Table 8.3-1 "SHub Management Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) <Vlan::VlanOamIndex> vlan id
range: [1...4093]
Table 8.3-2 "SHub Management Interface Configuration Command" Command Parameters
Parameter Type Description
mtu <Shub::ifMainMtu> optional parameter with default value: 1500
range: [90...9100] MTU for the vlan interface
admin-status <Shub::AdminStatus> optional parameter with default value: "down"
Possible values are : administrative state of the vlan interface
- up : up
- down : down
- auto-up : autoup
Command Description
This node allows the user to configure parameters related to port control configuration of an SHub interface.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure interface shub port (network-port) [ no (negotiate) ]duplex <Sys::Duplex>
speed <Sys::Speed> [ no admin-status | admin-status <Shub::AdminStatus> ][ no
port-type | port-type <Sys::Type> ][ no mc-flooding | mc-flooding ]
Command Parameters
Table 8.4-1 "SHub Port Control Configuration Command" Resource Parameters
Resource Identifier Type Description
(network-port) <Shub::NetworkPort> identifier of the port interface
range: [1...7]
Table 8.4-2 "SHub Port Control Configuration Command" Command Parameters
Parameter Type Description
[ no ] (negotiate) <Sys::PortCtrlMode> optional parameter with default value:
Possible values are : "no-negotiate"
- automatic : determine the parameters of negotiation mode of the port interface parameters
interface automatically
- 10mbps : mode of interface is 10Mbps
- 100mbps : mode of interface is 100Mbps
- 1gbps : mode of interface is 1Gbps
duplex <Sys::Duplex> mandatory parameter
Possible values are : configure port interface data transfer mode
- full : data transfer in full duplex
- half : data transfer in half duplex
speed <Sys::Speed> mandatory parameter
Possible values are : configure port interface speed
- ten-mbps : speed of 10MBPS
- hundred-mbps : speed of 100MBPS
- one-gb : speed of 1GB
admin-status <Shub::AdminStatus> optional parameter with default value: "down"
Possible values are : administrative state of the port
- up : up
- down : down
- auto-up : autoup
port-type <Sys::Type> optional parameter with default value: "unused"
Possible values are : the type of port interface
- user : port to a directly connected user
Command Description
This node allows the operator to configure a slot.
The slot is identified by the physical slot number. The left-most slot in the shelf has as number 1. Following
parameters can be configured for the slot :
• planned type: the board type intended to be placed in the slot. not-planned indicates that one does not have the
intention to put a board in 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 board. A board in locked state can not be used. This attribute is only
supported for the following type of boards: NT (but notice that the system will refuse to lock the NT of a simplex
system), EXT and a managed LSM.
• overrule-sw: the operator can overrule the default software version for this board. This is only supported for
managed LSMs.
User Level
The command can be accessed by operators with equip priviliges, and executed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> configure equipment slot (index) [ no planned-type | planned-type
<Equipm::BoardType> ][ no power-down | power-down ][ no unlock | unlock ]
Command Parameters
Table 9.1-1 "Slot Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Eqpt::Rack> / <Eqpt::Shelf> / the physical number of the slot
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
Table 9.1-2 "Slot Configuration Command" Command Parameters
Parameter Type Description
planned-type <Equipm::BoardType> optional parameter with default value:
Possible values are : "not-planned"
- eant-a : ethernet NT with electrical netw type of board intended to be in this position
itf
- ebnt-a : ethernet NT with optical netw itf
- ecnt-a : ethernet NT with integrated shub
- ealt-a : 48 port ADSL2 LT - POTS
- eblt-a : 48 port multiDSL layer2 LT -
POTS
- eblt-c : 48 port multiDSL layer3 LT -
Command Description
This node allows the operator to configure an applique.
The applique is identified by the physical slot number. The left-most slot in the shelf has as number 1. Following
parameters can be configured for the slot :
• planned type: the applique type intended to be placed in the slot. not-planned indicates that one does not have
the intention to put an applique in that slot.
User Level
The command can be accessed by operators with equip priviliges, and executed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> configure equipment applique (index) [ no planned-type | planned-type
<Equipm::AppliqueType> ]
Command Parameters
Table 9.2-1 "Applique Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Eqpt::Rack> / <Eqpt::Shelf> / the physical number of the applique
<Eqpt::Applique>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Applique>= range: [1...21]
Table 9.2-2 "Applique Configuration Command" Command Parameters
Parameter Type Description
planned-type <Equipm::AppliqueType> optional parameter with default value:
Possible values are : "not-planned"
- eanc-a : NT I/O external shub applique type of applique intended to be in this position
- ecnc-a : NT I/O optical GE applique
- ecnc-b : NT I/O optical FE applique
- psps-a : 48 port multiDSL MII POTS
splitter applique
- psps-b : 48 port multiDSL ETSI (option
A) POTS splitter applique
- psps-c : 48 port multiDSL ETSI (option
B) POTS splitter applique with MTA
- psus-a : 48 port multiDSL ETSI ISDN
splitter applique with MTA
- vpsc-d : 24 port VDSL POTS splitters
- hlpc-f : 24 port ADSL POTS splitters
with MTA
Command Description
This node allows the operator to configure the ISAM. Following parameters can be configured :
• description: a description which can for example be used to describe the location of the ISAM.
User Level
The command can be accessed by operators with equip priviliges, and executed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> configure equipment isam [ no description | description <Description-127> ]
Command Parameters
Table 9.3-2 "ISAM Configuration Command" Command Parameters
Parameter Type Description
description <Description-127> optional parameter with default value: ""
length: x<127 any description to be used by the operator
Command Description
This command allows the operator to configure the rack. Following parameters can be configured for a rack:
• description: a description which for example can be used to describe the location of the rack.
User Level
The command can be accessed by operators with equip priviliges, and executed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> configure equipment rack (index) [ no description | description <Description-127> ]
Command Parameters
Table 9.4-1 "Rack Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Eqpt::Rack> the physcial position of the rack
range: [1...1]
Table 9.4-2 "Rack Configuration Command" Command Parameters
Parameter Type Description
description <Description-127> optional parameter with default value: ""
length: x<127 any description to be used by the operator
Command Description
This node allows the operator to configure the shelf. He can configure following parameters:
• class: the classification of the shelf. Following classes are supported:
- main-ethernet : a shelf class supporting Ethernet-based traffic. Shelves in this class can contain NT and LT.
There must be at least one shelf of this class in the system.
- ext-ethernet : a shelf class supporting Ethernet-based traffic. Shelves in this class can only contain LT.
• planned-type: the type planned for this shelf. not-planned it the operator does not has the intention to put a
shelf at this position.
• unlock: locks or unlocks the shelf.
• description: a description which for example can be used to describe the location of the shelf.
User Level
The command can be accessed by operators with equip priviliges, and executed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> configure equipment shelf (index) class <Equipm::ShelfClass> [ no planned-type |
planned-type <Equipm::ShelfType> ][ no unlock | unlock ][ no description | description
<Description-127> ]
Command Parameters
Table 9.5-1 "Shelf Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Eqpt::Rack> / <Eqpt::Shelf> the physical identification of the shelf
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]
Table 9.5-2 "Shelf Configuration Command" Command Parameters
Parameter Type Description
class <Equipm::ShelfClass> mandatory parameter
the class to which the shelf belongs
planned-type <Equipm::ShelfType> optional parameter with default value:
Possible values are : "not-planned"
- alts-t : ISAM DSL line termination shelf the planned type of the shelf
- aram-b : ISAM-R DSL 2 slot line
termination shelf
- not-planned : holder is not planned
[ no ] unlock <Equipm::HolderAdminStatus> optional parameter with default value: "lock"
changes the administration-status to unlock
description <Description-127> optional parameter with default value: ""
length: x<127 any description to be used by the operator
Command Description
This node allows the user to configure parameters related to the error log.
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> configure error [ no log-full-action | log-full-action <Error::errorLogFullAction> ]
Command Parameters
Table 10.1-2 "Error Log Configuration Command" Command Parameters
Parameter Type Description
log-full-action <Error::errorLogFullAction> optional parameter with default value: "wrap"
Possible values are : set the action when error log buffer is full
- wrap : older log records are overwritten
by recent ones
- halt : logging is stopped until the log
buffer is reset
Command Description
The id 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 ethernet frame shaping rate in kbit/s.
The system-mac is used to configure the system MAC address in ISAM. The systemMacAddr is the MAC address of
LANX interface on 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 priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system id <Sys::systemId> name <PrintableString-0-255> location
<PrintableString-0-255> contact-person <PrintableString-0-255> [ no en-snmp-auth-trap
| en-snmp-auth-trap ][ no ether-shape-rate | ether-shape-rate <Sys::etherShapeRate>
]mgnt-vlan-id <Vlan::VlanId> system-mac <Sys::MacAddr> / <Sys::MacAddr> /
<Sys::Number>
Command Parameters
Table 11.1-2 "System Configuration Command" Command Parameters
Parameter Type Description
id <Sys::systemId> mandatory parameter
range: [a-zA-Z0-9-]length: x<20 the system ID of the NE
name <PrintableString-0-255> mandatory parameter
length: x<255 fully-qualified domain name of the system
location <PrintableString-0-255> mandatory parameter
length: x<255 location of this system
contact-person <PrintableString-0-255> mandatory parameter
length: x<255 info about the contact person for this system
[ no ] <Transport::SnmpAuthTraps> optional parameter with default value:
en-snmp-auth-trap "no-en-snmp-auth-trap"
uniquely identifies a particular access server
ether-shape-rate <Sys::etherShapeRate> optional parameter with default value: 128
range: [128...2000] unit: kbps outgoing ethernet frames shaping rate on
management itf
mgnt-vlan-id <Vlan::VlanId> mandatory parameter
range: [1...4093] configure management vlan id
system-mac <Sys::MacAddr> / <Sys::MacAddr> / mandatory parameter
Command Description
This node allows the operator to configure the IP-address of the system.
User Level
The command can be accessed by operators with security priviliges, and executed by operators with security
priviliges.
Command Syntax
The command has the following syntax:
> configure system management host-ip-address bootp | manual : <Ip::V4Address> /
<Ip::PrefixLengthHost>
Command Parameters
Table 11.2-2 "System Management Host IP-Address Configuration Command" Command
Parameters
Parameter Type Description
host-ip-address bootp | manual : <Ip::V4Address> / mandatory parameter
<Ip::PrefixLengthHost> the host ip-address specification
Command Description
This node 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 transp priviliges, and executed by operators with transp
priviliges.
Command Syntax
The command has the following syntax:
> configure system management [[no] default-route (default-route) ]
Command Parameters
Table 11.3-1 "System Management Default Route Configuration Command" Resource Parameters
Resource Identifier Type Description
(default-route) <Ip::V4Address> IP-address of the default-route
Command Description
This node allows the operator to configure the sntp and its related parameters
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system sntp server-ip-addr <Ip::V4Address> [ no server-port | server-port
<Sys::portNumber> ][ no polling-rate | polling-rate <Sys::pollingRate> ][ no enable |
enable ]
Command Parameters
Table 11.4-2 "System SNTP Configuration Command" Command Parameters
Parameter Type Description
server-ip-addr <Ip::V4Address> mandatory parameter
configure the sntp ip address of the snmp agent
server-port <Sys::portNumber> optional parameter with default value: 123
range: [0...65535] configure the sntp port number of the snmp agent
polling-rate <Sys::pollingRate> optional parameter with default value: 3600
unit: seconds polling rate for the snmp agent
[ no ] enable <Sys::sntpStatus> optional parameter with default value: "disable"
enables or disables the sntp application
Command Description
This node allows the operator to configure the of the SNTP SHub and its related parameters.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub sntp server-ip-addr <Ip::V4Address> [ no server-port |
server-port <Sys::portNumber> ][ no polling-rate | polling-rate <Sys::pollingRate> ][
no enable | enable ]
Command Parameters
Table 11.5-2 "SHub System SNTP Configuration Command" Command Parameters
Parameter Type Description
server-ip-addr <Ip::V4Address> mandatory parameter
configure the sntp ip address of the snmp agent
server-port <Sys::portNumber> optional parameter with default value: 123
range: [0...65535] configure the sntp port number of the snmp agent
polling-rate <Sys::pollingRate> optional parameter with default value: 3600
unit: seconds polling rate for the snmp agent
[ no ] enable <Sys::sntpStatus> optional parameter with default value: "disable"
enables or disables the sntp application
Command Description
This node 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.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter [[no] icmp (index-num) [ no action-drop |
action-drop ][ no dst-ip-addr | dst-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull>
][ no src-ip-addr | src-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> ][ no
msg-type | msg-type <Sys::MsgType> ][ no msg-code | msg-code <Sys::MsgCode> ][ no
direction | direction <Sys::Direction> ]]
Command Parameters
Table 11.6-1 "SHub System ICMP Filter Configuration Commands" Resource Parameters
Resource Identifier Type Description
(index-num) <Sys::Number> L3 Filter rule number
range: [1...65535]
Table 11.6-2 "SHub System ICMP Filter Configuration Commands" Command Parameters
Parameter Type Description
[ no ] action-drop <Sys::L3Action> optional parameter with default value:
"action-allow"
specifies the action to be taken on the packet
dst-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter with default value: "0.0.0.0/0"
destination IP address to be matched with the
packet
src-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter with default value: "0.0.0.0/0"
source IP address to be matched with the packet
msg-type <Sys::MsgType> optional parameter with default value:
Possible values are : "no-icmp-type"
- echo-reply : message type to be checked against the packet
- dest-unreach :
Command Output
Table 11.6-3 "SHub System ICMP Filter Configuration Commands" Display parameters
Specific Information
name Type Description
row-status <WaitRowStatus> the status of the instance
Possible values are : This element is only shown in detail mode.
- active : instance is in use
- not-in-service : instance exists but is not
used
- not-ready : instance exists but can not be
used
Command Description
This node allows the operator to configure the physical ports where the ICMP filter is to be applied.
This command is used for ICMP filters related to incoming traffic.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter icmp (index-num) [[no] in-port (network-port)
]
Command Parameters
Table 11.7-1 "SHub System ICMP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) <Sys::Number> L3 Filter rule number
range: [1...65535]
(network-port) <Shub::NetworkPort> the network port
range: [1...7]
Command Description
This node allows the operator to configure the physical ports where the ICMP filter is to be applied.
This command is used for ICMP filters related to outgoing traffic.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter icmp (index-num) [[no] out-port (port) ]
Command Parameters
Table 11.8-1 "SHub System ICMP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) <Sys::Number> L3 Filter rule number
range: [1...65535]
(port) lt : <Eqpt::Rack> / <Eqpt::Shelf> / the port
<Eqpt::LtSlot> | network :
<Shub::NetworkPort> | nt
Command Description
This node 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
seperate 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.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter [[no] tcp (index-num) [ no action-drop |
action-drop ][ no dst-ip-addr | dst-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull>
][ no src-ip-addr | src-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> ][ 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> ]]
Command Parameters
Table 11.9-1 "SHub System TCP Filter Configuration Commands" Resource Parameters
Resource Identifier Type Description
(index-num) <Sys::Number> L3 Filter rule number
range: [1...65535]
Table 11.9-2 "SHub System TCP Filter Configuration Commands" Command Parameters
Parameter Type Description
[ no ] action-drop <Sys::L3Action> optional parameter with default value:
"action-allow"
specifies the action to be taken on the packet
dst-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter with default value: "0.0.0.0/0"
destination IP address to be matched with the
packet
src-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter with default value: "0.0.0.0/0"
source IP address to be matched with the packet
min-dst-port <Sys::Port> optional parameter with default value: 0
Command Output
Table 11.9-3 "SHub System TCP Filter Configuration Commands" Display parameters
Specific Information
name Type Description
row-status <WaitRowStatus> the status of the instance
Possible values are : This element is only shown in detail mode.
- active : instance is in use
- not-in-service : instance exists but is not
used
- not-ready : instance exists but can not be
used
Command Description
This node allows the operator to configure the physical ports where the TCP filter is to be applied.
This command is used for TCP filters related to incoming traffic.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter tcp (index-num) [[no] in-port (network-port)
]
Command Parameters
Table 11.10-1 "SHub System TCP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) <Sys::Number> L3 Filter rule number
range: [1...65535]
(network-port) <Shub::NetworkPort> the network port
range: [1...7]
Command Description
This node allows the operator to configure the physical ports where the TCP filter is to be applied.
This command is used for TCP filters related to outgoing traffic.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter tcp (index-num) [[no] out-port (port) ]
Command Parameters
Table 11.11-1 "SHub System TCP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) <Sys::Number> L3 Filter rule number
range: [1...65535]
(port) lt : <Eqpt::Rack> / <Eqpt::Shelf> / the port
<Eqpt::LtSlot> | network :
<Shub::NetworkPort> | nt
Command Description
This node 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
seperate 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.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter [[no] udp (index-num) [ no action-drop |
action-drop ][ no dst-ip-addr | dst-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull>
][ no src-ip-addr | src-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> ][ 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> ]]
Command Parameters
Table 11.12-1 "SHub System UDP Filter Configuration Commands" Resource Parameters
Resource Identifier Type Description
(index-num) <Sys::Number> L3 Filter rule number
range: [1...65535]
Table 11.12-2 "SHub System UDP Filter Configuration Commands" Command Parameters
Parameter Type Description
[ no ] action-drop <Sys::L3Action> optional parameter with default value:
"action-allow"
specifies the action to be taken on the packet
dst-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter with default value: "0.0.0.0/0"
destination IP address to be matched with the
packet
src-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter with default value: "0.0.0.0/0"
source IP address to be matched with the packet
min-dst-port <Sys::Port> optional parameter with default value: 0
range: [0...65535] minimum port in the destination port
Command Output
Table 11.12-3 "SHub System UDP Filter Configuration Commands" Display parameters
Specific Information
name Type Description
row-status <WaitRowStatus> the status of the instance
Possible values are : This element is only shown in detail mode.
- active : instance is in use
- not-in-service : instance exists but is not
used
- not-ready : instance exists but can not be
used
Command Description
This node allows the operator to configure the physical ports where the UDP filter is to be applied.
This command is used for UDP filters related to incoming traffic.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter udp (index-num) [[no] in-port (network-port)
]
Command Parameters
Table 11.13-1 "SHub System UDP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) <Sys::Number> L3 Filter rule number
range: [1...65535]
(network-port) <Shub::NetworkPort> the network port
range: [1...7]
Command Description
This node allows the operator to configure the physical ports where the UDP filter is to be applied.
This command is used for UDP filters related to outgoing traffic.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter udp (index-num) [[no] out-port (port) ]
Command Parameters
Table 11.14-1 "SHub System UDP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) <Sys::Number> L3 Filter rule number
range: [1...65535]
(port) lt : <Eqpt::Rack> / <Eqpt::Shelf> / the port
<Eqpt::LtSlot> | network :
<Shub::NetworkPort> | nt
Command Description
This node 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.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter [[no] port-filter (filter-rule) [ no protocol
| protocol <Sys::RestrictedProtocol> ][ no action-drop | action-drop ][ no dst-ip-addr
| dst-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> ][ no src-ip-addr | src-ip-addr
<Ip::V4Address> / <Ip::PrefixLengthFull> ][ no direction | direction <Sys::Direction>
]]
Command Parameters
Table 11.15-1 "SHub System other Protocol Filter Configuration Commands" Resource Parameters
Resource Identifier Type Description
(filter-rule) <Sys::Number> L3 filter rule number
range: [1...65535]
Table 11.15-2 "SHub System other Protocol Filter Configuration Commands" Command
Parameters
Parameter Type Description
protocol <Sys::RestrictedProtocol> optional parameter with default value: "any"
Possible values are : type of protocol to be checked against the packet
- 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
Command Output
Table 11.15-3 "SHub System other Protocol Filter Configuration Commands" Display parameters
Specific Information
name Type Description
row-status <WaitRowStatus> the status of the instance
Possible values are : This element is only shown in detail mode.
- active : instance is in use
- not-in-service : instance exists but is not
used
- not-ready : instance exists but can not be
used
Command Description
This node allows the operator to configure the physical ports where the "other Protocol" filter is to be applied.
This command is used for "other Protocol" filters related to incoming traffic.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter port-filter (filter-rule) [[no] in-port
(network-port) ]
Command Parameters
Table 11.16-1 "SHub System other Protocol Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(filter-rule) <Sys::Number> L3 filter rule number
range: [1...65535]
(network-port) <Shub::NetworkPort> the network port
range: [1...7]
Command Description
This node allows the operator to configure the physical ports where the "other Protocol" filter is to be applied.
This command is used for "other Protocol" filters related to outgoing traffic.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter port-filter (filter-rule) [[no] out-port
(port) ]
Command Parameters
Table 11.17-1 "SHub System other Protocol Filter Out Port List Configuration Command"
Resource Parameters
Resource Identifier Type Description
(filter-rule) <Sys::Number> L3 filter rule number
range: [1...65535]
(port) lt : <Eqpt::Rack> / <Eqpt::Shelf> / the port
<Eqpt::LtSlot> | network :
<Shub::NetworkPort> | nt
Command Description
This node allows the operator to configure the management VLAN filter IP-address.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub filter [[no] shub-manager (index) src-ip-addr <Ip::V4Address>
]
Command Parameters
Table 11.18-1 "SHub System Vlan-Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Sys::SrcIpIndex> index number of the SrcIp
range: [1...100]
Table 11.18-2 "SHub System Vlan-Filter Configuration Command" Command Parameters
Parameter Type Description
src-ip-addr <Ip::V4Address> mandatory parameter
MgmtVlan filter IP address to be matched with the
packet
Command Description
The default ip-address is used when manual mode is selected or when the system fails to obtain an ip-address
dynamically.
Default ip-address, subnet mask and default gateway will only take only effect when the configuration is stored and
restored.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub entry ip [ no ip-cfg-mode | ip-cfg-mode <Sys::DefIpAddr>
]def-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> def-gateway <Ip::V4Address>
Command Parameters
Table 11.19-2 "SHub System IP Group Configuration Command" Command Parameters
Parameter Type Description
ip-cfg-mode <Sys::DefIpAddr> optional parameter with default value: "manual"
Possible values are : specifies how the system get the IP address
- manual : ip address got from the system
- dynamic : ip address got through
dynamic IP address
def-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> mandatory parameter
default IP address of the system
def-gateway <Ip::V4Address> mandatory parameter
default IP Address of the system
Command Description
This node allows the operator to configure the PPP sessions.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub entry id contact <PrintableString> location <PrintableString>
Command Parameters
Table 11.20-2 "SHub System ID Configuration Command" Command Parameters
Parameter Type Description
contact <PrintableString> mandatory parameter
textual identification of the contact person
location <PrintableString> mandatory parameter
physical location of this node
Command Description
This node allows the operator to configure the software for SHub system.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub entry software [ no sw-ver-name | sw-ver-name <Sys::FileName>
]sw-release-num <Sys::ReleaseNum>
Command Parameters
Table 11.21-2 "SHub System Software Group Configuration Command" Command Parameters
Parameter Type Description
sw-ver-name <Sys::FileName> optional parameter with default value: "shub"
length: 1<=x<256 identifies the Name of the shub Software release
sw-release-num <Sys::ReleaseNum> mandatory parameter
length: 1<=x<7 identifies the software version number d.d.d.d
Command Description
This node allows the operator to configure the SHub system vlan group.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub entry vlan ext-vlan-id <Vlan::ExtVlanIndex>
Command Parameters
Table 11.22-2 "SHub System VLAN Group Configuration Command" Command Parameters
Parameter Type Description
ext-vlan-id <Vlan::ExtVlanIndex> mandatory parameter
range: [2...4093] External Vlan id
Command Description
This node allows the operator to configure HTTP access to the SHub system.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure system shub entry status [ no http-access | http-access ]
Command Parameters
Table 11.23-2 "SHub System HTTP Configuration Command" Command Parameters
Parameter Type Description
[ no ] http-access <Sys::HttpStatus> optional parameter with default value:
"no-http-access"
enable http access for the users
Command Description
This node allows the operator to configure the login or welcom banner.
User Level
The command can be accessed by operators with security priviliges, and executed by operators with security
priviliges.
Command Syntax
The command has the following syntax:
> configure system security [ no login-banner | login-banner ][ no welcome-banner |
welcome-banner ]
Command Parameters
Table 12.1-2 "Security Banner Configuration Commmand" Command Parameters
Parameter Type Description
login-banner optional parameter with default value: ""
the banner to be shown before the operator enters
its name
welcome-banner optional parameter with default value: ""
the banner to be shown when the operator logged in
Command Description
This node allows to specify an operator instance.
An operator can log in to the system with the specified name and password once such instance is created.
Operators have a profile. This operator profile determines most of the properties of the operator. The operator
profile must be created before the operator can be created.
The operator profile is assigned at the moment the operator is created. It can not be changed afterwards. If one
wants to do so, one must first delete the operator and recreate it again.
The default values for prompt can be found in configure system security profile profile-name. How to specify a
prompt is explained in chapter ISAM CLI - The CLI Prompt.
Following rules apply to a plain text password:
• The password must consist of at least 6 and maximum 20 printable characters.
• The password must contain at least 1 non-alfanumeric character.
• A new password must be differ from the last 3 passwords.
Never specify a new password via encrypted: because you can enter any hexadecimal string which is not
necessarely linked to a password. It is almost impossible to calculate a password from an encrypted string. This
method to specify passwords is only intented to restore an existing configuration.
An operator will be requested to enter a new password when he logs in for the first time after another operator
changed his password.
There is no separate command to change a password. An operator must change the password in his operator node.
User Level
The command can be accessed by operators with all,forAdmin priviliges, and executed by operators with all
priviliges.
The last operator with security write permissions, can not be deleted.
An operator may be deleted when that operator is still logged-in. The operator instance will only be effectively
removed once the operator logs out or is logged-out by the system.
Operators without security read or write permissions, can never see other operators.
Operators without security write permissions, can never create, delete or modify another operator, but they can
enter the commands to do so. These command will always fail when executed.
Command Syntax
The command has the following syntax:
> configure system security [[no] operator (name) profile <Sec::ProfileName> password
prompt | plain : <Sec::PlainPassword> | encrypted : <Sec::EncryptedPassword> [ no
prompt | prompt <Sec::Prompt> ][ no description | description <Sec::OperatorDesc> ][
no more | more ]]
Command Parameters
Command Description
This node allows to specify an operator profile.
This operator profile determines most of the properties of the operator.
An operator profile is typically used to limit the commands a group of operators can execute to those for which
they have the necessary skills and for which they are responsible.
How to specify a prompt is explained in chapter ISAM CLI - The CLI Prompt.
User Level
The command can be accessed by operators with all,forAdmin priviliges.
The last operator with security write permissions can not be deleted.
The permissions of a profile can not be changed as long as one operator belongs to the profile.
Operators without security read or write permissions, can never see other operator profiles.
Command Syntax
The command has the following syntax:
> configure system security [[no] profile (name) [ no prompt | prompt <Sec::Prompt> ][
no password-timeout | password-timeout <Sec::PasswordTimeout> ][ no terminal-timeout |
terminal-timeout <Sec::InactivityTimeout> ][ 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 ppoe |
ppoe <Sec::Ppoe> ][ 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
Table 12.3-1 "Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <Sec::ProfileName> the name of the profile
range: [a-z0-9]length: 1<=x<11
Table 12.3-2 "Profile Configuration Command" Command Parameters
Parameter Type Description
prompt <Sec::Prompt> optional parameter with default value: "\"%n%d%c
length: x<19 \""
the specification of the prompt
password-timeout <Sec::PasswordTimeout> optional parameter with default value: 0
range: [0...365] unit: days the maximum time a password may be unchanged
terminal-timeout <Sec::InactivityTimeout> optional parameter with default value: 0
range: [0...120] unit: minutes the maximum time a terminal may be inactive
description <Sec::ProfileDesc> optional parameter with default value: ""
length: x<31 any description to be used by the operator
Command Description
This command allows us 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 or
not.
User Level
The command can be accessed by operators with security priviliges, and executed by operators with security
priviliges.
There must be at least one community with read-write priviliges.
Command Syntax
The command has the following syntax:
> configure system security snmp [[no] community (name) [ no privilege | privilege
<Snmp::CommunityPrivilege> ]]
Command Parameters
Table 12.4-1 "Security SNMP Communitie Configurqtion Command" Resource Parameters
Resource Identifier Type Description
(name) <Snmp::CommunityName> the name of the community
length: x<32
Table 12.4-2 "Security SNMP Communitie Configurqtion Command" Command Parameters
Parameter Type Description
privilege <Snmp::CommunityPrivilege> optional parameter with default value: "read-only"
Possible values are : The parameter is not visible during modification.
- read-only : only read priviliges the priviliges we have when we use this community
- read-write : read and write priviliges
- write-only : only write privileges
Command Description
This command allows us 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 or
not.
It is possible to allow only a limited number of ip-adresses to use a given community name.
User Level
The command can be accessed by operators with security priviliges, and executed by operators with security
priviliges.
The community used by the Command Language Interface (CLI) can not be deleted nor modified.
Command Syntax
The command has the following syntax:
> configure system security snmp shub [[no] community (index) name
<PrintableString-0-255> [ no privilege | privilege <Snmp::SHubCommunityPrivilege> ][
no ip-addr | ip-addr <Ip::V4Address> ]]
Command Parameters
Table 12.5-1 "SHub Security SNMP Communitie Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Snmp::SHubCommunityIndex> number of the entry in the community table
range: [0...10]
Table 12.5-2 "SHub Security SNMP Communitie Configuration Command" Command Parameters
Parameter Type Description
name <PrintableString-0-255> mandatory parameter
length: x<255 the name of the community
privilege <Snmp::SHubCommunityPrivilege> optional parameter with default value: "read-only"
Possible values are : the priviliges we have when we use this community
- read-only : only read
- read-write : read and write
ip-addr <Ip::V4Address> optional parameter with default value: "0.0.0.0"
the ip-address from where we may use this
community
Command Description
These are used to configure the domain.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security [[no] domain (name) vrf-index <Aaa::DomainVrfIndex> [ no
vlan-id | vlan-id <Vlan::VlanIndexOrZero> ][ no primary-dns | primary-dns
<Ip::V4Address> ][ no second-dns | second-dns <Ip::V4Address> ][ no primary-nbns |
primary-nbns <Ip::V4Address> ][ no second-nbns | second-nbns <Ip::V4Address> ][ no
sess-timeout | sess-timeout <Aaa::DomainSessionTimeout> ][ no qos-policy | qos-policy
none | name : <Aaa::IgnoredQosProfileName> ]authenticator local | radius :
<Aaa::RadPolicyName> [ no admin-down | admin-down ]]
Command Parameters
Table 12.6-1 "Security Domain Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::DomainName> name of the domain
length: 6<=x<64
Table 12.6-2 "Security Domain Configuration Command" Command Parameters
Parameter Type Description
vrf-index <Aaa::DomainVrfIndex> mandatory parameter
range: [-1,1...127] valid VRF index
vlan-id <Vlan::VlanIndexOrZero> optional parameter with default value: 0
range: [0...4092] a vlan id
primary-dns <Ip::V4Address> optional parameter with default value: "0.0.0.0"
IP address of primary DNS server
second-dns <Ip::V4Address> optional parameter with default value: "0.0.0.0"
IP address of secondary DNS server
primary-nbns <Ip::V4Address> optional parameter with default value: "0.0.0.0"
IP address of primary NBNS server
second-nbns <Ip::V4Address> optional parameter with default value: "0.0.0.0"
IP address of secondary NBNS server
sess-timeout <Aaa::DomainSessionTimeout> optional parameter with default value: 0
range: [0...2147483647] maximum lifetime of a session
qos-policy none | name : optional parameter with default value: "none"
<Aaa::IgnoredQosProfileName> name of the QoS policy that must be applied to this
domain
authenticator local | radius : <Aaa::RadPolicyName> mandatory parameter
type of authenticator
[ no ] admin-down <Aaa::AdminState> optional parameter with default value: "admin-up"
administrative state of the domain
Command Description
This node allows the operator to define domain IP pool.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security domain (name) [[no] ip-pool (name) vrf-index
<Aaa::VrfIndex> priority <SignedInteger> ]
Command Parameters
Table 12.7-1 "Security Domain IP Pool Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::DomainName> name of the domain
length: 6<=x<64
(name) <Aaa::IpAddrPoolName> name of the IP address pool
length: 1<=x<64
vrf-index <Aaa::VrfIndex> vrf associated with this pool
range: [0...255]
Table 12.7-2 "Security Domain IP Pool Configuration Command" Command Parameters
Parameter Type Description
priority <SignedInteger> mandatory parameter
priority associated with this IP pool
Command Description
The (conceptual) table listing the configurable parameters for a user of a particular Domain. This table will be
used for authenticating users locally. If a domain is deleted, then all the users of that domain will be deleted from
this table.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security domain (name) [[no] user (name) password <Password> ]
Command Parameters
Table 12.8-1 "Security Domain User Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::DomainName> name of the domain
length: 6<=x<64
(name) <Aaa::DisplayString> name of the user of a particular domain
length: 6<=x<64
Table 12.8-2 "Security Domain User Configuration Command" Command Parameters
Parameter Type Description
password <Password> mandatory parameter
length: 6<=x<64 user password, minimum 6 characters
Command Description
Help to configure the connection profile parameters.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security [[no] conn-profile (name) version <SignedInteger> [ no
reject-no-domain | reject-no-domain ][ no reject-inv-domain | reject-inv-domain
]domain-name <Aaa::DomainName> ]
Command Parameters
Table 12.9-1 "Security Connection Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> name of connection profile
range: [a-zA-Z0-9-_]length: 1<=x<32
Table 12.9-2 "Security Connection Profile Configuration Command" Command Parameters
Parameter Type Description
version <SignedInteger> mandatory parameter
version number to be associated to the Profile
[ no ] <Aaa::ActNoDomain> optional parameter with default value:
reject-no-domain "accept-no-domain"
user session authentication if no domain name
[ no ] <Aaa::ActInDomain> optional parameter with default value:
reject-inv-domain "accept-inv-domain"
user session authentication if domain name invalid
domain-name <Aaa::DomainName> mandatory parameter
length: 6<=x<64 name of the domain
Command Description
The Operator should give the index indicating for which the connection policy has to be applied and the
profile-index gives the connection profile associated with this policy.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security [[no] conn-policy conn-profile-name <AsamProfileName> ]
Command Parameters
Table 12.10-2 "Security Connection Policy Configuration Command" Command Parameters
Parameter Type Description
conn-profile-name <AsamProfileName> mandatory parameter
range: [a-zA-Z0-9-_]length: 1<=x<32 connection profile associated with this policy
Command Description
This is the (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. A row in
this table (an Ip Pool) can be deleted only when, No domains are using this Pool and no Ipaddresses are already
allocated to user sessions from this Pool. When a row is deleted in this table, then 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 priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security [[no] ip-addr-pool (name) vrf-index <Aaa::VrfIndex>
start-addr <Ip::V4Address> / <Ip::PrefixLength> [ no size | size
<Aaa::IpAddressPoolSize> ][ no admin-down | admin-down ]]
Command Parameters
Table 12.11-1 "Security IP Address Pool Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::IpAddrPoolName> name of the IP address pool
length: 1<=x<64
vrf-index <Aaa::VrfIndex> vrf associated with this pool
range: [0...255]
Table 12.11-2 "Security IP Address Pool Configuration Command" Command Parameters
Parameter Type Description
start-addr <Ip::V4Address> / <Ip::PrefixLength> mandatory parameter
The parameter is not visible during modification.
first address from where allocation of IP addresses
starts
size <Aaa::IpAddressPoolSize> optional parameter with default value: 0
range: [0...1000] The parameter is not visible during modification.
number of IP addresses in the pool from the start
address
[ no ] admin-down <Aaa::AdminState> optional parameter with default value: "admin-up"
administrative state of this IP pool
Command Description
This is the (conceptual) table to be used for reserving/unreserving an IP address from the specified pool. A entry
can only be created when the corresponding entry in the (with same IP address index) is created. An IP address
can be reserved only when the IP address is not allocated to any user session. Once the row is created in this table,
the value for IP address pool status changes into locally reserved. To unreserve an IpAddress, the corresponding
entry should be deleted.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security ip-addr-pool (name) vrf-index <Aaa::VrfIndex> [[no]
reserve-address (ip-address) ]
Command Parameters
Table 12.12-1 "Security IP Address Pool Reserve Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::IpAddrPoolName> name of the IP address pool
length: 1<=x<64
vrf-index <Aaa::VrfIndex> vrf associated with this pool
range: [0...255]
(ip-address) <Ip::V4Address> IP addess to be reserved/unreserved.
Command Description
This is used for enabling / disabling the relay functionality on the SHub.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security radius [ no relay | relay ]
Command Parameters
Table 12.13-2 "Security Radius Client Configuration Command" Command Parameters
Parameter Type Description
[ no ] relay <Aaa::RadiusRelay> optional parameter with default value: "no-relay"
enable radius relay on shub
Command Description
The (conceptual) table listing the RADIUS authentication servers with its configurable parameters. If a entry
(server) has to be deleted, then it must not be associated with any radius Policy. If so, the deletion is not allowed.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security radius [[no] auth-server (name) vrf-index <Aaa::VrfIndex>
ip-address <Ip::V4Address> [ no port | port <Aaa::InetPortNumber> ]secret <Password> [
no retry-limit | retry-limit <Aaa::RadiusRetryLimit> ][ no timeout-limit |
timeout-limit <Aaa::RadiusTimeout> ][ no admin-down | admin-down ][ no dead-interval |
dead-interval <Aaa::RadiusDeadInterval> ]]
Command Parameters
Table 12.14-1 "Security Radius AUTH Server Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::RadAuthServerName> name of RADIUS authentication server
length: 1<=x<64
vrf-index <Aaa::VrfIndex> vrf to which this auth server belongs
range: [0...255]
Table 12.14-2 "Security Radius AUTH Server Configuration Command" Command Parameters
Parameter Type Description
ip-address <Ip::V4Address> mandatory parameter
IP address of RADIUS authentication server
port <Aaa::InetPortNumber> optional parameter with default value: 1812
range: [0...65535] UDP port to which RADIUS auth messages should
be sent
secret <Password> mandatory parameter
length: 6<=x<64 secret string used between RADIUS server and
client
retry-limit <Aaa::RadiusRetryLimit> optional parameter with default value: 3
range: [0...100] no of times RADIUS server be tried before giving
up
timeout-limit <Aaa::RadiusTimeout> optional parameter with default value: 3
range: [1...60] time in sec between retransmission to RADIUS
server
[ no ] admin-down <Aaa::AdminState> optional parameter with default value: "admin-up"
administrative state of the authentication server
Command Description
The (conceptual) table listing the RADIUS accounting servers with its configurable parameters. If a entry (server)
has to be deleted, then it must not be associated with any radius Policy. If so, the deletion is not allowed.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security radius [[no] acc-server (name) vrf-index <Aaa::VrfIndex>
ip-address <Ip::V4Address> [ no port | port <Aaa::InetPortNumber> ]secret <Password> [
no retry-limit | retry-limit <Aaa::RadiusRetryLimit> ][ no timeout-limit |
timeout-limit <Aaa::RadiusTimeout> ][ no admin-down | admin-down ][ no dead-interval |
dead-interval <Aaa::RadiusDeadInterval> ]]
Command Parameters
Table 12.15-1 "Security Radius Accounting Server Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::RadAccServerName> name of the RADIUS accounting server
length: 1<=x<64
vrf-index <Aaa::VrfIndex> vrf to which the RADIUS Acc Server belongs
range: [0...255]
Table 12.15-2 "Security Radius Accounting Server Configuration Command" Command
Parameters
Parameter Type Description
ip-address <Ip::V4Address> mandatory parameter
IP address of RADIUS accounting server
port <Aaa::InetPortNumber> optional parameter with default value: 1813
range: [0...65535] UDP port to which RADIUS accounting messages
be sent
secret <Password> mandatory parameter
length: 6<=x<64 secret string used between RADIUS server and
client
retry-limit <Aaa::RadiusRetryLimit> optional parameter with default value: 10
range: [0...100] no of times RADIUS server be tried before giving
up
timeout-limit <Aaa::RadiusTimeout> optional parameter with default value: 15
range: [1...60] time in sec between retransmission to RADIUS
server
[ no ] admin-down <Aaa::AccAdminState> optional parameter with default value: "admin-up"
Command Description
The (conceptual) table listing the RADIUS Dynamic Authorization Clients with its configurable parameters.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security radius [[no] dyn-auth-client (name) vrf-index
<Aaa::VrfIndex> ip-address <Ip::V4Address> secret <Password> [ no admin-down |
admin-down ]]
Command Parameters
Table 12.16-1 "Security Radius Dynamic AUTH Client Configuration Command" Resource
Parameters
Resource Identifier Type Description
(name) <Aaa::RadDynAuthClientName> name of the RADIUS Dynamic Authorization
length: 1<=x<64 client
vrf-index <Aaa::VrfIndex> vrf to which the RADIUS Dyn Auth Client belongs
range: [0...255]
Table 12.16-2 "Security Radius Dynamic AUTH Client Configuration Command" Command
Parameters
Parameter Type Description
ip-address <Ip::V4Address> mandatory parameter
IP address of RADIUS authentication server
secret <Password> mandatory parameter
length: 6<=x<64 secret string used between RADIUS server and
client
[ no ] admin-down <Aaa::AdminState> optional parameter with default value: "admin-up"
administrative state of the authentication server
Command Description
The (conceptual) table listing the RADIUS policies together with the parameters applicable globally for the
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, then also the corresponding entry in the radius server will also be deleted.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security radius [[no] policy (name) nas-id <Printable-0-64>
nas-ip-address <Ip::V4Address> [ no keep-domain-name | keep-domain-name ][ no
disable-accnt-msg | disable-accnt-msg ][ no acc-interval | acc-interval <Aaa::AccInt>
][ no eap | eap ]]
Command Parameters
Table 12.17-1 "Security Radius Policy Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::RadPolicyName> name of the RADIUS policy
length: 1<=x<64
Table 12.17-2 "Security Radius Policy Configuration Command" Command Parameters
Parameter Type Description
nas-id <Printable-0-64> mandatory parameter
length: x<64 NAS-Identifier used in messages towards the
Radius servers
nas-ip-address <Ip::V4Address> mandatory parameter
NAS-IP-Address used in messages towards the
Radius servers
[ no ] <Aaa::StripDomain> optional parameter with default value:
keep-domain-name "strip-domain-name"
don't strip domain name when sending to RADIUS
server
[ no ] <Aaa::BootFlag> optional parameter with default value:
disable-accnt-msg "enable-accnt-msg"
whether to send accounting messages on reboot
acc-interval <Aaa::AccInt> optional parameter with default value: 0
range: [60...2147483647u,0...0u] Interim Accounting Interval in seconds
[ no ] eap <Aaa::Eap> optional parameter with default value:
"enable-eap"
enable/diasable EAP
Command Description
The (conceptual) table listing the set of RADIUS servers, together with the parameters of that set. The servers that
are put in a set using this table first have to be defined in radius Authenticaion and Accounting server . The value
returned by the radius Server is used by the management station as the value for the index, while creating a new
entry in this table.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security radius policy (name) [[no] servers (index) auth-server
none | name : <Aaa::RadAuthServerName> vrf-index-auth <Aaa::VrfIndex> [ no acc-server
| acc-server none | name : <Aaa::RadAccServerName> ][ no vrf-index-acc | vrf-index-acc
<Aaa::VrfIndex> ]priority <Aaa::Priority> ]
Command Parameters
Table 12.18-1 "Security Radius Server Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::RadPolicyName> name of the RADIUS policy
length: 1<=x<64
(index) <Aaa::RadServerSetIndex> index of RADIUS profile
range: [1...2]
Table 12.18-2 "Security Radius Server Configuration Command" Command Parameters
Parameter Type Description
auth-server none | name : mandatory parameter
<Aaa::RadAuthServerName> the radius authentication server
vrf-index-auth <Aaa::VrfIndex> mandatory parameter
range: [0...255] vrf to which the RADIUS auth server belongs
acc-server none | name : <Aaa::RadAccServerName> optional parameter with default value: "none"
the radius accounting server
vrf-index-acc <Aaa::VrfIndex> optional parameter with default value: 0L
range: [0...255] vrf to which the RADIUS accounting server
belongs
priority <Aaa::Priority> mandatory parameter
range: [1...256] priority of the set of RADIUS servers
Command Description
The authentication parameter is used for the administrative enable/disable state for Port Access Control in a
System.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security pae [ no port-access | port-access ]
Command Parameters
Table 12.19-2 "Security 802.1x PAE System Configuration Command" Command Parameters
Parameter Type Description
[ no ] port-access <Aaa::AuthenticationEnabled> optional parameter with default value:
"no-port-access"
enable/disable state for port access control
Command Description
A table that contains the configuration objects for the Authenticator PAE associated with each port. An entry
appears in this table for each port that may authenticate access to itself.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security pae authenticator (port) [ no controlled-port |
controlled-port <Aaa::PaeControlledPortControl> ][ no quiet-period | quiet-period
<Aaa::paeQuitTime> ][ no tx-period | tx-period <Aaa::paeTime> ][ no supp-timeout |
supp-timeout <Aaa::paeTime> ][ no server-timeout | server-timeout <Aaa::paeTime> ][ no
max-req | max-req <Aaa::paeMaxReq> ]
Command Parameters
Table 12.20-1 "Security 802.1x Port Authentication Configuration Command" Resource
Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Table 12.20-2 "Security 802.1x Port Authentication Configuration Command" Command
Parameters
Parameter Type Description
controlled-port <Aaa::PaeControlledPortControl> optional parameter with default value: "auto"
Possible values are : current value of the controlled Port
- force-unauthorized : force unauthorized
control
- auto : automatic control
- force-authorized : force authorized
control
quiet-period <Aaa::paeQuitTime> optional parameter with default value: 60
range: [0...65535] quietPeriod constant currently used, value in
seconds
tx-period <Aaa::paeTime> optional parameter with default value: 30
range: [1...65535] txPeriod constant currently used, value in seconds
supp-timeout <Aaa::paeTime> optional parameter with default value: 30
range: [1...65535] suppTimeout constant currently used, value in
seconds
Command Description
A table that contains the configuration objects for the Authenticator PAE associated with each port. An entry
appears in this table for each port that may authenticate access to itself.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security pae ext-authenticator (port) [ no authentication |
authentication ][ no init-authreq-off | init-authreq-off ][ no handshake | handshake
][ no handshake-period | handshake-period <Aaa::PortHandShakePeriod> ]
Command Parameters
Table 12.21-1 "Security 802.1x Extension, Port Authentication Configuration Command" Resource
Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Table 12.21-2 "Security 802.1x Extension, Port Authentication Configuration Command"
Command Parameters
Parameter Type Description
[ no ] authentication <Aaa::PortAuthState> optional parameter with default value: "no-authen"
enable 802.1x authentication
[ no ] init-authreq-off <Aaa::PortAuthReq> optional parameter with default value:
"initiate-authreq"
specify initiate authentication request to supplicant
[ no ] handshake <Aaa::PortHandShakeMode> optional parameter with default value:
"no-handshake"
enable handshake for this port
handshake-period <Aaa::PortHandShakePeriod> optional parameter with default value: 15
range: [5...90] specify the handshake time interval
Command Description
A table that contains the configuration objects for the Authenticator PAE associated with each port. An entry
appears in this table for each port that may authenticate access to itself.
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> configure system security pae port (port) [ no initialize | initialize ]
Command Parameters
Table 12.22-1 "Security 802.1x Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Table 12.22-2 "Security 802.1x Port Configuration Command" Command Parameters
Parameter Type Description
[ no ] initialize <Aaa::InitCont> optional parameter with default value:
"no-initialize"
initialization control for this port
Command Description
This node allows transaction parameters to be configured.
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> configure system transaction [ no time-out-value | time-out-value <TimeTicks>
]log-full-action <Trans::logFullaction>
Command Parameters
Table 13.1-2 "Transaction Configuration Command" Command Parameters
Parameter Type Description
time-out-value <TimeTicks> optional parameter with default value: 6000
unit: msec set the timeout for transaction
log-full-action <Trans::logFullaction> mandatory parameter
Possible values are : set action to be taken when the log is full
- wrap : older log records are overwritten
by recent ones
- halt : logging is stopped until the log
buffer is reset
Introduction
The Overall SoftWare Package can be in any one of the states, operational,aborting, downloading, enabled,
disabled, activated and committed. The operator can download the OSWP or set of files, abort its download or
enable or disable its autofetch property etc. The operator can also specify primary and secondary tftp-server ids for
download of 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 2 OSWPs. The status of the first OSWP is
Enabled/Active/Committed while the second one will be 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 SW download process.
The manager requests the system to remove the NotActive/UnCommitted OSWP. The system removes all the
persistent stored files and databases not related to the the Enabled/Active/Committed OSWP. The status of the
OSWP to be removed will be Aborting/NotActive/UnCommitted during the complete remove operation.
After the abort is successful the system will have only one OSWP. The status of this OSWP will be
Enabled/Active/Committed. Only files and databases related to this OSWP are stored persistently in the system.
Enabled/NotActive. The management channel between the system and the manager is established and the system is
not involved in another SW download process.
Manager requests the system to activate the Enabled/NotActive OSWP. Among the available databases the system
first selects the database that is compatible with and linked to the Enabled/NotActive OSWP. Next the system starts
the activation procedure of the NotActive OSWP.
Finally when the activation of Non-active OSWP is sucessful, the system has two OSWPs. The previous NotActive
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 and OSWP the system has two OSWPs. The status of the first OSWP is Enabled/Active/UnCommited
and the status of the second one is Enabled/NotActive/Committed.
Manager requests the system to commit the active OSWP. The system removes all the persistent stored files and
databases that do not belong to the Enabled/Active OSWP. The status of the OSWP to be committed will be
Enabled/Active/Committing during the complete commit operation.
Finally after comit is successful, the system has only one OSWP. The status of this OSWP is
Enabled/Active/Committed. Only files related to this OSWP are stored persistently in the system.
Command Description
This node allows the operator to configure various attributes and parameters of overall software package.
User Level
The command can be accessed by operators with sw priviliges, and executed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> configure software-mngt oswp (index) primary-file-server-id <Ip::V4Address>
second-file-server-id <Ip::V4Address> download-set <SwMngt::downloadSet> autofetch
<SwMngt::autoFetch>
Command Parameters
Table 14.1-1 "Software Management Overall Software Package Configuration Command"
Resource Parameters
Resource Identifier Type Description
(index) <SwMngt::swmOswpIdx> index to the swm oswp table
range: [1...2]
Table 14.1-2 "Software Management Overall Software Package Configuration Command"
Command Parameters
Parameter Type Description
primary-file-server-id <Ip::V4Address> mandatory parameter
tftp server address for overall descriptor file
second-file-server-id <Ip::V4Address> mandatory parameter
second tftp server address for overall descriptor file
download-set <SwMngt::downloadSet> mandatory parameter
Command Description
This command allows the operator to manage the software of the SHub.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure software-mngt shub database [ no restore-src | restore-src <Sys::Restore>
][ no save-dest | save-dest none | flash | remote : <Ip::V4Address> : <Sys::FileName>
]
Command Parameters
Table 14.2-2 "SHub Database Management Command" Command Parameters
Parameter Type Description
restore-src <Sys::Restore> optional parameter with default value: "none"
Possible values are : specifies where from where the database must be
- none : no restore restored from
- flash : restore from flash
save-dest none | flash | remote : <Ip::V4Address> : optional parameter with default value: "none"
<Sys::FileName> specify where the database must be saved
Command Description
These parameters are configure to forwarding or not forwarding of the datagrams, along with whether the TTL
value has been provided by the transport layer or not.
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 transp priviliges, and executed by operators with transp
priviliges.
Command Syntax
The command has the following syntax:
> configure transport ip default-ttl <Ip::TTL>
Command Parameters
Table 15.1-2 "Ethernet IP Configuration Command" Command Parameters
Parameter Type Description
default-ttl <Ip::TTL> mandatory parameter
range: [1...255] default value inserted into the time-to-live field of
the IP header
Command Description
This node allows the operator to configure MAC-filter.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure transport shub [[no] mac-filter (index-num) [ no protocol-type |
protocol-type <Sys::ProtocolType> ]filter any | <Sys::MacAddr> | <Sys::MacAddr> | any
| <Sys::MacAddr> | <Sys::MacAddr> [vlan-id <Sys::VlanId> ][ no action-drop |
action-drop ]]
Command Parameters
Table 15.2-1 "SHub Ethernet MAC-Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(index-num) <Sys::Number> L2 Filter rule number
range: [1...65535]
Table 15.2-2 "SHub Ethernet MAC-Filter Configuration Command" Command Parameters
Parameter Type Description
protocol-type <Sys::ProtocolType> optional parameter with default value: 0
range: [0,1536...65535] specifies the non IP protocol type to be filtered
filter any | <Sys::MacAddr> | <Sys::MacAddr> | mandatory parameter
any | <Sys::MacAddr> | <Sys::MacAddr> specifies to MAC addresses to be matched with the
Possible values are : packet
- any : all source MAC address
- <Sys::MacAddr> : source mac address
- any : all destination MAC address
- <Sys::MacAddr> : destination mac
address
vlan-id <Sys::VlanId> optional parameter
range: [1...4093] Vlan Id to be filtered
[ no ] action-drop <Sys::L2Action> optional parameter with default value:
"action-allow"
specifies the action to be taken on the packet
Command Description
This node allows the operator to configure MAC-filter to a port.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure transport shub mac-filter (index-num) [[no] in-port (port) ]
Command Parameters
Table 15.3-1 "SHub Ethernet MAC-Filter Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) <Sys::Number> L2 Filter rule number
range: [1...65535]
(port) lt : <Eqpt::Rack> / <Eqpt::Shelf> / the port number
<Eqpt::LtSlot> | network :
<Shub::NetworkPort>
Command Description
This node allows the operator to configure the rate limit.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> configure transport shub rate-limit (ctrl-index) [ no lookup-enabled |
lookup-enabled ][ no bcast-pkt-enabled | bcast-pkt-enabled ][ no mcast-pkt-enabled |
mcast-pkt-enabled ]max-nbr-pkts <Sys::RateCtrlLimit>
Command Parameters
Table 15.4-1 "SHub Ethernet Rate Configuration Command" Resource Parameters
Resource Identifier Type Description
(ctrl-index) <Shub::NetworkPort> control index of the rate
range: [1...7]
Table 15.4-2 "SHub Ethernet Rate Configuration Command" Command Parameters
Parameter Type Description
[ no ] lookup-enabled <Sys::DlfStatus> optional parameter with default value:
"lookup-disabled"
destination lookup failure packet transmission
[ no ] <Sys::BcastStatus> optional parameter with default value:
bcast-pkt-enabled "bcast-pkt-disabled"
broadcast packet control transmission
[ no ] <Sys::McastStatus> optional parameter with default value:
mcast-pkt-enabled "mcast-pkt-disabled"
multicast packet control transmission
max-nbr-pkts <Sys::RateCtrlLimit> mandatory parameter
range: [1...65535] limiting value for the maximum number of packets
Command Description
This node allows the operator to configure pre-configured IGMP sources channel parameters.
User Level
The command can be accessed by operators with igmp priviliges, and executed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> configure igmp channel (port) [ no perm-pkg-bitmap | perm-pkg-bitmap <Binary-08-08>
][ no max-num-group | max-num-group <Igmp::ChannelMaxNumGroup> ]
Command Parameters
Table 16.1-1 "IGMP Channel Sources Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port:vpi:vci
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Table 16.1-2 "IGMP Channel Sources Configuration Command" Command Parameters
Parameter Type Description
perm-pkg-bitmap <Binary-08-08> optional parameter with default value: "01 : 00 :
length: 8 00 : 00 : 00 : 00 : 00 : 00"
packages, the user is allowed to join
max-num-group <Igmp::ChannelMaxNumGroup> optional parameter with default value: 0
range: [0...4] max group number this port (ADSL, PVC) can
support
Command Description
The Package is intended primarily for use by a network/element manager such as an AWS to support multiple set of
packages in different regions.
The definition of a package is a group of zero or more multicast sources that share a common access permission.
By grouping the source channels into one or more packages, this gives flexibility for the service provider to deliver
different level of services to the end-users, e.g. "Basic Package", "Middle-Tier Package", "Premium Package", etc.
NOTE:There is no requirement to configure the Package. However, if it is modified, there is no effect whatsoever to
the multicast source.
User Level
The command can be accessed by operators with igmp priviliges, and executed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> configure igmp package (index) [ no name | name <PrintableString-0-32> ][ no
template-name | template-name <PrintableString-0-32> ]template-version <SignedInteger>
Command Parameters
Table 16.2-1 "IGMP Package Bitmaps Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Igmp::PackageIndex> index of the package
range: [1...64]
Table 16.2-2 "IGMP Package Bitmaps Configuration Command" Command Parameters
Parameter Type Description
name <PrintableString-0-32> optional parameter with default value: ""
length: x<32 name of the package
template-name <PrintableString-0-32> optional parameter with default value: ""
length: x<32 name of the service template containing this pkg
template-version <SignedInteger> mandatory parameter
version of the service template containing this pkg
Command Description
This node allows the operator to configure the IGMP system.
User Level
The command can be accessed by operators with igmp priviliges, and executed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> configure igmp system src-ip-address <Ip::V4Address> [ no verify-checksum |
verify-checksum ][ no query-interval | query-interval <Igmp::SystemQueryInterval> ][
no max-rsp-time | max-rsp-time <Igmp::SystemQueryMaxResponseTime> ][ no robustness |
robustness <Igmp::SystemRobustness> ][ no mem-query-int | mem-query-int
<Igmp::MembQueryIntvl> ][ no last-memb-cnt | last-memb-cnt <Igmp::MembQueryCount> ][
no last-max-resp-tim | last-max-resp-tim <Igmp::SystemLastMembMaxRespTime> ][ no
host-report-intv | host-report-intv <Igmp::SystemUnsolicitedReportIntvl> ][ no start |
start ]
Command Parameters
Table 16.3-2 "IGMP System Configuration Command" Command Parameters
Parameter Type Description
src-ip-address <Ip::V4Address> mandatory parameter
the source ip address which is transmitted in every
multicast IP datagram
[ no ] <Igmp::igmpSystemVerifyChecksum> optional parameter with default value:
verify-checksum "verify-checksum-false"
whether IGMP checksum verification is performed
on received IGMP frame or not
query-interval <Igmp::SystemQueryInterval> optional parameter with default value: 125
range: [1...900] unit: sec interval at which general membership queries
transmitted
max-rsp-time <Igmp::SystemQueryMaxResponseTime> optional parameter with default value: 100
range: [1...255] unit: 1/10 sec maximum query response time advertised in
IGMPv2 queries
robustness <Igmp::SystemRobustness> optional parameter with default value: 2
range: [1...10] expected pkt loss on subnet
mem-query-int <Igmp::MembQueryIntvl> optional parameter with default value: 10
range: [2...255] unit: 1/10 sec minimum interval between group-specific queries
last-memb-cnt <Igmp::MembQueryCount> optional parameter with default value: 2
range: [1...10] number of GSQs ( group-specific queries) to be
sent
last-max-resp-tim <Igmp::SystemLastMembMaxRespTime> optional parameter with default value: 2
range: [1...255] unit: 1/10 sec allows shorter max response times
host-report-intv <Igmp::SystemUnsolicitedReportIntvl> optional parameter with default value: 10
range: [1...255] unit: sec interval of repetitions of host's report of group
membership
Command Description
This node allows the operator to configure the IGS System related parameters.
User Level
The command can be accessed by operators with igmp priviliges, and executed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> configure igmp shub igs-system [ no start-snooping | start-snooping ][ no
enable-status | enable-status ]self-ip-addr-mode <Igmp::SelfIpAddressMode>
self-ip-addr <Ip::V4Address> trace-selection <SignedInteger> [ no router-purge-intv |
router-purge-intv <Igmp::RouterInterval> ][ no host-purge-intv | host-purge-intv
<Igmp::HostInterval> ][ no report-fwd-intv | report-fwd-intv <Igmp::ForwardInterval> ]
Command Parameters
Table 16.4-2 "SHub IGMP IGS System Configuration Command" Command Parameters
Parameter Type Description
[ no ] start-snooping <Igmp::SystemControl> optional parameter with default value:
"no-start-snooping"
start the snooping module
[ no ] enable-status <Igmp::Status> optional parameter with default value:
"no-enable-snooping"
enable snooping in the system
self-ip-addr-mode <Igmp::SelfIpAddressMode> mandatory parameter
Possible values are : sets the mode through which IP address can be got
- configure : query by configure
- from-ip : query by ip
self-ip-addr <Ip::V4Address> mandatory parameter
source address while sending IGMP query
trace-selection <SignedInteger> mandatory parameter
specifies what will be traced
router-purge-intv <Igmp::RouterInterval> optional parameter with default value: 125
range: [60...600] unit: sec interval after which router port entry be purged
host-purge-intv <Igmp::HostInterval> optional parameter with default value: 260
range: [130...1225] unit: sec interval after which host port entry be purged
report-fwd-intv <Igmp::ForwardInterval> optional parameter with default value: 10
range: [1...255] unit: sec interval within which next report msg forwarded
Command Description
This node allows the operator to configure SHub Response timer for each Virtual Local Area Network.
User Level
The command can be accessed by operators with igmp priviliges, and executed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> configure igmp shub response-timer (vlan-id) [ no leave-rsp-timer | leave-rsp-timer
<Igmp::LeaveResponse> ]
Command Parameters
Table 16.5-1 "SHub IGMP Response Timer Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) <Vlan::VlanIndex> VlanId for the leave response timer
range: [1...4093]
Table 16.5-2 "SHub IGMP Response Timer Configuration Command" Command Parameters
Parameter Type Description
leave-rsp-timer <Igmp::LeaveResponse> optional parameter with default value: 1
range: [0...10] interval to wait for query response from host
Command Description
This node allows the operator to configure the router port which is reachable.
User Level
The command can be accessed by operators with igmp priviliges, and executed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> configure igmp shub [[no] vlan-router-port (vlan-id) network-port
<Shub::NetworkPort> query-timer <Igmp::VlanRouterQueryTimer> ]
Command Parameters
Table 16.6-1 "SHub IGMP Router Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) <Vlan::VlanId> the id of a vlan for which a network port is
range: [1...4093] reachable
network-port <Shub::NetworkPort> the network port that is reachable
range: [1...7]
Table 16.6-2 "SHub IGMP Router Port Configuration Command" Command Parameters
Parameter Type Description
query-timer <Igmp::VlanRouterQueryTimer> mandatory parameter
range: [60...600] time interval to wait for query packet
Command Description
This node allows the operator to configure the Virutal LAN filter status either to enable or diable the IGMP
snooping on that specific VLAN.
User Level
The command can be accessed by operators with igmp priviliges, and executed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> configure igmp shub vlan-filter (filter-id) [ no snoop-filter | snoop-filter ]
Command Parameters
Table 16.7-1 "SHub IGMP Vlan Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(filter-id) <Igmp::VlanFilterIndex> Vlan Id for which IGMP features is to be disabled
range: [1...4093]
Table 16.7-2 "SHub IGMP Vlan Filter Configuration Command" Command Parameters
Parameter Type Description
[ no ] snoop-filter <Igmp::VlanFilterStatus> optional parameter with default value:
"no-snoop-filter"
enable the snoop filter
Command Description
This node allows the operator to configure general parameters of multicast.
User Level
The command can be accessed by operators with igmp priviliges, and executed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> configure mcast general [ no fast-change | fast-change ][ no pkg-memb-bitmap |
pkg-memb-bitmap <Binary-08-08> ][ no max-bitrate | max-bitrate
<Igmp::GeneralMcastMaxBitRate> ][ no mean-bit-rate | mean-bit-rate
<Igmp::GeneralMcastMeanBitRate> ]
Command Parameters
Table 17.1-2 "Multicast General Group Configuration Command" Command Parameters
Parameter Type Description
[ no ] fast-change <Igmp::generalMulticastFastChanChange> optional parameter with default value:
"fast-change-false"
enable/disable fast channel changes
pkg-memb-bitmap <Binary-08-08> optional parameter with default value: "ff : ff : ff :
length: 8 ff : ff : ff : ff : ff"
package(s) a class D address belongs
max-bitrate <Igmp::GeneralMcastMaxBitRate> optional parameter with default value: 2500
range: [0...100000] unit: kbps reasonable downstream max bitrate in ATM level
mean-bit-rate <Igmp::GeneralMcastMeanBitRate> optional parameter with default value: 2500
range: [0...100000] unit: kbps reasonable downstream mean bitrate in ATM level
Command Description
This node allows the operator to configure the capacity parameters of multicast.
User Level
The command can be accessed by operators with igmp priviliges, and executed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> configure mcast capacity [ no max-num-group | max-num-group
<Igmp::McastCapacityMaxNumGroup> ][ no max-num-uncfg | max-num-uncfg
<Igmp::McastCapacityMaxNumUnCfg> ][ no cfg-res-time | cfg-res-time <Igmp::reserveTime>
][ no uncfg-res-time | uncfg-res-time <Igmp::reserveTime> ]
Command Parameters
Table 17.2-2 "Multicast Capacity Configuration Command" Command Parameters
Parameter Type Description
max-num-group <Igmp::McastCapacityMaxNumGroup> optional parameter with default value: 64
range: [0...256] no of grps the system supports in enough
bandwidth
max-num-uncfg <Igmp::McastCapacityMaxNumUnCfg> optional parameter with default value: 16
range: [0...128] no of uncfg grps the system supports in enough
bandwidth
cfg-res-time <Igmp::reserveTime> optional parameter with default value: 125
unit: sec time to reserve the unused configured groups
uncfg-res-time <Igmp::reserveTime> optional parameter with default value: 0
unit: sec time to reserve the unused unconfigured groups
Command Description
This node allows the operator to configure the source of multicast.
User Level
The command can be accessed by operators with igmp priviliges, and executed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> configure mcast [[no] src (class-d-addr) [ no fast-change | fast-change ][ no
pkg-mem-bitmap | pkg-mem-bitmap <Binary-08-08> ][ no name | name
<PrintableString-0-32> ][ no atm-peak-bit-rate | atm-peak-bit-rate
<Igmp::McastSrcAtmPeakBitRate> ][ no atm-sus-bit-rate | atm-sus-bit-rate
<Igmp::McastSrcAtmSustainBitRate> ]vlan-id <Igmp::McastSrcVLANID> [ no service-name |
service-name <PrintableString-0-32> ]]
Command Parameters
Table 17.3-1 "Multicast Sources Configuration Command" Resource Parameters
Resource Identifier Type Description
(class-d-addr) <MulticastAddress> mcast src address in network-byte
order(big-endian)
Table 17.3-2 "Multicast Sources Configuration Command" Command Parameters
Parameter Type Description
[ no ] fast-change <Igmp::generalMulticastFastChanChange> optional parameter with default value:
"fast-change-false"
enable fast channel change
pkg-mem-bitmap <Binary-08-08> optional parameter with default value: "01 : 00 :
length: 8 00 : 00 : 00 : 00 : 00 : 00"
indicates to which package(s) a class D address
belongs
name <PrintableString-0-32> optional parameter with default value: ""
length: x<32 name of the source
atm-peak-bit-rate <Igmp::McastSrcAtmPeakBitRate> optional parameter with default value: 2500
range: [0...100000] peak bit rate for transmit/downstream traffic
atm-sus-bit-rate <Igmp::McastSrcAtmSustainBitRate> optional parameter with default value: 2500
range: [0...100000] sustainable bit rate for transmit/downstream traffic
vlan-id <Igmp::McastSrcVLANID> mandatory parameter
range: [1...4093] The parameter is not visible during modification.
VLAN for this multicast source
service-name <PrintableString-0-32> optional parameter with default value: ""
length: x<32 name of the service or service provider of this
mcast source
Command Description
This commands allows an operator to create/delete/modify a Virtual Routing and Forwarding 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 there are still PPPoE connections established in the VRF.
Removal of VRF is not possible when there are still IP interface attached or PPPoE connection established in the
VRF.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ip [[no] vrf (index) name <Vrf::VrfName> [ no desc | desc
<Vrf::VrfDescription> ][ no contact | contact <Vrf::VrfContact> ][ no my-ipaddress |
my-ipaddress <Ip::V4Address> ][ no default-ttl | default-ttl <Vrf::DefaultTTL> ][ no
reassem-timeout | reassem-timeout <Gauge> ][ no mode | mode <Vrf::VrfMode> ]]
Command Parameters
Table 18.1-1 "VRF Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Vrf::VrfIndex> the vrf index
range: [1...127]
Table 18.1-2 "VRF Configuration Command" Command Parameters
Parameter Type Description
name <Vrf::VrfName> mandatory parameter
length: 1<=x<32 the name
desc <Vrf::VrfDescription> optional parameter with default value: ""
length: x<32 the description
contact <Vrf::VrfContact> optional parameter with default value: ""
length: x<32 contact information for administration of this VRF
my-ipaddress <Ip::V4Address> optional parameter with default value: "0.0.0.0"
Ip Address of the system within this VRF
default-ttl <Vrf::DefaultTTL> optional parameter with default value: 32
range: [1...255] default value for time-to-live
reassem-timeout <Gauge> optional parameter with default value: 30
maximum seconds the fragments to be held for
reassembly
mode <Vrf::VrfMode> optional parameter with default value: "forwarder"
Possible values are : the mode
- forwarder : acting in forwarder mode
without user to user traffic
- router : acting in router mode
Command Description
This command allows an operator to create/delete an indirect or direct route towards the network and direct route
towards the user-side. The next hop address must match one the IP interfaces towards the network.
Only one default route can be created per VRF. Use address 0.0.0.0 to specify a default route.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ip vrf (index) [[no] route-dest (dest-ip-address) next-hop direct |
user-port : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot> / <Eqpt::Port> : <Atm::vpi>
: <Atm::vci> | <Ip::V4Address> | direct | network : <Vlan::VlanIndex> ]
Command Parameters
Table 18.2-1 "VRF Route Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Vrf::VrfIndex> the vrf index
range: [1...127]
(dest-ip-address) <Ip::V4Address> / <Ip::PrefixLengthFull> inet-address with prefix
next-hop direct | user-port : <Eqpt::Rack> / the next hop IP-address
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> : <Atm::vpi> : <Atm::vci> |
<Ip::V4Address> | direct | network :
<Vlan::VlanIndex>
Command Description
This command allows an operator to create/delete an VLAN bundle.
Deleting the last VLAN will delete the VLAN bundle.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ip [[no] vlan-bind (vlan-id) layer3-itf <Itf::IpoeInterface> ]
Command Parameters
Table 18.3-1 "VLAN Bundle Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) <Vlan::VlanId> specifies the vlan ID.
range: [1...4093]
Table 18.3-2 "VLAN Bundle Configuration Command" Command Parameters
Parameter Type Description
layer3-itf <Itf::IpoeInterface> mandatory parameter
Possible values are : The parameter is not visible during modification.
- new : new ip interface specifies the layer3 interface.
- <Ip::Layer3ID> : the layer3-itf
Command Description
This commands allows an operator to create/delete/modify a Virtual Routing and Forwarding 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 priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ip shub [[no] vrf (index) name <Vrf::ShubVrfName> (modeandcommstatus) ]
Command Parameters
Table 18.4-1 "IP SHub VRF Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Vrf::ShubVrfID> the vrf id
range: [0...127]
Table 18.4-2 "IP SHub VRF Configuration Command" Command Parameters
Parameter Type Description
name <Vrf::ShubVrfName> mandatory parameter
length: x<22 the name
(modeandcommstatus) fast-path-mode | ena-user-user-com | mandatory parameter
dis-user-user-com | slow-path-mode some help
Possible values are :
- fast-path-mode : set fast-path mode
- slow-path-mode : set slow-path mode
- ena-user-user-com : set user to user
comm via service-hub
- dis-user-user-com : unset user to user
comm
Command Description
This commands allows an operator to create/delete/modify a Virtual Routing and Forwarding 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 type x.x.x.0/24
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ip shub vrf (index) [[no] route-dest (dest) next-hop <Ip::V4Address>
vlan-id <Vlan::VlanId> [ no metric-one | metric-one <Vrf::ShubRouteMetric> ]]
Command Parameters
Table 18.5-1 "IP SHub VRF Route Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Vrf::ShubVrfID> the vrf id
range: [0...127]
(dest) <Ip::V4Address> / <Ip::PrefixLength> the destination ip address and mask of this route
next-hop <Ip::V4Address> the next hop ip address of this route
Table 18.5-2 "IP SHub VRF Route Configuration Command" Command Parameters
Parameter Type Description
vlan-id <Vlan::VlanId> mandatory parameter
range: [1...4093] The parameter is not visible during modification.
vlan id
metric-one <Vrf::ShubRouteMetric> optional parameter with default value: 1
The parameter is not visible during modification.
the primary routing metric for this route
Command Output
Table 18.5-3 "IP SHub VRF Route Configuration Command" Display parameters
Specific Information
name Type Description
row-status <WaitRowStatus> the status of the instance
Possible values are : This element is only shown in detail mode.
- active : instance is in use
- not-in-service : instance exists but is not
used
- not-ready : instance exists but can not be
Command Description
This command allows the operator to configure the route redistribution in IP SHub.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ip shub vrf (index) route-redistribution router-id <Ip::V4Address> [ no
as-number | as-number <SignedInteger> ][ no enable | enable ]
Command Parameters
Table 18.6-1 "IP SHub VRF Route Redistribution" Resource Parameters
Resource Identifier Type Description
(index) <Vrf::ShubVrfID> the vrf id
range: [0...127]
Table 18.6-2 "IP SHub VRF Route Redistribution" Command Parameters
Parameter Type Description
router-id <Ip::V4Address> mandatory parameter
BGP or OSPF router id
as-number <SignedInteger> optional parameter with default value: 0
the autonomous system number the Shub belongs
to
[ no ] enable <Vrf::ShubVrfAdminStat> optional parameter with default value: "disable"
enabling/disabling of route redistribution in the
Shub
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 priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ip shub arp [ no cache-timeout | cache-timeout <Ip::ArpCacheTimeOut> ][ no
cache-pending | cache-pending <Ip::ArpCachePendingTime> ][ no cache-refresh |
cache-refresh <Ip::ArpCacheRefreshTime> ][ no cache-retry-time | cache-retry-time
<Ip::ArpCacheRetryTime> ][ no max-retry-itvl | max-retry-itvl
<Ip::ArpCacheMaxRetryTime> ][ no max-retries | max-retries <Ip::ArpMaxRetries> ]
Command Parameters
Table 18.7-2 "IP Shub Arp Configuration Command" Command Parameters
Parameter Type Description
cache-timeout <Ip::ArpCacheTimeOut> optional parameter with default value: 7200
range: [30...86400] time after which the entry in cache is removed
cache-pending <Ip::ArpCachePendingTime> optional parameter with default value: 30
range: [30...3000] time an unresolved entry will be held in cache
cache-refresh <Ip::ArpCacheRefreshTime> optional parameter with default value: 90
range: [30...3600] refresh interval for next hop ARP cache entries
cache-retry-time <Ip::ArpCacheRetryTime> optional parameter with default value: 1
range: [1...60] retry time for next hop ARP cache entries
max-retry-itvl <Ip::ArpCacheMaxRetryTime> optional parameter with default value: 3600
range: [600...18000] max retry time for next hop ARP cache entries
max-retries <Ip::ArpMaxRetries> optional parameter with default value: 3
range: [2...10] maximum number of retry attempts for ARP
resolution
Command Description
This command allows the operator to configure the IP Shub ARP parameters per Vlan.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ip shub arp vlan (vlanid) [ no gratuitous-arp | gratuitous-arp ]
Command Parameters
Table 18.8-1 "IP Shub Arp Configuration Command Per Vlan" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::VlanIndex> the vlan id
range: [1...4093]
Table 18.8-2 "IP Shub Arp Configuration Command Per Vlan" Command Parameters
Parameter Type Description
[ no ] gratuitous-arp <Shub::GratArp> optional parameter with default value:
"no-gratuitous-arp"
process gratuitous broadcast ARP messages
Command Description
This is used to create IP interface on netwotk port.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ip interface [[no] network (vlanid) ]
Command Parameters
Table 18.9-1 "IP Interface Network Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::VlanIndex> vlan id
range: [1...4093]
Command Description
This is used to configure vrf ip interfaces related parameters.Interface can be of the type Numbered or
Unumbered.Creation of IP address will be only for Numbered interface only
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ip interface network (vlanid) [[no] vrf (vrf-index) [ no arp-policy |
arp-policy <Vrf::ArpPolicy> ][ no unnumbered | unnumbered ]]
Command Parameters
Table 18.10-1 "IP Interface Network VRF Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::VlanIndex> vlan id
range: [1...4093]
Table 18.10-2 "IP Interface Network VRF Configuration Command" Command Parameters
Parameter Type Description
(vrf-index) <Vrf::VrfIndex> mandatory parameter
range: [1...127] the vrf index
arp-policy <Vrf::ArpPolicy> optional parameter with default value:
Possible values are : "not-trusted"
- not-trusted : not trusted ARP packets system behaviour to received ARP packets
- trusted : trusted ARP packets
[ no ] unnumbered <Vrf::Unnumbered> optional parameter with default value: "numbered"
unnumbered interface
Command Description
Associate IP address to the Numbered interface.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ip interface network (vlanid) [[no] ip-address (ip-address) ]
Command Parameters
Table 18.11-1 "IP Interface Network Numbered Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::VlanIndex> vlan id
range: [1...4093]
(ip-address) <Ip::V4Address> / <Ip::PrefixLength> inet-address
Command Description
This is used to configure user-port interface (rack/shelf/Lt-slot/port/vpi:vci).
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ip interface user [[no] port (port-interface) ]
Command Parameters
Table 18.12-1 "IP Interface User Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(port-interface) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port user-port
<Eqpt::LtSlot> / <Eqpt::Port> : identification
<Atm::vpi> : <Atm::vci>
Command Description
This is used to configure vrf ip interfaces related parameters.The user has to enter the Qos Profile Sessions
releated parameter. For the network side IP interfaces will always be 0.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ip interface user port (port-interface) [[no] vrf (vrf-index) ]
Command Parameters
Table 18.13-1 "IP Interface User Port VRF Configuration Command" Resource Parameters
Resource Identifier Type Description
(port-interface) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port user-port
<Eqpt::LtSlot> / <Eqpt::Port> : identification
<Atm::vpi> : <Atm::vci>
Table 18.13-2 "IP Interface User Port VRF Configuration Command" Command Parameters
Parameter Type Description
(vrf-index) <Vrf::VrfIndex> mandatory parameter
range: [1...127] the vrf index
Command Description
This is used to create an User Gateway Interface. Whenever a VRF is created there will be auto-generated entry in
the VRF IP Interface Table. Only the user can associate multiple IP address to this Interface.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ip interface gateway [[no] vrf-id (user-gateway) ip-address
<Ip::V4Address> / <Ip::PrefixLength> ]
Command Parameters
Table 18.14-1 "IP User Gateway Interface VRF Configuration Command" Resource Parameters
Resource Identifier Type Description
(user-gateway) <Vrf::VrfIndex> the vrf index
ip-address <Ip::V4Address> / <Ip::PrefixLength> inet-address
Command Description
This node allows 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure bridge [ageing-time <Vlan::AgingTime> ]
Command Parameters
Table 19.1-2 "Bridge General Configuration Command" Command Parameters
Parameter Type Description
ageing-time <Vlan::AgingTime> optional parameter
range: [10...1096] unit: sec ageing timeout for dynamic mac entries
Command Description
This node allows 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
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure bridge [[no] port (port) [ no pvid | pvid <Vlan::UVlanIndex> | stacked :
<Vlan::SVlanIndex> : <Vlan::CVlanIndex> ][ no default-priority | default-priority
<Vlan::Priority> ][ no mac-learn-off | 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 none | name :
<Vlan::IgnoredQosProfileName> ][ no prio-regen-prof | prio-regen-prof
<Vlan::PrioRegenProfile> ]]
Command Parameters
Table 19.2-1 "Bridge Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Table 19.2-2 "Bridge Port Configuration Command" Command Parameters
Parameter Type Description
pvid <Vlan::UVlanIndex> | stacked : optional parameter with default value: 4097
<Vlan::SVlanIndex> : default vlan id for untagged frames
<Vlan::CVlanIndex>
default-priority <Vlan::Priority> optional parameter with default value: 0
range: [0...7] priority to be set in upstream frames
Command Description
This node allows to associate a VLAN to a bridge port and to define VLAN attributes on this port.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure bridge port (port) [[no] vlan-id (index) [ no tag | tag ][ no qos-profile
| qos-profile none | name : <Vlan::IgnoredQosProfileName> ][ no prior-best-effort |
prior-best-effort ][ no prior-background | prior-background ][ no prior-spare |
prior-spare ][ no prior-exc-effort | prior-exc-effort ][ no prior-ctrl-load |
prior-ctrl-load ][ no prior-less-100ms | prior-less-100ms ][ no prior-less-10ms |
prior-less-10ms ][ no prior-nw-ctrl | prior-nw-ctrl ]]
Command Parameters
Table 19.3-1 "Bridge Port to VLAN Association Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
(index) <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
Table 19.3-2 "Bridge Port to VLAN Association Configuration Command" Command Parameters
Parameter Type Description
[ no ] tag <Vlan::PortUntagStatus> optional parameter with default value: "untag"
tag control for egress port
qos-profile none | name : optional parameter with default value: "none"
<Vlan::IgnoredQosProfileName> qos profile name
[ no ] prior-best-effort <Vlan::BestEffort> optional parameter with default value:
"no-prior-best-effort"
enable best effort priority
[ no ] <Vlan::Background> optional parameter with default value:
prior-background "no-prior-background"
enable background priority
[ no ] prior-spare <Vlan::Spare> optional parameter with default value:
"no-prior-spare"
enable spare priority
[ no ] prior-exc-effort <Vlan::ExcEffort> optional parameter with default value:
Command Description
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure bridge shub ageing-time <Shub::AgingTime>
Command Parameters
Table 19.4-2 "SHub Bridge Configuration Command" Command Parameters
Parameter Type Description
ageing-time <Shub::AgingTime> mandatory parameter
range: [10...1000000] unit: sec program ageing timeout for dynamic mac entries
Command Description
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
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 ignore-dual-tag | ignore-dual-tag ][ no
copy-pbit-mode | copy-pbit-mode ][ no dt-mode-tpid | dt-mode-tpid <Shub::TpMode> ]
Command Parameters
Table 19.5-1 "SHub Bridge Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(network-port) <Shub::NetworkPort> the network port
range: [1...7]
Table 19.5-2 "SHub Bridge Port Configuration Command" Command Parameters
Parameter Type Description
default-priority <Shub::PortPriority> optional parameter with default value: "0"
range: [0...7] default ingress user priority
pvid <Vlan::VlanOamIndex> optional parameter with default value: 1
range: [1...4093] port vlan id
accept-frame-type <Shub::VlanFrameTypes> optional parameter with default value: "all"
Possible values are : accept frame types
- all : admit all frame types
- tagged : admit only vlan tagged
[ no ] ignore-dual-tag <Shub::IgnoreDT> optional parameter with default value:
"ignore-dual-tag"
enable/disable the ignore dual tag indication
[ no ] copy-pbit-mode <Shub::CopyPbitMode> optional parameter with default value:
"copy-pbit-mode"
enable/disable the copy pbit mode
dt-mode-tpid <Shub::TpMode> optional parameter with default value: "0x8100"
enable/disable the copy pbit mode
Command Description
This node allows to specify VLAN parameters which are globally applicable to all VLANs.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure vlan [ no broadcast-frames | broadcast-frames ]priority-policy
<Vlan::PriorityMap>
Command Parameters
Table 20.1-2 "VLAN General Configuration Command" Command Parameters
Parameter Type Description
[ no ] <Vlan::BrdcastControl> optional parameter with default value:
broadcast-frames "no-broadcast"
switch broadcast frames for each vlan
priority-policy <Vlan::PriorityMap> mandatory parameter
Possible values are : specifies how to deal with ethernet priority of the
- vlan-specific : the priority of the vlan upstream frames
- port-default : the default priority of the
port
Command Description
This node allows to specify a VLAN and its attributes.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure vlan [[no] id (vlanid) [ no name | name <Vlan::AdminString> ]mode
<Vlan::SystemMode> [ no priority | priority <Vlan::Priority> ][ no broadcast-frames |
broadcast-frames ][ no protocol-filter | protocol-filter <Vlan::ProtGroup> ][ no
pppoe-relay | pppoe-relay ][ no dhcp-opt-82 | dhcp-opt-82 ]]
Command Parameters
Table 20.2-1 "VLAN Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
Table 20.2-2 "VLAN Configuration Command" Command Parameters
Parameter Type Description
name <Vlan::AdminString> optional parameter with default value: ""
length: x<32 name
mode <Vlan::SystemMode> mandatory parameter
Possible values are : The parameter is not visible during modification.
- cross-connect : crossconnect vlan mode
- residential-bridge : residential bridge
vlan
- qos-aware : qos aware vlan
- layer2-terminated : layer2 terminated
vlan
priority <Vlan::Priority> optional parameter with default value: 0
range: [0...7] default frame priority
[ no ] <Vlan::StaticBrdcastControl> optional parameter with default value:
broadcast-frames "no-broadcast"
switch downstream broadcast frames
protocol-filter <Vlan::ProtGroup> optional parameter with default value: "pass-all"
Possible values are : filter protocol groups
- pass-all : pass all traffic
- pass-ipoe : pass traffic of IPoE protocol
group
- pass-pppoe : pass traffic of PPPoE
protocol group
Command Description
This node allows 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure vlan [[no] unicast-mac (unicast-mac) vlan-id <Vlan::UVlanIndex> | stacked
: <Vlan::SVlanIndex> : <Vlan::CVlanIndex> forward-port <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::vpi> : <Atm::vci> ]
Command Parameters
Table 20.3-1 "VLAN Filtering Database Configuration Command" Resource Parameters
Resource Identifier Type Description
(unicast-mac) <Vlan::MacAddr> unicast mac address
length: 6
vlan-id <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
Table 20.3-2 "VLAN Filtering Database Configuration Command" Command Parameters
Parameter Type Description
forward-port <Eqpt::Rack> / <Eqpt::Shelf> / mandatory parameter
<Eqpt::LtSlot> / <Eqpt::Port> : forward bridge port
<Atm::vpi> : <Atm::vci>
Command Description
For protocol based VLANs, this node allows to specify how incoming traffic on a port is allocated to a particular
VLAN and priority.
For Ethernet 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
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
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure vlan [[no] port-protocol (port) protocol-group <Vlan::GroupId> vlan-id
<Vlan::UVlanIndex> | stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> priority
<Vlan::Priority> ]
Command Parameters
Table 20.4-1 "Protocol based VLAN Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
protocol-group <Vlan::GroupId> protocol group
Possible values are :
- pppoe : PPPoE
- ipoe : IPoE
Table 20.4-2 "Protocol based VLAN Configuration Command" Command Parameters
Parameter Type Description
vlan-id <Vlan::UVlanIndex> | stacked : mandatory parameter
<Vlan::SVlanIndex> : protocol group vlan id
<Vlan::CVlanIndex>
priority <Vlan::Priority> mandatory parameter
Command Description
This node allows to specify a VLAN and its attributes on the Service Hub.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure vlan shub [[no] id (vlanid) [ no name | name <Vlan::AdminString> ]mode
<Shub::SystemMode> [ no mac-move-allow | mac-move-allow ]]
Command Parameters
Table 20.5-1 "SHub VLAN Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::VlanOamIndex> vlan id
range: [1...4093]
Table 20.5-2 "SHub VLAN Configuration Command" Command Parameters
Parameter Type Description
name <Vlan::AdminString> optional parameter with default value: ""
length: x<32 name
mode <Shub::SystemMode> mandatory parameter
Possible values are : The parameter is not visible during modification.
- cross-connect : crossconnect vlan mode
- residential-bridge : residential bridge
vlan
- layer2-terminated : layer2 terminated
vlan
- layer2-term-nwport : layer2 terminated
vlan on network port
- v-vlan : virtual vlan
- reserved : internal and external
communication via vlan
[ no ] <Shub::MacMoveStatus> optional parameter with default value:
mac-move-allow "mac-move-deny"
mac movement status
Command Output
Table 20.5-3 "SHub VLAN Configuration Command" Display parameters
Specific Information
Command Description
This node allows to specify the set of ports which are statically allocated as egress ports for the specified VLAN.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure vlan shub id (vlanid) [[no] egress-port (port) ]
Command Parameters
Table 20.6-1 "SHub Static Egress Port for VLAN Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::VlanOamIndex> vlan id
range: [1...4093]
(port) lt : <Eqpt::Rack> / <Eqpt::Shelf> / egress port
<Eqpt::LtSlot> | network :
<Shub::NetworkPort>
Command Description
This node allows to specify the egress ports which should transmit packets for this VLAN as untagged.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure vlan shub id (vlanid) [[no] untag-port (network-port) ]
Command Parameters
Table 20.7-1 "SHub Static Untagged Egress Port for VLAN Configuration Command" Resource
Parameters
Resource Identifier Type Description
(vlanid) <Vlan::VlanOamIndex> vlan id
range: [1...4093]
(network-port) <Shub::NetworkPort> the untagged network port
range: [1...7]
Command Description
This node allows to specify entries in the layer 2 Filtering Database for a specific VLAN and multicast MAC
address. This configuration applies to the Service Hub.
This information is used by the bridge in determining how to propagate a received frame.
The configuration is used to prohibit flooding of unknown multicast traffic on the specific VLAN and multicast
MAC address.
This Filtering Database can hold up to 256 entries.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure vlan shub [[no] mcast-mac (mcast-mac) vlan-id <Vlan::VlanIndex> ]
Command Parameters
Table 20.8-1 "SHub Multicast MAC Filtering Database Configuration Command" Resource
Parameters
Resource Identifier Type Description
(mcast-mac) <Vlan::MacAddr> multicast mac address
length: 6
vlan-id <Vlan::VlanIndex> vlan id
range: [1...4093]
Command Description
This node allows to specify the egress ports for a entry in the layer 2 Filtering Database for multicast MAC address
on the Service Hub.
For a specific VLAN and multicast MAC address, the egress ports are configured. In case no ports are specified,
traffic destined to this particular multicast MAC will not be flooded.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure vlan shub mcast-mac (mcast-mac) vlan-id <Vlan::VlanIndex> [[no]
egress-port (port) ]
Command Parameters
Table 20.9-1 "Configure Multicast Filtering on SHub" Resource Parameters
Resource Identifier Type Description
(mcast-mac) <Vlan::MacAddr> multicast mac address
length: 6
vlan-id <Vlan::VlanIndex> vlan id
range: [1...4093]
(port) lt : <Eqpt::Rack> / <Eqpt::Shelf> / outbound port
<Eqpt::LtSlot> | network :
<Shub::NetworkPort>
Command Description
This commands configures the Link Aggregation on the Service Hub. It merely allows to enable or disable the Link
Aggregation feature.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure la [ no disable | disable ]
Command Parameters
Table 21.1-2 "Link Aggregation Configuration Command" Command Parameters
Parameter Type Description
[ no ] disable <Shub::LaModuleState> optional parameter with default value:
"enable-lacp"
link aggregation protocol operation
Command Description
This node allows to specify the Link Aggregation Group parameters. The configuration should be performed for the
primary link. Note that a Link Aggregation Group is identified my 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 primarly link of the
Aggregation Group apply to each and every link that is a member of the Link Aggregation Group.
The link which 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure la aggregator-port (network-port) name <Shub::AggName> [ no
link-up-down-trap | link-up-down-trap ][ no actor-sys-prio | actor-sys-prio
<Shub::LaPortActorSysPriority> ]actor-key <Shub::LacpKey> [ no actor-port-prio |
actor-port-prio <Shub::LaPortActorPortPriority> ][ no active-lacp | active-lacp ][ no
short-timeout | short-timeout ][ no aggregatable | aggregatable ]lacp-mode
<Shub::LacpMode>
Command Parameters
Table 21.2-1 "Link Aggregation Group Configuration Command" Resource Parameters
Resource Identifier Type Description
(network-port) <Shub::NetworkPort> interface index of network port
range: [1...7]
Table 21.2-2 "Link Aggregation Group Configuration Command" Command Parameters
Parameter Type Description
name <Shub::AggName> mandatory parameter
length: x<20 aggregate name
[ no ] <Shub::LaTrap> optional parameter with default value:
link-up-down-trap "no-link-up-down"
enable link up down trap
actor-sys-prio <Shub::LaPortActorSysPriority> optional parameter with default value: "1"
range: [0...255] actor system priority
actor-key <Shub::LacpKey> mandatory parameter
Command Description
This node allows to specify Rapid Spanning Tree settings applicable to the SHub.
The parameters in this section are settings that apply to the bridge as a whole. Port specific RSTP parameters are
dealt with in subsequent chapters.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure rstp [ no disable | disable ][ no priority | priority <Shub::RstpPriority>
][ no max-age | max-age <Shub::RstpMaxAge> ][ no hello-time | hello-time
<Shub::RstpHello> ][ no forward-delay | forward-delay <Shub::RstpFwdDelay> ][ no
version | version <Shub::RstpVersion> ][ no tx-hold-count | tx-hold-count
<Shub::RstpTxHold> ][path-cost-type <Shub::RstpPathCost> ]
Command Parameters
Table 22.1-2 "RSTP Configuration Command" Command Parameters
Parameter Type Description
[ no ] disable <Shub::RstpModuleState> optional parameter with default value:
"enable-rstp"
rstp protocol operation
priority <Shub::RstpPriority> optional parameter with default value: 32768
range: [0...61440] stp bridge priority(n*4096)
max-age <Shub::RstpMaxAge> optional parameter with default value: 2000
range: [600...4000] unit: 10msec root bridge max age(1 sec. granularity)
hello-time <Shub::RstpHello> optional parameter with default value: 200
range: [100...1000] unit: 10msec root bridge hello timeout(1 sec. granularity)
forward-delay <Shub::RstpFwdDelay> optional parameter with default value: 1500
range: [400...3000] unit: 10msec root bridge forward delay time(1 sec. granularity)
version <Shub::RstpVersion> optional parameter with default value: "rstp"
Possible values are : bridge stp version
- stp-compatible : ieee 802.1d stp
- rstp : ieee 802.1w rstp
tx-hold-count <Shub::RstpTxHold> optional parameter with default value: 3
range: [1...10] max transmission rate for BPDUs
path-cost-type <Shub::RstpPathCost> optional parameter
Possible values are : version for the default path cost
- 16-bit : stp-8021d-1998 path cost
- 32-bit : stp-8021t-2001 path cost
Command Description
This node allows to specify Rapid Spanning Tree settings applicable to a particular port the Service Hub.
Note that RSTP operates on a port rather than on a VLAN.
In addition to this configuration command, there is a need to trigger a specific SHub Port to revert to RSTP
protocol, versus stp-compatible protocol. The latter command is found in the admin node.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> configure rstp network-port (port) [ no priority | priority <Shub::RstpPortPriority>
][ no disable-stp | disable-stp ][path-cost <Shub::PortPathCost> ][ no edge-port |
edge-port ][ no admin-p2p | admin-p2p <Shub::AdminP2p> ]
Command Parameters
Table 22.2-1 "RSTP Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) <Shub::NetworkPort> identity of the network port
range: [1...7]
Table 22.2-2 "RSTP Port Configuration Command" Command Parameters
Parameter Type Description
priority <Shub::RstpPortPriority> optional parameter with default value: 128
range: [0...240] priority(steps of 16)
[ no ] disable-stp <Shub::RstpStatus> optional parameter with default value: "enable-stp"
disable rstp for this port
path-cost <Shub::PortPathCost> optional parameter
range: [1...200000000] port path cost
[ no ] edge-port <Shub::AdminEdge> optional parameter with default value:
"no-edge-port"
configure the port as an edge port
admin-p2p <Shub::AdminP2p> optional parameter with default value: "auto"
Possible values are : admin point to point status
- force-true : point to point connection
- force-false : shared media connection
- auto : auto
Command Description
This command allows 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 actually 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.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos [ no atm-overhead-fact | atm-overhead-fact <Qos::AtmFactor> ][ no
enable-alignment | enable-alignment ]
Command Parameters
Table 23.1-2 "QoS Configuration Command" Command Parameters
Parameter Type Description
atm-overhead-fact <Qos::AtmFactor> optional parameter with default value: 85
range: [1...100] unit: % over head factor introduced by atm layer
[ no ] <Qos::AlignmentStatus> optional parameter with default value:
enable-alignment "disable-alignment"
DSCP to P-bit alignment for all forwarded L3
traffic
Command Description
This command allows the operator to configure a marker for single dot1p.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker [[no] d1p (name) default-dot1p <Qos::ExtVlanSysPrio> ]
Command Parameters
Table 23.2-1 "QoS Single Dot1P Marker Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Table 23.2-2 "QoS Single Dot1P Marker Configuration Command" Command Parameters
Parameter Type Description
default-dot1p <Qos::ExtVlanSysPrio> mandatory parameter
range: [0...7] the default dot-1p bit value to be applied on all
frames
Command Description
This command allows the operator to configure a marker for single DSCP.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker [[no] dscp (name) default-dscp
<Qos::DscpToDot1PAlignmentDscpIndex> [ no alignment | alignment ]]
Command Parameters
Table 23.3-1 "QoS Single DSCP Marker Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Table 23.3-2 "QoS Single DSCP Marker Configuration Command" Command Parameters
Parameter Type Description
default-dscp <Qos::DscpToDot1PAlignmentDscpIndex> mandatory parameter
range: [0...63] the default dscp value to be applied on all frames
[ no ] alignment <Qos::Alignment> optional parameter with default value: "disable"
enable DSCP to P-bits alignment
Command Description
This command allows an operator to configure a marker for a DSCP contract table.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker [[no] dscp-contract (name) [ no alignment | alignment
]]
Command Parameters
Table 23.4-1 "QoS DSCP Contract Table Marker Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Table 23.4-2 "QoS DSCP Contract Table Marker Configuration Command" Command Parameters
Parameter Type Description
[ no ] alignment <Qos::Alignment> optional parameter with default value: "disable"
enable DSCP to P-bits alignment
Command Description
This command allows the operator to configure a codepoint for a DSCP Contract Table.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
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 23.5-1 "QoS DSCP Contract Table Codepoint Configuration Command For Dscp-contract"
Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
(codepoint) <Qos::DscpCodePoint> the number of the codepoint
range: [0...63]
Table 23.5-2 "QoS DSCP Contract Table Codepoint Configuration Command For Dscp-contract"
Command Parameters
Parameter Type Description
dscp-value <Qos::DscpToDot1PAlignmentDscpIndex> optional parameter with default value: 0L
range: [0...63] the dscp value to be assigned to the codepoint
Command Description
This command allows the operator to configure a marker for dot1p and dscp contract table.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker [[no] d1p-dscp-contract (name) dot1p-value
<Qos::ExtVlanSysPrio> [ no alignment | alignment ]]
Command Parameters
Table 23.6-1 "QoS Dot1P And DSCP Contract Table Marker Configuration Command" Resource
Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Table 23.6-2 "QoS Dot1P And DSCP Contract Table Marker Configuration Command" Command
Parameters
Parameter Type Description
dot1p-value <Qos::ExtVlanSysPrio> mandatory parameter
range: [0...7] the default dot-1p bit value to be applied on all
frames
[ no ] alignment <Qos::Alignment> optional parameter with default value: "disable"
enable DSCP to P-bits alignment
Command Description
This command allows the operator to configure a codepoint for a DSCP Contract Table.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker d1p-dscp-contract (name) codepoint (codepoint) [ no
value | value <Qos::DscpToDot1PAlignmentDscpIndex> ]
Command Parameters
Table 23.7-1 "DSCP Contract Table Codepoint Configuration Command For D1p-dscp-contract"
Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
(codepoint) <Qos::DscpCodePoint> the number of the codepoint
range: [0...63]
Table 23.7-2 "DSCP Contract Table Codepoint Configuration Command For D1p-dscp-contract"
Command Parameters
Parameter Type Description
value <Qos::DscpToDot1PAlignmentDscpIndex> optional parameter with default value: 0L
range: [0...63] the dscp value to be assigned to 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 priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker [[no] d1p-dscp (name) default-dscp
<Qos::DscpToDot1PAlignmentDscpIndex> default-dot1p <Qos::ExtVlanSysPrio> [ no
alignment | alignment ]]
Command Parameters
Table 23.8-1 "QoS Dot1P And Single DSCP Marker Configuration Command" Resource
Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Table 23.8-2 "QoS Dot1P And Single DSCP Marker Configuration Command" Command
Parameters
Parameter Type Description
default-dscp <Qos::DscpToDot1PAlignmentDscpIndex> mandatory parameter
range: [0...63] the default dscp value to be applied on all frames
default-dot1p <Qos::ExtVlanSysPrio> mandatory parameter
range: [0...7] the default dot-1p bit value to be applied on all
frames
[ no ] alignment <Qos::Alignment> optional parameter with default value: "disable"
enable DSCP to P-bits alignment
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 priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos profiles marker [[no] d1p-alignment (name) (alignment) ]
Command Parameters
Table 23.9-1 "QoS Dot1P Alignment Marker Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Table 23.9-2 "QoS Dot1P Alignment Marker Configuration Command" Command Parameters
Parameter Type Description
(alignment) <Qos::Dot1PAlignment> mandatory parameter
enable dot1p alignment
Command Description
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 EBLT-C and EBLT-D cards support both upstream and downstream policing. A policer profile can be used
within a QoS Session Profile for both upstream and downstream policing.
The EALT-A and EBLT-A cards do not support policing.
The SHub supports ingress policing, but it does not make use of policer profiles. Please refer to section of the QoS
Ingress Policing Configuration Command on how to set up ingress policing on the SHub.
The policer granularity on EBLT-C and EBLT-D cards is 8kbps. Values specified with 1kbps granularity are
always rounded upwards. Valid range is from 8kbps till 64Mbps, with fixed granularity of 8kbps.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos profiles [[no] policer (name) committed-info-rate <Qos::InfoRate>
committed-burst-size <Qos::CommittedBustSize> ]
Command Parameters
Table 23.10-1 "QoS Policer profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Table 23.10-2 "QoS Policer profile Configuration Command" Command Parameters
Parameter Type Description
committed-info-rate <Qos::InfoRate> mandatory parameter
unit: kbps committed information rate of a policer
committed-burst-size <Qos::CommittedBustSize> mandatory parameter
range: [64...262144] unit: bytes committed bust size of a policer
Command Description
A Queue Profile or Buffer Acceptance Control (BAC) profile contains configuration information on data-plane
queues. BAC profiles can be used on EBLT-C and EBLT-D line cards.
Supported BAC types:
• Tail Drop
• RED (Random Early Detect)
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos profiles [[no] queue (name) (bac-complex-type) ]
Command Parameters
Table 23.11-1 "QoS Queue Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Table 23.11-2 "QoS Queue Profile Configuration Command" Command Parameters
Parameter Type Description
(bac-complex-type) tail-drop : <Qos::MaxThreshold> | red : mandatory parameter
<Qos::MinThreshold> : buffer acceptance control algorithm
<Qos::MaxThreshold> :
<Qos::DiscardProbability>
Command Description
The Scheduler Profiles contain configuration settings for the data plane schedulers. These Scheduler Profiles are
applicable on downstream schedulers on EBLT-C and EBLT-D line cards. The Scheduler settings on the
aggregation function can be modified separately.
On EALT-A and EBLT-A 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 know 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 priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos profiles [[no] scheduler (name) wfq-q1-weight <Qos::WfqQ1Weight> ]
Command Parameters
Table 23.12-1 "QoS Scheduler Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Table 23.12-2 "QoS Scheduler Profile Configuration Command" Command Parameters
Parameter Type Description
wfq-q1-weight <Qos::WfqQ1Weight> mandatory parameter
range: [0...100] weight of DSL link WFQ scheduler for Queue one
Command Description
The Connection Admission Control (CAC) profiles are used primarily for multicast video admission control. To
each DSL line a CAC profile can be attached. The context of a CAC profile is a DSL link (and not a PVC),
regardless of the number of PVC's on a DSL link.
The system derives the guaranteed line rate from the modems, and calculates an estimate of the available Ethernet
bandwidth. From this permanent available 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 pre-configured
multicast streams are considered for CAC. Note that unicast video (regardless whether it is premium content or
generic Internet streaming video) is ignored by the CAC function.
The maximum bandwidth to be occupied by video can be further constrained via the maximum multicast bandwidth
max-mcast-bandwidth parameter.
CAC profiles are applicable on line cards, but not to interfaces on the SHub.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos profiles [[no] cac (name) res-voice-bandwidth <Itf::mediumBandWidth>
max-mcast-bandwidth <Itf::mediumBandWidth> res-data-bandwidth <Itf::mediumBandWidth> ]
Command Parameters
Table 23.13-1 "QoS CAC Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Table 23.13-2 "QoS CAC Profile Configuration Command" Command Parameters
Parameter Type Description
res-voice-bandwidth <Itf::mediumBandWidth> mandatory parameter
unit: kbps reserved bandwidth for the voice services
max-mcast-bandwidth <Itf::mediumBandWidth> mandatory parameter
unit: kbps maximum allowed bandwidth for the multicast
video service
res-data-bandwidth <Itf::mediumBandWidth> mandatory parameter
unit: kbps reserved bandwidth for all data services
Command Description
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 (i.e. a session). The following "logical
interface" or "logical flow" types are supported:
• VC : all frames on a PVC
• PVC.VLAN : a VLAN on top of a PVC
• PPP session : all frames on a locally terminated PPP session
• 802.1X session : all frames belonging to a 802.1X authenticated session
A QoS session profile is composed of a logical flow type, a marker profile and two policer profiles for up and
downstream policing of the logical interface to which a certain session profile is attached.
The logical flow type will constrain the usage of a session profile to the intended interface type. However, if the
logical flow type is null, the session profile can be attached to any interface, provided that the settings inside the
profile can be configured on the target hardware. It is advised to create specific profiles for specific interface types
always to avoid wrong configurations.
QoS session profiles are supported on EBLT-C and EBLT-D cards.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos profiles [[no] session (name) logical-flow-type <Qos::LogicalFlowType>
[ no up-policer | up-policer none | name : <Qos::IgnoredQosProfileName> ][ no
down-policer | down-policer none | name : <Qos::IgnoredQosProfileName> ][ no up-marker
| up-marker none | name : <Qos::IgnoredQosProfileName> ]]
Command Parameters
Table 23.14-1 "QoS Session Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Table 23.14-2 "QoS Session Profile Configuration Command" Command Parameters
Parameter Type Description
logical-flow-type <Qos::LogicalFlowType> mandatory parameter
Possible values are : a traffic stream up on which policy to be made
- generic : any defined logical flow
- pvc : all frames on a pvc
- dot-1x-session : frames on a pvc except
Command Description
This command allows to configure the downstream traffic class mapping table. This table defines which 802.1P
code point is cast to which egress buffer on EBLT-C and EBLT-D cards.
Note that there is a second class to queue mapping table on the SHub, but that is independent (from the
configuration perspective) of this table [see traffic class configuration]. The latter is used mainly for upstream
traffic segregation into egress buffers on the SHub.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos tc-map-dot1p (index) queue <Qos::Queues>
Command Parameters
Table 23.15-1 "QoS 802.1P Class to Queue Mapping Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) <Qos::Dot1pValue> value of 802.1p filed
range: [0...7]
Table 23.15-2 "QoS 802.1P Class to Queue Mapping Configuration Command" Command
Parameters
Parameter Type Description
queue <Qos::Queues> mandatory parameter
range: [0...3] output dsl port queue number
Command Description
For each DSL link it is possible to apply scheduling, and CAC settings.
A scheduler profile is used to configure egress scheduler settings per egress DSL interface. A CAC profile is used
to configure connections admission control settings per DSL interface.
The DSL link table can be configured on EBLT-C and EBLT-D line cards.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos dsl-port (index) [ no scheduler-profile | scheduler-profile none |
name : <Qos::IgnoredQosProfileName> ][ no cac-profile | cac-profile none | name :
<Qos::IgnoredQosProfileName> ]
Command Parameters
Table 23.16-1 "QoS DSL Link Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Eqpt::Rack> / <Eqpt::Shelf> / physical port of a dsl link
<Eqpt::LtSlot> / <Eqpt::Port>
Table 23.16-2 "QoS DSL Link Configuration Command" Command Parameters
Parameter Type Description
scheduler-profile none | name : optional parameter with default value: "none"
<Qos::IgnoredQosProfileName> the name of the scheduler profile to be mapped on
this dsl link
cac-profile none | name : optional parameter with default value: "none"
<Qos::IgnoredQosProfileName> the name of the cac profile to be mapped on this dsl
link
Command Description
On the EBLT-C and EBLT-D cards each DSL interface supports four downstream buffers, which can be configured
independently via Buffer Acceptance Control (BAC) profiles.
It is permitted to configure downstream buffers such that the total buffer pool is oversubscribed, however this is not
recommended as this allows QoS un-aware packet discard. If the total downstream buffer pool is oversubscribed
the system logs a warning message.
Upstream buffers on any line card are not configurable, as there is no bottleneck upstream on the line cards.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos dsl-port (index) queue (queue) [ no queue-profile | queue-profile none
| name : <Qos::IgnoredQosProfileName> ]
Command Parameters
Table 23.17-1 "QoS LIM Queue Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Eqpt::Rack> / <Eqpt::Shelf> / physical port of a dsl link
<Eqpt::LtSlot> / <Eqpt::Port>
(queue) <Qos::Queues> the queue with in the scope of one dsl link on a
range: [0...3] line-interface-module
Table 23.17-2 "QoS LIM Queue Configuration Command" Command Parameters
Parameter Type Description
queue-profile none | name : optional parameter with default value: "none"
<Qos::IgnoredQosProfileName> name of the queue profile
Command Description
Enabling the alignment will do the DSCP to P-bits alignment for all the L3 forwarding traffic
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos dscp-map-dot1p (index) dot1p-value <Qos::DscpToDot1PAlign>
Command Parameters
Table 23.18-1 "QoS DSCP to Dot1P L3 Traffic Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <Qos::DscpToDot1PAlignmentDscpIndex> the DSCP value
range: [0...63]
Table 23.18-2 "QoS DSCP to Dot1P L3 Traffic Configuration Command" Command Parameters
Parameter Type Description
dot1p-value <Qos::DscpToDot1PAlign> mandatory parameter
range: [0...7] the DOT1P value
Command Description
The SHub features seven 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 being the highest priority.
The WRR weights and egress shaping rate as well as ingress policing rate are configurable per SHub interface. See
also the section on the QoS Ingress Policing Configuration Command.
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. Nevertheless, the SHub can correctly honor backpressure from
peer nodes that cannot handle the traffic.
Note that all SHub port settings will be the same within a link aggregate group
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos shub queue-config (port) [ no queue0-weight | queue0-weight
<Qos::ShubQueueWeight1> ][ no queue1-weight | queue1-weight <Qos::ShubQueueWeight1> ][
no tx-pause | tx-pause ][ no rx-pause | rx-pause ][ no egress-rate | egress-rate
<Qos::ShubPortRate> ]
Command Parameters
Table 23.19-1 "SHub QoS Queue Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) <Shub::NetworkPort> the unique id for the port
range: [1...7]
Table 23.19-2 "SHub QoS Queue Configuration Command" Command Parameters
Parameter Type Description
queue0-weight <Qos::ShubQueueWeight1> optional parameter with default value: 1
range: [1...15] queue zero weight
queue1-weight <Qos::ShubQueueWeight1> optional parameter with default value: 2
range: [1...15] queue one weight
[ no ] tx-pause <Qos::ShubPauseTxStatus> optional parameter with default value:
"no-tx-pause"
enable qos pause for transmit
[ no ] rx-pause <Qos::ShubPauserxStatus> optional parameter with default value:
"no-rx-pause"
enable qos pause for receive
egress-rate <Qos::ShubPortRate> optional parameter with default value: 1000
range: [1...1000] unit: mbps port egress rate
Command Description
The SHub has four traffic classes defined. The mapping of frames with 802.1P code point to egress buffers
determines how each traffic class will be put in egress buffers and in a later step how each traffic class will be
scheduled on the SHub egress interfaces.
This traffic-class mapping table is not applicable on the line cards.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos shub tc-map-dot1p (tc-priority) traffic-class <Qos::ShubTrafficClass>
Command Parameters
Table 23.20-1 "SHub QoS Traffic Class Configuration Command" Resource Parameters
Resource Identifier Type Description
(tc-priority) <Qos::ShubTcPriority> priority value in the received frames
range: [0...7]
Table 23.20-2 "SHub QoS Traffic Class Configuration Command" Command Parameters
Parameter Type Description
traffic-class <Qos::ShubTrafficClass> mandatory parameter
range: [0...3] the value of traffic class, the received frame is
mapped to
Command Description
This is used to configure the various policing parameter information. The objects can be associated with any flow
on a specific port.
The values 1 and 2 cannot be used as meter index to configure a meter. If used, a "bad-value" error is returned.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos shub [[no] meter (index) [name <Qos::DisplayString> ]max-ingress-rate
<Qos::MeterIngressRate> burst-size <Qos::MeterBurstSize> ]
Command Parameters
Table 23.21-1 "SHub QoS Ingress Policing on Port" Resource Parameters
Resource Identifier Type Description
(index) <Qos::MeterIndex> index used to identify a meter
range: [1...64]
Table 23.21-2 "SHub QoS Ingress Policing on Port" Command Parameters
Parameter Type Description
name <Qos::DisplayString> optional parameter
length: x<255 name of the meter
max-ingress-rate <Qos::MeterIngressRate> mandatory parameter
range: [1...16384] the max ingress rate applied on a port
burst-size <Qos::MeterBurstSize> mandatory parameter
range: [0...7] max ingress burst size allowed
Command Description
This is used to configure various flows to be policed.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos shub [[no] flow (index) [name <Qos::DisplayString> ][(type) ]]
Command Parameters
Table 23.22-1 "SHub QoS Flows to be Policed" Resource Parameters
Resource Identifier Type Description
(index) <Qos::FlowIndex> index used to identify a flow
range: [1...64]
Table 23.22-2 "SHub QoS Flows to be Policed" Command Parameters
Parameter Type Description
name <Qos::DisplayString> optional parameter
length: x<255 name of the flow
(type) port | vlan : <Qos::VlanId> | vlan-dot1p : optional parameter
<Qos::VlanId> : <Qos::FlowPriority> | type of qos flow
vlan-dscp : <Qos::VlanId> :
<Qos::FlowDscp>
Command Description
This is used to configure the policing association. Multiple Ports can have same policer and same policer can be
applied to multiple ports.
User Level
The command can be accessed by operators with qos priviliges, and executed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> configure qos shub [[no] policer (port-id) flow <Qos::PolicerFlowIndex> meter
<Qos::PolicerMeterIndex> ]
Command Parameters
Table 23.23-1 "SHub QoS Policer Configuration Command" Resource Parameters
Resource Identifier Type Description
(port-id) <Qos::PortIndex> shub qos port index
range: [1...24]
flow <Qos::PolicerFlowIndex> index of an existing flow
range: [0...64]
Table 23.23-2 "SHub QoS Policer Configuration Command" Command Parameters
Parameter Type Description
meter <Qos::PolicerMeterIndex> mandatory parameter
range: [0...64] index of an existing meter
Command Description
Specifies the system wide configuration parameters applicable to all PPP sessions
User Level
The command can be accessed by operators with ppoe priviliges, and executed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect global-session [ no pado-timeout | pado-timeout
<PPPoX::PadTimeOut> ][ no pads-timeout | pads-timeout <PPPoX::PadTimeOut> ][ no
max-pad-attempts | max-pad-attempts <PPPoX::PadRRetrials> ][ no trans-max-age |
trans-max-age <PPPoX::TransactionMaxAge> ][ no cc-max-age | cc-max-age
<PPPoX::CcMaxAge> ]
Command Parameters
Table 24.1-2 "PPPoX CC Global Configuration Command" Command Parameters
Parameter Type Description
pado-timeout <PPPoX::PadTimeOut> optional parameter with default value: 3
range: [1...60] unit: sec timeout for PAD-O message
pads-timeout <PPPoX::PadTimeOut> optional parameter with default value: 3
range: [1...60] unit: sec timeout for PAD-S message
max-pad-attempts <PPPoX::PadRRetrials> optional parameter with default value: 10
range: [1...16] maximum number of PAD-R messages
trans-max-age <PPPoX::TransactionMaxAge> optional parameter with default value: 300
range: [1...300] unit: sec maximum age of PPP transaction
cc-max-age <PPPoX::CcMaxAge> optional parameter with default value: 300
range: [300...3000] maximum age of PPP cross connection
Command Description
PPP cross connect engine, identified by a vlan-id. name,the engine name used to identify the PPP cross connect
Engine. lock,lock or unlock the PPP control plane, i.e. if unlocked no new PPP cross connections can be
established but the existing ones remain until they are released by the PPP Server and/or client.
User Level
The command can be accessed by operators with ppoe priviliges, and executed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect [[no] engine (vlan-id) [ no name | name
<PPPoX::EngineName> ][ no lock | lock ][ no service-name | service-name
<PPPoX::EngineName> ]]
Command Parameters
Table 24.2-1 "PPPoX CC Engine Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) <Vlan::VlanId> vlan identity
range: [1...4093]
Table 24.2-2 "PPPoX CC Engine Configuration Command" Command Parameters
Parameter Type Description
name <PPPoX::EngineName> optional parameter with default value: ""
length: 1<=x<32 name to identify the engine
[ no ] lock <PPPoX::CtlPlaneState> optional parameter with default value: "unlock"
lock the control plane engine
service-name <PPPoX::EngineName> optional parameter with default value: ""
length: 1<=x<32 service name issued by engine in PAD-I message
Command Description
Contains the exception event counters for the PPP cross connect engine.
User Level
The command can be accessed by operators with ppoe priviliges, and executed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect engine (vlan-id) [[no] monitor ]
Command Parameters
Table 24.3-1 "PPPoX CC Engine Monitoring Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) <Vlan::VlanId> vlan identity
range: [1...4093]
Command Description
Specifies the ppp crossconnect client port.
User Level
The command can be accessed by operators with ppoe priviliges, and executed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect [[no] client-port (port) vlan-id <Vlan::VlanId>
default-priority <PPPoX::DefaultPriority> [ no max-cc | max-cc <PPPoX::MaxNumPppCc> ][
no qos-profile | qos-profile none | name : <PPPoX::IgnoredQosProfileName> ]]
Command Parameters
Table 24.4-1 "PPPoX CC Client Port Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / client port identification
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Table 24.4-2 "PPPoX CC Client Port Configuration Command" Command Parameters
Parameter Type Description
vlan-id <Vlan::VlanId> mandatory parameter
range: [1...4093] The parameter is not visible during modification.
associates client port to cc-engine
default-priority <PPPoX::DefaultPriority> mandatory parameter
range: [0...7] indicates the p-bit for the client port
max-cc <PPPoX::MaxNumPppCc> optional parameter with default value: 64
range: [0...3072] max no. of PPP cross connection on a port
qos-profile none | name : optional parameter with default value: "none"
<PPPoX::IgnoredQosProfileName> qos profile name associated with client port
Command Description
Contains the exception event counters for the PPP cross connect client port.
User Level
The command can be accessed by operators with ppoe priviliges, and executed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect client-port (port) [[no] monitor ]
Command Parameters
Table 24.5-1 "PPPoX CC Client Port Monitoring Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / client port identification
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Description
This node allows the operator to configure the PPPoE Access Concentrator and Admin State.
Access Concentrator (Server name) is used to send AC_NAME tag in PADO that is sent to host. The default AC
name is set to AlcatelPppoeServer.
Server Admin State, when disabled, locks the PPPoE server and no more new PPPoE sessions are established.
When this value is set to disabled from enabled state, it will not tear down the existing PPPoE sessions.
User Level
The command can be accessed by operators with ppoe priviliges, and executed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> configure pppoe server-name <PPPoE::ServerName> [ no enable-server | enable-server ]
Command Parameters
Table 25.1-2 "PPPoE Server Configuration Command" Command Parameters
Parameter Type Description
server-name <PPPoE::ServerName> mandatory parameter
length: 1<=x<32 name of the access server
[ no ] enable-server <PPPoE::pppoeServerAdminState> optional parameter with default value:
"disable-server"
admin state of the server
Command Description
This node allows the operator to configure PPP profile parameters.
User Level
The command can be accessed by operators with ppoe priviliges, and executed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> configure pppoe [[no] ppp-profile (index) [ no auth-type | auth-type
<PPPoE::pppProfileAuthenType> ][ no keep-alive-intvl | keep-alive-intvl
<PPPoE::ProfileKeepAliveInterval> ]]
Command Parameters
Table 25.2-1 "PPPoE Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) <AsamProfileName> name of the profile
range: [a-zA-Z0-9-_]length: 1<=x<32
Table 25.2-2 "PPPoE Profile Configuration Command" Command Parameters
Parameter Type Description
auth-type <PPPoE::pppProfileAuthenType> optional parameter with default value: "chap"
Possible values are : the type of PPP authentication used
- 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
keep-alive-intvl <PPPoE::ProfileKeepAliveInterval> optional parameter with default value: 30
range: [0...65535] unit: sec keepalive timeout value, after sending echo request
packet
Command Description
This node allows the operator to configure the PPP sessions.
User Level
The command can be accessed by operators with ppoe priviliges, and executed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> configure pppoe [[no] pppox-interface (port) [ no max-num-session | max-num-session
<PPPoE::MaxNumSessions> ][ no ppp-profile-name | ppp-profile-name <AsamProfileName> ]]
Command Parameters
Table 25.3-1 "PPPoX Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / configure the pppox interafce
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Table 25.3-2 "PPPoX Interface Configuration Command" Command Parameters
Parameter Type Description
max-num-session <PPPoE::MaxNumSessions> optional parameter with default value: 4
range: [-1...2147483647] max no of PPP sessions established in PPPoX
interface
ppp-profile-name <AsamProfileName> optional parameter with default value:
range: [a-zA-Z0-9-_]length: 1<=x<32 "DefaultPppProfile"
the PPP profile to be used for PPP interface
vrfid
A unique value for each VRF assigned by the management.
bcast-vlan
The index that represents a VLAN that is used for forwarding upstream broadcast DHCP packets when DHCP relay
agent is disabled.
option-82
The operator can enable or disable the option 82 information insertion in the upstream broadcast DHCP packets.
Command Description
Allows the operator to configure the DHCP Relay agent per VRF interface.
User Level
The command can be accessed by operators with dhcp priviliges, and executed by operators with dhcp priviliges.
Command Syntax
The command has the following syntax:
> configure dhcp-relay agent (vrfid) bcast-vlan <Vlan::VlanId> [ no option-82 |
option-82 ]
Command Parameters
Table 26.1-1 "DHCP Relay Agent Configuration Command" Resource Parameters
Resource Identifier Type Description
(vrfid) <Vrf::VrfIndex> vrf index
range: [1...127]
Table 26.1-2 "DHCP Relay Agent Configuration Command" Command Parameters
Parameter Type Description
bcast-vlan <Vlan::VlanId> mandatory parameter
range: [1...4093] vlan used to forward upstream bcast DHCP packets
[ no ] option-82 <Dhcp::Option82> optional parameter with default value: "disable"
enable option82 info insertions in upstream bcast
pkts
Command Description
This node allows the operator to configure the DHCP SHub parameters.
User Level
The command can be accessed by operators with dhcp priviliges, and executed by operators with dhcp priviliges.
Command Syntax
The command has the following syntax:
> configure dhcp-relay shub [ no enable-relaying | enable-relaying ]
Command Parameters
Table 26.2-2 "DHCP Relay SHub Configuration Command" Command Parameters
Parameter Type Description
[ no ] enable-relaying <Dhcp::Relaying> optional parameter with default value:
"disable-relaying"
relay agent active or not
Command Description
These commands configures the list of DHCP Relay Server to a particular VRF.
User Level
The command can be accessed by operators with dhcp priviliges, and executed by operators with dhcp priviliges.
Command Syntax
The command has the following syntax:
> configure dhcp-relay shub [[no] relay-server (index) ip-addr <Ip::V4Address>
server-name <PrintableString-0-32> ]
Command Parameters
Table 26.3-1 "DHCP Relay SHub Server Configuration Command per VRF " Resource Parameters
Resource Identifier Type Description
(index) <Vrf::ShubVrfID> the vrf id
range: [0...127]
ip-addr <Ip::V4Address> IP address given to this interface
Table 26.3-2 "DHCP Relay SHub Server Configuration Command per VRF " Command
Parameters
Parameter Type Description
server-name <PrintableString-0-32> mandatory parameter
length: x<32 The name of the Relay Server
Command Description
These commands configure the DHCP Relay agent to a particular VRF.
User Level
The command can be accessed by operators with dhcp priviliges, and executed by operators with dhcp priviliges.
Command Syntax
The command has the following syntax:
> configure dhcp-relay shub relay-agent (index) [ no enable-relaying | enable-relaying
][ no secs-threshold | secs-threshold <Dhcp::SecsThreshold> ][ no hops-threshold |
hops-threshold <Dhcp::HopThreshold> ][ no context-lifetime | context-lifetime
<Dhcp::ContextLife> ]agent-ip-addr <Ip::V4Address>
Command Parameters
Table 26.4-1 "DHCP Relay SHub Agent Configuration Command per VRF" Resource Parameters
Resource Identifier Type Description
(index) <Vrf::ShubVrfID> the vrf id
range: [0...127]
Table 26.4-2 "DHCP Relay SHub Agent Configuration Command per VRF" Command Parameters
Parameter Type Description
[ no ] enable-relaying <Dhcp::RelayingPerVrf> optional parameter with default value:
"disable-relaying"
relay agent status for this vrf
secs-threshold <Dhcp::SecsThreshold> optional parameter with default value: 0
range: [0...5] the time within a request must be answered
hops-threshold <Dhcp::HopThreshold> optional parameter with default value: 4
range: [1...16] max nbr of hops the request may go through
context-lifetime <Dhcp::ContextLife> optional parameter with default value: 30
range: [1...120] availability of application context
agent-ip-addr <Ip::V4Address> mandatory parameter
agent IP address
Command Description
This command configures the OSPF parameters and attributes.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf [ no enable | enable ]router-id <Ip::V4Address> as-border-router
<Ospf::ASBdrRtrStatus> [ no overflow-state-it | overflow-state-it
<Ospf::OvrflowIntrvl> ][ no dis-rfc1583-comp | dis-rfc1583-comp ][ no abr-type |
abr-type <Ospf::AbrType> ][ no passive-interface | passive-interface ]
Command Parameters
Table 27.1-2 "OSPF Parameters Configuration Command" Command Parameters
Parameter Type Description
[ no ] enable <Ospf::EnableStatus> optional parameter with default value: "disable"
enable OSPF on the SHub
router-id <Ip::V4Address> mandatory parameter
uniquely identifying the Shub in the autonomous
system
as-border-router <Ospf::ASBdrRtrStatus> mandatory parameter
Possible values are : shub configured as a autonomous system border
- true : set to autonomous system border router
router
- false : no autonomous system border
router
overflow-state-it <Ospf::OvrflowIntrvl> optional parameter with default value: 0
range: [0...65535] unit: sec time the router attempts to leave the overflow state
[ no ] <Ospf::rfc1583Compatblty> optional parameter with default value: "enable"
dis-rfc1583-comp LSA advertisements compatible with RFC 1583
abr-type <Ospf::AbrType> optional parameter with default value: "standard"
Possible values are : type of area border router
- standard : standard abr
- cisco : cisco abr
- ibm : ibm abr
[ no ] <Ospf::PassiveIntf> optional parameter with default value:
passive-interface "non-passive"
sets OSPF interface to passive
Command Description
Information describing the configured parameters and cumulative statistics of the router's attached areas.
area identifier, 32-bit represented in decimal dotted notation.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf [[no] area (area-id) ]
Command Parameters
Table 27.2-1 "OSPF Area Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
Command Description
This command allows the operator to configure an OSPF interface.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf area (area-id) [[no] interface (ip-addr) [ no disable | disable ][ no
router-priority | router-priority <Ospf::Priority> ][ no passive | passive ][ no
itf-type | itf-type <Ospf::ITFType> ][ no authentication | authentication none | md5 |
plain | prompt | plain | plain : <Ospf::Key> ]]
Command Parameters
Table 27.3-1 "OSPF Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
(ip-addr) <Ip::V4Address> ip address identifying the interface
Table 27.3-2 "OSPF Interface Configuration Command" Command Parameters
Parameter Type Description
[ no ] disable <Ospf::InterfaceStatus> optional parameter with default value: "enable"
OSPF interface status
router-priority <Ospf::Priority> optional parameter with default value: 1
range: [0...255] priority used in router election algorithm
[ no ] passive <Ospf::PassiveIntface> optional parameter with default value:
"non-passive"
sets the interface as passive
itf-type <Ospf::ITFType> optional parameter with default value: "broadcast"
Possible values are : ospf interface type
- broadcast : broadcast lans like ethernet
- nbma : non broadcast multiple access
- point-point : point to point
- point-multipoint : point to multi point
authentication none | md5 | plain | prompt | plain | plain : optional parameter with default value: "none"
<Ospf::Key> indicates the OSPF interface authentication
Command Description
This command allows the user to configure the OSPF interface timers.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
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 27.4-1 "OSPF Interface Timers Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
(ip-addr) <Ip::V4Address> ip address identifying the interface
Table 27.4-2 "OSPF Interface Timers Configuration Command" Command Parameters
Parameter Type Description
transit-delay <Ospf::TransDelay> optional parameter with default value: 1
range: [0...3600] unit: sec time to transmit link update packets
retransmit-itvl <Ospf::RetransIntvl> optional parameter with default value: 5
range: [0...3600] unit: sec interval between LSA retransmission
hello-interval <Ospf::HelloIntvl> optional parameter with default value: 10
range: [1...65535] unit: sec interval between sending hello packets
dead-interval <Ospf::DeadIntvl> optional parameter with default value: 40
range: [0...65535] unit: sec interval when no hello pkts are received
poll-interval <Ospf::PollIntvl> optional parameter with default value: 120
range: [0...65535] unit: sec time between hello pkts sent to neighbour
Command Description
This command allows the operator to configure a MD5 key for an OSPF interface.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf area (area-id) interface (ip-addr) [[no] md5-key (index) key prompt |
plain : <Ospf::MD5key> | encrypted : <Ospf::MD5encryptedKey> [ no accept-starts |
accept-starts <Ospf::MD5startDelay> ][ no generate-starts | generate-starts
<Ospf::MD5startDelay> ]]
Command Parameters
Table 27.5-1 "OSPF Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
(ip-addr) <Ip::V4Address> ip address identifying the interface
(index) <Ospf::Md5KeyIndex> the number of the md5 key
range: [1...5]
Table 27.5-2 "OSPF Interface MD5 Key Configuration Command" Command Parameters
Parameter Type Description
key prompt | plain : <Ospf::MD5key> | mandatory parameter
encrypted : <Ospf::MD5encryptedKey> the md5 key
accept-starts <Ospf::MD5startDelay> optional parameter with default value: "now"
Possible values are : when the key must be used to accept
- now : the key will be used from now on
- <Ospf::MD5startDelay> : the delay
before the key will be used
generate-starts <Ospf::MD5startDelay> optional parameter with default value: "now"
Possible values are : when the key must be used to generate
- now : the key will be used from now on
- <Ospf::MD5startDelay> : the delay
before the key will be used
Command Output
Table 27.5-3 "OSPF Interface MD5 Key Configuration Command" Display parameters
Specific Information
name Type Description
accept-expires <Ospf::MD5expiryDelay> delay before the key expires for accepting
Possible values are : This element is only shown in detail mode.
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire
generate-expires <Ospf::MD5expiryDelay> delay before the key expires for generating
Possible values are : This element is only shown in detail mode.
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire
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 priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf area (area-id) interface (ip-addr) metric value <Ospf::Metric>
Command Parameters
Table 27.6-1 "OSPF Interface Metric Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
(ip-addr) <Ip::V4Address> ip address identifying the interface
Table 27.6-2 "OSPF Interface Metric Configuration Command" Command Parameters
Parameter Type Description
value <Ospf::Metric> mandatory parameter
range: [0...65535] the value for the metric
Command Description
This command is used to configure the OSPF stub area.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf [[no] stub-area (area-id) [ no metric-type | metric-type
<Ospf::MetricType> ][ no metric | metric <Ospf::StubMetric> ][ no summary | summary ]]
Command Parameters
Table 27.7-1 "OSPF Stub Area Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
Table 27.7-2 "OSPF Stub Area Configuration Command" Command Parameters
Parameter Type Description
metric-type <Ospf::MetricType> optional parameter with default value: "ospf"
Possible values are : type of metric advertised as a default route
- ospf : ospf metric
- comparable-metric : comparable cost
- non-comparable : non comparable
metric <Ospf::StubMetric> optional parameter with default value: 0
range: [0...16777215] metric value at the indicated TOS
[ no ] summary <Ospf::Summary> optional parameter with default value:
"no-summary"
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 priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) [[no] interface (ip-addr) [ no disable | disable
][ no router-priority | router-priority <Ospf::Priority> ][ no passive | passive ][ no
itf-type | itf-type <Ospf::ITFType> ][ no authentication | authentication none | md5 |
plain | prompt | plain | plain : <Ospf::Key> ]]
Command Parameters
Table 27.8-1 "OSPF Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
(ip-addr) <Ip::V4Address> ip address identifying the interface
Table 27.8-2 "OSPF Interface Configuration Command" Command Parameters
Parameter Type Description
[ no ] disable <Ospf::InterfaceStatus> optional parameter with default value: "enable"
OSPF interface status
router-priority <Ospf::Priority> optional parameter with default value: 1
range: [0...255] priority used in router election algorithm
[ no ] passive <Ospf::PassiveIntface> optional parameter with default value:
"non-passive"
sets the interface as passive
itf-type <Ospf::ITFType> optional parameter with default value: "broadcast"
Possible values are : ospf interface type
- broadcast : broadcast lans like ethernet
- nbma : non broadcast multiple access
- point-point : point to point
- point-multipoint : point to multi point
authentication none | md5 | plain | prompt | plain | plain : optional parameter with default value: "none"
<Ospf::Key> indicates the OSPF interface authentication
Command Description
This command allows the user to configure the OSPF interface timers.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
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 27.9-1 "OSPF Interface Timers Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
(ip-addr) <Ip::V4Address> ip address identifying the interface
Table 27.9-2 "OSPF Interface Timers Configuration Command" Command Parameters
Parameter Type Description
transit-delay <Ospf::TransDelay> optional parameter with default value: 1
range: [0...3600] unit: sec time to transmit link update packets
retransmit-itvl <Ospf::RetransIntvl> optional parameter with default value: 5
range: [0...3600] unit: sec interval between LSA retransmission
hello-interval <Ospf::HelloIntvl> optional parameter with default value: 10
range: [1...65535] unit: sec interval between sending hello packets
dead-interval <Ospf::DeadIntvl> optional parameter with default value: 40
range: [0...65535] unit: sec interval when no hello pkts are received
poll-interval <Ospf::PollIntvl> optional parameter with default value: 120
range: [0...65535] unit: sec time between hello pkts sent to neighbour
Command Description
This command allows the operator to configure a MD5 key for an OSPF interface.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) interface (ip-addr) [[no] md5-key (index) key
prompt | plain : <Ospf::MD5key> | encrypted : <Ospf::MD5encryptedKey> [ no
accept-starts | accept-starts <Ospf::MD5startDelay> ][ no generate-starts |
generate-starts <Ospf::MD5startDelay> ]]
Command Parameters
Table 27.10-1 "OSPF Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
(ip-addr) <Ip::V4Address> ip address identifying the interface
(index) <Ospf::Md5KeyIndex> the number of the md5 key
range: [1...5]
Table 27.10-2 "OSPF Interface MD5 Key Configuration Command" Command Parameters
Parameter Type Description
key prompt | plain : <Ospf::MD5key> | mandatory parameter
encrypted : <Ospf::MD5encryptedKey> the md5 key
accept-starts <Ospf::MD5startDelay> optional parameter with default value: "now"
Possible values are : when the key must be used to accept
- now : the key will be used from now on
- <Ospf::MD5startDelay> : the delay
before the key will be used
generate-starts <Ospf::MD5startDelay> optional parameter with default value: "now"
Possible values are : when the key must be used to generate
- now : the key will be used from now on
- <Ospf::MD5startDelay> : the delay
before the key will be used
Command Output
Table 27.10-3 "OSPF Interface MD5 Key Configuration Command" Display parameters
Specific Information
name Type Description
accept-expires <Ospf::MD5expiryDelay> delay before the key expires for accepting
Possible values are : This element is only shown in detail mode.
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire
generate-expires <Ospf::MD5expiryDelay> delay before the key expires for generating
Possible values are : This element is only shown in detail mode.
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire
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 priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) interface (ip-addr) metric value <Ospf::Metric>
Command Parameters
Table 27.11-1 "OSPF Interface Metric Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
(ip-addr) <Ip::V4Address> ip address identifying the interface
Table 27.11-2 "OSPF Interface Metric Configuration Command" Command Parameters
Parameter Type Description
value <Ospf::Metric> mandatory parameter
range: [0...65535] the value for the metric
Command Description
This command is used to configure OSPF nssa area.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf [[no] nssa-area (area-id) [ no summary | summary ][ no translation |
translation <Ospf::Trnsltn> ][ no trans-itvl | trans-itvl <Ospf::TrnltnIntvl> ][ no
asbr-rtr-trans | asbr-rtr-trans ]]
Command Parameters
Table 27.12-1 "OSPF Nssa Area Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
Table 27.12-2 "OSPF Nssa Area Configuration Command" Command Parameters
Parameter Type Description
[ no ] summary <Ospf::Summary> optional parameter with default value:
"no-summary"
controls the import of summary LSAs into stub
areas
translation <Ospf::Trnsltn> optional parameter with default value: "candidate"
Possible values are : NSSA routers ability to translate Type-7 to Type-5
- always : always LSAs
- candidate : candidate
trans-itvl <Ospf::TrnltnIntvl> optional parameter with default value: 40
range: [0...65535] unit: sec time trsltr finds its service is not reqd
[ no ] asbr-rtr-trans <Ospf::Asbr> optional parameter with default value: "disable"
p-bit setting for the type-7 LSA generated by
ASBR
Command Description
This command allows the operator to configure an OSPF interface.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) [[no] interface (ip-addr) [ no disable | disable
][ no router-priority | router-priority <Ospf::Priority> ][ no passive | passive ][ no
itf-type | itf-type <Ospf::ITFType> ][ no authentication | authentication none | md5 |
plain | prompt | plain | plain : <Ospf::Key> ]]
Command Parameters
Table 27.13-1 "OSPF Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
(ip-addr) <Ip::V4Address> ip address identifying the interface
Table 27.13-2 "OSPF Interface Configuration Command" Command Parameters
Parameter Type Description
[ no ] disable <Ospf::InterfaceStatus> optional parameter with default value: "enable"
OSPF interface status
router-priority <Ospf::Priority> optional parameter with default value: 1
range: [0...255] priority used in router election algorithm
[ no ] passive <Ospf::PassiveIntface> optional parameter with default value:
"non-passive"
sets the interface as passive
itf-type <Ospf::ITFType> optional parameter with default value: "broadcast"
Possible values are : ospf interface type
- broadcast : broadcast lans like ethernet
- nbma : non broadcast multiple access
- point-point : point to point
- point-multipoint : point to multi point
authentication none | md5 | plain | prompt | plain | plain : optional parameter with default value: "none"
<Ospf::Key> indicates the OSPF interface authentication
Command Description
This command allows the user to configure the OSPF interface timers.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
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 27.14-1 "OSPF Interface Timers Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
(ip-addr) <Ip::V4Address> ip address identifying the interface
Table 27.14-2 "OSPF Interface Timers Configuration Command" Command Parameters
Parameter Type Description
transit-delay <Ospf::TransDelay> optional parameter with default value: 1
range: [0...3600] unit: sec time to transmit link update packets
retransmit-itvl <Ospf::RetransIntvl> optional parameter with default value: 5
range: [0...3600] unit: sec interval between LSA retransmission
hello-interval <Ospf::HelloIntvl> optional parameter with default value: 10
range: [1...65535] unit: sec interval between sending hello packets
dead-interval <Ospf::DeadIntvl> optional parameter with default value: 40
range: [0...65535] unit: sec interval when no hello pkts are received
poll-interval <Ospf::PollIntvl> optional parameter with default value: 120
range: [0...65535] unit: sec time between hello pkts sent to neighbour
Command Description
This command allows the operator to configure a MD5 key for an OSPF interface.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) interface (ip-addr) [[no] md5-key (index) key
prompt | plain : <Ospf::MD5key> | encrypted : <Ospf::MD5encryptedKey> [ no
accept-starts | accept-starts <Ospf::MD5startDelay> ][ no generate-starts |
generate-starts <Ospf::MD5startDelay> ]]
Command Parameters
Table 27.15-1 "OSPF Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
(ip-addr) <Ip::V4Address> ip address identifying the interface
(index) <Ospf::Md5KeyIndex> the number of the md5 key
range: [1...5]
Table 27.15-2 "OSPF Interface MD5 Key Configuration Command" Command Parameters
Parameter Type Description
key prompt | plain : <Ospf::MD5key> | mandatory parameter
encrypted : <Ospf::MD5encryptedKey> the md5 key
accept-starts <Ospf::MD5startDelay> optional parameter with default value: "now"
Possible values are : when the key must be used to accept
- now : the key will be used from now on
- <Ospf::MD5startDelay> : the delay
before the key will be used
generate-starts <Ospf::MD5startDelay> optional parameter with default value: "now"
Possible values are : when the key must be used to generate
- now : the key will be used from now on
- <Ospf::MD5startDelay> : the delay
before the key will be used
Command Output
Table 27.15-3 "OSPF Interface MD5 Key Configuration Command" Display parameters
Specific Information
name Type Description
accept-expires <Ospf::MD5expiryDelay> delay before the key expires for accepting
Possible values are : This element is only shown in detail mode.
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire
generate-expires <Ospf::MD5expiryDelay> delay before the key expires for generating
Possible values are : This element is only shown in detail mode.
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire
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 priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) interface (ip-addr) metric value <Ospf::Metric>
Command Parameters
Table 27.16-1 "OSPF Interface Metric Configuration Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
(ip-addr) <Ip::V4Address> ip address identifying the interface
Table 27.16-2 "OSPF Interface Metric Configuration Command" Command Parameters
Parameter Type Description
value <Ospf::Metric> mandatory parameter
range: [0...65535] the value for the metric
Command Description
This command helps in configuration of the redistribution of the OSPF
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf redistribution [ no enable | enable ][ no local | local ][ no static
| static ][ no rip | rip ]
Command Parameters
Table 27.17-2 "OSPF Redistribution Configuration Command" Command Parameters
Parameter Type Description
[ no ] enable <Ospf::RRDStatus> optional parameter with default value: "disable"
enable OSPF route redistribution
[ no ] local <Ospf::Local> optional parameter with default value: "no-local"
import local routes to OSPF
[ no ] static <Ospf::Static> optional parameter with default value: "no-static"
import static routes to OSPF
[ no ] rip <Ospf::Rip> optional parameter with default value: "no-rip"
import rip routes to OSPF
Command Description
This command helps in configuration of the redistribution of the OSPF route parameters.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure ospf redistribution [[no] route-destination (dest-ip) [ no metric-type |
metric-type <Ospf::RouteMetricType> ][ no metric | metric <Ospf::RouteMetric> ]]
Command Parameters
Table 27.18-1 "OSPF Redistribution Route Configuration Command" Resource Parameters
Resource Identifier Type Description
(dest-ip) <Ip::V4Address> / <Ip::PrefixLengthFull> ip address and mask of the destination route
Table 27.18-2 "OSPF Redistribution Route Configuration Command" Command Parameters
Parameter Type Description
metric-type <Ospf::RouteMetricType> optional parameter with default value:
Possible values are : "as-ext-type2"
- as-ext-type1 : asexttype1 metric type metric type applied to the router
- as-ext-type2 : asexttype2 metric type
metric <Ospf::RouteMetric> optional parameter with default value: 10
range: [1...16777215] metric value applied to the router
Command Description
This command helps in configuration of redistribution of the RIP
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure rip redistribution [ no enable | enable ][ no default-metric |
default-metric <Rip::RouteMetric> ][ no local | local ][ no static | static ][ no ospf
| ospf ]
Command Parameters
Table 28.1-2 "RIP Redistribution Configuration Command" Command Parameters
Parameter Type Description
[ no ] enable <Rip::GblStat> optional parameter with default value: "disable"
indicates which routes need to be redistributed
default-metric <Rip::RouteMetric> optional parameter with default value: 3
range: [1...6] default metric used for the imported routes
[ no ] local <Rip::Local> optional parameter with default value: "no-local"
import local routes to RIP
[ no ] static <Rip::Static> optional parameter with default value: "no-static"
import static routes to RIP
[ no ] ospf <Rip::Ospf> optional parameter with default value: "no-ospf"
import ospf routes to RIP
Command Description
This command allows the user to configure Rip interface paramters.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure rip [[no] interface (ip-addr) [ no authentication | authentication none |
md5 | plain | prompt | plain | plain : <Rip::Key> ]default-metric <Rip::DefMetric> [
no send | send <Rip::ConfSend> ][ no receive | receive <Rip::ConfRcv> ][ no
split-horizon | split-horizon <Rip::SpltHorizon> ]]
Command Parameters
Table 28.2-1 "RIP Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) <Ip::V4Address> interface IP address
Table 28.2-2 "RIP Interface Configuration Command" Command Parameters
Parameter Type Description
authentication none | md5 | plain | prompt | plain | plain : optional parameter with default value: "none"
<Rip::Key> authentication method
default-metric <Rip::DefMetric> mandatory parameter
range: [0...15] The parameter is not visible during modification.
metric used for default route in RIP updates
send <Rip::ConfSend> optional parameter with default value:
Possible values are : "rip1-compatible"
- disable : don't send any packets RIP version used for sending RIP packets
- rip1 : rip version 1
- rip1-compatible : rip version 1 comptible
- rip2 : rip version 2
receive <Rip::ConfRcv> optional parameter with default value:
Possible values are : "rip1-or-rip2"
- rip1 : accept rip1 packets RIP version used for accepting RIP packets
- rip2 : accept rip2 packets
- rip1-or-rip2 : accept rip1 or rip2 packets
- disable : don't receive packets
split-horizon <Rip::SpltHorizon> optional parameter with default value: "enable"
Possible values are : split horizon status used in the system
- enable : enable split horizon
- poison-reverse : split horizon with
Poison Reverse
- disable : disable split horizon
Command Description
This command allows the user to configure Rip interface timers.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
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 28.3-1 "RIP Interface Timers Configuration Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) <Ip::V4Address> interface IP address
Table 28.3-2 "RIP Interface Timers Configuration Command" Command Parameters
Parameter Type Description
update-timer <Rip::UpdateTmr> optional parameter with default value: 30
range: [10...3600] unit: secs interval between RIP updates in secs
route-age-out <Rip::RouteAgeTmr> optional parameter with default value: 180
range: [30...500] unit: secs time for an unrefreshed route to be put in garbage
bin in secs
junk-collection <Rip::GrbTmr> optional parameter with default value: 120
range: [120...180] unit: secs lifetime of route in garbage bin in secs
Command Description
This command allows the operator to configure a MD5 key for an RIP interface.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> configure rip interface (ip-addr) [[no] md5-key (index) key prompt | plain :
<Rip::MD5key> | encrypted : <Rip::MD5encryptedKey> starts <Rip::MD5startDelay> expires
<Rip::MD5expiryDelay> ]
Command Parameters
Table 28.4-1 "RIP Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) <Ip::V4Address> interface IP address
(index) <Rip::Md5KeyIndex> the number of the md5 key
range: [1...5]
Table 28.4-2 "RIP Interface MD5 Key Configuration Command" Command Parameters
Parameter Type Description
key prompt | plain : <Rip::MD5key> | mandatory parameter
encrypted : <Rip::MD5encryptedKey> the md5 key
starts <Rip::MD5startDelay> mandatory parameter
Possible values are : when the key must be used
- now : the key will be used from now on
- <Rip::MD5startDelay> : the delay before
the key will be used
expires <Rip::MD5expiryDelay> mandatory parameter
Possible values are : delay before the key expires
- now : the key will expire now
- never : the key will never expire
- <Rip::MD5expiryDelay> : the delay
before the key will expire
Command Description
Following information is shown per slot:
• type : the type of the board that is currently present in the slot.
• oper-status: describes if the board is able to perform its normal operation.
• error-status: 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.
• manufacturer: an identification of the manufacturer of the board.
• inventory-pba: the Alcatel Printed Board Assembly code of of the code.
• inventory-fpba: the Alcatel Printed Board Assembly code of the board, which also identifies the boot software.
• inventory-ics: the Item Change Status iteration code of the board.
• inventory-clie: the (USA) Common Language Equipment Identification code of the board.
• serial-no: the serial number of the board.
• failed-test: identification of the last failing test by means of 4 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 selftest, the value of this attribute will be 0.
User Level
The command can be accessed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> show equipment slot (slot)
Command Parameters
Table 29.1-1 "Slot Status Command" Resource Parameters
Resource Identifier Type Description
(slot) <Eqpt::Rack> / <Eqpt::Shelf> / the physical slot position
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
Command Output
Table 29.1-2 "Slot Status Command" Display parameters
Specific Information
Command Description
Following information is shown per applique slot:
• type : the type of the applique that is currently present in the slot.
• oper-status: describes if the applique is able to perform its normal operation.
• error-status: 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: an identification of the manufacturer of the applique.
• inventory-pba: the Alcatel Printed Board Assembly code of of the code.
• inventory-fpba: the Alcatel Printed Board Assembly code of the board, which also identifies the boot software.
• inventory-ics: the Item Change Status iteration code of the board.
• inventory-clie: the (USA) Common Language Equipment Identification code of the board.
• serial-no: the serial number of the board.
• failed-test: identification of the last failing test by means of 4 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 selftest, the value of this attribute will be 0.
User Level
The command can be accessed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> show equipment applique (applique)
Command Parameters
Table 29.2-1 "Applique Status Command" Resource Parameters
Resource Identifier Type Description
(applique) <Eqpt::Rack> / <Eqpt::Shelf> / the physical applique position
<Eqpt::Applique>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Applique>= range: [1...21]
Command Output
Table 29.2-2 "Applique Status Command" Display parameters
Specific Information
Command Description
This node gives the operator a summary of the slots in a shelf.
The least significant bit of the first byte shown corresponds to slot position 1.
User Level
none
Command Syntax
The command has the following syntax:
> show equipment shelf-summary (shelf)
Command Parameters
Table 29.3-1 "Shelf Summary Status Command" Resource Parameters
Resource Identifier Type Description
(shelf) <Eqpt::Rack> / <Eqpt::Shelf> the physical shelf position
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]
Command Output
Table 29.3-2 "Shelf Summary Status Command" Display parameters
Specific Information
name Type Description
changes <Counter> Number of configuration or status changes for
slots/boards within this shelf.
This element is always shown.
occupied-slots <Binary-08-08> Specifies the occupation of slots.
length: 8 This element is only shown in detail mode.
admin-unlocked <Binary-08-08> Specifies the administrative state of the boards
length: 8 whether it is locked or not.
This element is only shown in detail mode.
oper-unlocked <Binary-08-08> Specifies the operational state of the boards
length: 8 whether it is locked or not.
This element is only shown in detail mode.
avail-boards <Binary-08-08> Specifies the availability state of the boards
length: 8 whether it is available or not.
This element is only shown in detail mode.
mismatches <Binary-08-08> Specifies any mismatch between the actual
length: 8 board-type and the planned board-type.
This element is always shown.
alarms <Binary-08-08> Specifies the boards which generated an alarm.
Command Description
This node allows the operator to show the shelf status. Following information is given in addition to configuration
information:
• oper-status: describes if the board is able to perform its normal operation.
• error-status: 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 equip priviliges.
Command Syntax
The command has the following syntax:
> show equipment shelf (shelf)
Command Parameters
Table 29.4-1 "Shelf Status Command" Resource Parameters
Resource Identifier Type Description
(shelf) <Eqpt::Rack> / <Eqpt::Shelf> a shelf identifier: <rack>/<shelf>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]
Command Output
Table 29.4-2 "Shelf Status Command" Display parameters
Specific Information
name Type Description
admin-status <Equipm::HolderAdminStatus> Specifies the equipment holder is locked or not.
short name:locked Possible values are : This element is always shown.
- lock : the holder is locked
- unlock : the holder is unlocked
oper-status <Equipm::OperStatus> Specifies whether or not the equipment holder is
short name:enabled Possible values are : capable of performing its normal functions.
- enabled : This element is always shown.
- disabled :
error-status <Equipm::OperError> Specifies for what reason the equipment holder is
Possible values are : not operational.
- no-error : This element is always shown.
- type-mismatch :
- board-missing :
- no-installation :
Command Description
This node allows the operator to show the ISAM status.
User Level
The command can be accessed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> show equipment isam
Command Output
Table 29.5-2 "ISAM Status Command" Display parameters
Specific Information
name Type Description
planned-type <Equipm::SystemType> Specifies the planned type of equipment holder.
Possible values are : This element is always shown.
- 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
Command Description
This node allows the operator to show the rack status.
User Level
The command can be accessed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> show equipment rack (index)
Command Parameters
Table 29.6-1 "Rack Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Eqpt::Rack> a shelf identifier: <rack>/<shelf>
range: [1...1]
Command Output
Table 29.6-2 "Rack Status Command" Display parameters
Specific Information
name Type Description
planned-type <Equipm::RackType> Specifies the planned type of equipment holder.
Possible values are : This element is always shown.
- 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
Command Description
This command show the status of the trap manager queue.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show trap manager (address)
Command Parameters
Table 30.1-1 "Trap Manager Queue Status Command" Resource Parameters
Resource Identifier Type Description
(address) <Ip::V4Address> : <Trap::Port> the IP address of the manager
<Ip::V4Address>: <Trap::Port>= range:
[1...65535]
Command Output
Table 30.1-2 "Trap Manager Queue Status Command" Display parameters
Specific Information
name Type Description
last-reset-time <Sys::Time> time when the buffer has been reset.
This element is always shown.
buffer-status <Trap::QueueStatus> specifies whether the trap buffer is overflowed or
Possible values are : not.
- no-traps-lost : the queue did not overflow This element is always shown.
- no traps were lost
- traps-lost : the queue did overflow - traps
were lost
Command Description
This command displays the alarm log entries.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm log table (index)
Command Parameters
Table 31.1-1 "Alarm Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm log table index
Command Output
Table 31.1-2 "Alarm Log Status Command" Display parameters
Specific Information
name Type Description
type <Alarm::alarmType> unique id for an alarm.
Possible values are : This element is always shown.
- equipment : equipment alarms
- eqpt-holder : equipment holder alarms
- plugin-unit : plugin unit alarms
- atm : ATM alarms
- custom : customizable alarms
- ether-itf : ethernet interface alarms
- software-mngt : software management
alarms
- xdsl : xDSL alarms
- xdsl-tca : xDSL threshold cross alarms
- eo-conv : E/O conversion related alarms
- authentication : authentication related
alarms
status <UnsignedInteger> reflect's the state of the alarm as either active or
non-active.
This element is always shown.
prev-status <UnsignedInteger> changes in the status with its previous logged value
This element is only shown in detail mode.
last-updated-on <Sys::Time> network time in seconds when the alarm was
Command Description
show the current status of equipment
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm log equipment (index)
Command Parameters
Table 31.2-1 "Alarm Equipment Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm log table index
Command Output
Table 31.2-2 "Alarm Equipment Status Command" Display parameters
Specific Information
name Type Description
persist-data <Alarm::persistDataLoss> current status specifing persistant data is lost or not
Possible values are : This element is always shown.
- lost : persistant data is lost
- not-lost : persistant data is not lost
prev-status <Alarm::persistDataLoss> status of persist-data with its previous logged value.
Possible values are : This element is only shown in detail mode.
- lost : persistant data is lost
- not-lost : persistant data is not lost
sntp-comm <Alarm::sntpCommLoss> current status of sntp communication is lost or not
Possible values are : This element is always shown.
- lost : SNTP communication lost
- not-lost : SNTP communication is not
lost
prev-status <Alarm::sntpCommLoss> status of sntp communication with its previous
Possible values are : logged value.
- lost : SNTP communication lost This element is only shown in detail mode.
- not-lost : SNTP communication is not
lost
nt-disk <Alarm::ntDiskSpace> current status of nt disk space is 90% full or less
Possible values are : than that
- ninty-perc-full : NT disk space is 90% This element is always shown.
Command Description
show the equipment holder logs
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm log eqpt-holder (index)
Command Parameters
Table 31.3-1 "Alarm Equipment Holder Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm log table index
Command Output
Table 31.3-2 "Alarm Equipment Holder Status Command" Display parameters
Specific Information
name Type Description
shelf <Eqpt::Rack> / <Eqpt::Shelf> speify which shelf the alarm occurred.
<Eqpt::Rack>= range: [1...1]/ This element is always shown.
<Eqpt::Shelf>= range: [1...1]
rack-power <Alarm::rackPower> current status of rack power alarm, indicating fuse
Possible values are : is broken or intact
- fuse-broken : the fuse is broken This element is always shown.
- fuse-ok : the fuse is intact
prev-status <Alarm::rackPower> status of rack power alarm with its previous logged
Possible values are : value.
- fuse-broken : the fuse is broken This element is only shown in detail mode.
- fuse-ok : the fuse is intact
fan-unit1 <Alarm::fanUnit1> current status of fan-unit1
Possible values are : This element is always shown.
- failing : fan unit 1 is failing
- ok : fan unit 1 is ok
prev-status <Alarm::fanUnit1> status of fan-unit1 with its previous logged value.
Possible values are : This element is only shown in detail mode.
- failing : fan unit 1 is failing
- ok : fan unit 1 is ok
fan-unit2 <Alarm::fanUnit2> current status of fan-unit2
Possible values are : This element is always shown.
Command Description
show the plug in unit alarm log status
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm log plug-in-unit (index)
Command Parameters
Table 31.4-1 "Alarm Plug in Unit Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm log table index
Command Output
Table 31.4-2 "Alarm Plug in Unit Status Command" Display parameters
Specific Information
name Type Description
board-position <Eqpt::Rack> / <Eqpt::Shelf> / identify where the alarm has occurred.
<Eqpt::Slot> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
board-mismatch <Alarm::boardMismatch> alarm specifing the planned and plugged-in types
Possible values are : are different
- yes : planned and plugged-in types are This element is always shown.
different
- no : planned and plugged-in types are
same
prev-status <Alarm::boardMismatch> status of board-mismatch with its previous logged
Possible values are : value.
- yes : planned and plugged-in types are This element is only shown in detail mode.
different
- no : planned and plugged-in types are
same
sw-download <Alarm::swStatus> alarm specifing download of the software is
Possible values are : completed or not.
- waiting : not able to download all the This element is always shown.
applicable SW files
Command Description
This command displays the ATM alarm log status.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm log atm (index)
Command Parameters
Table 31.5-1 "Alarm ATM Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm log table index
Command Output
Table 31.5-2 "Alarm ATM Status Command" Display parameters
Specific Information
name Type Description
port <Eqpt::Rack> / <Eqpt::Shelf> / identify where the alarm has occurred.
<Eqpt::Slot> / <Eqpt::Port> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]/
<Eqpt::Port>= range: [1...48]
vpi-vci <Alarm::VpiVciValues> identify where the alarm has occurred.
This element is always shown.
cell-dis-up <Alarm::CellDiscardUpstream> specifies ATM cell is discarded or not in upstream
Possible values are : direction.
- discarded : ATM cell discarded in This element is always shown.
upstream direction
- no-discard : no ATM cell discarded in
upstream direction
prev-status <Alarm::CellDiscardUpstream> status of cell-dis-up with its previous logged value.
Possible values are : This element is only shown in detail mode.
- discarded : ATM cell discarded in
upstream direction
- no-discard : no ATM cell discarded in
upstream direction
cell-dis-down <Alarm::CellDiscardDownstream> specifies ATM cell is discarded or not in
Command Description
show the ethernet interface alarm log status
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm log ether-itf (index)
Command Parameters
Table 31.6-1 "Alarm Ethernet Interface Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm log table index
Command Output
Table 31.6-2 "Alarm Ethernet Interface Log Status Command" Display parameters
Specific Information
name Type Description
ether-ifindex <SignedInteger> identify where the alarm has occurred.
This element is always shown.
link-down <Alarm::EtherLinkStatus> specifies ethernet link status.
Possible values are : This element is always shown.
- yes : board switched off - excess
temperature
- no : board switched on
prev-status <Alarm::EtherLinkStatus> status of link-down with its previous logged value.
Possible values are : This element is only shown in detail mode.
- yes : board switched off - excess
temperature
- no : board switched on
Command Description
show the software management alarm log status.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm log sw-mgmt (index)
Command Parameters
Table 31.7-1 "Alarm Software Management Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm log table index
Command Output
Table 31.7-2 "Alarm Software Management Status Command" Display parameters
Specific Information
name Type Description
nt-position <Eqpt::Rack> / <Eqpt::Shelf> / identifies the physical position of the slot
<Eqpt::Slot> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
sw-rollback <Alarm::SwRollback> specifies implicit software rollback is performed or
Possible values are : not.
- yes : implicit software rollback This element is always shown.
performed
- no : no implicit software rollback
prev-status <Alarm::SwRollback> status of sw-rollback with its previous logged
Possible values are : value.
- yes : implicit software rollback This element is only shown in detail mode.
performed
- no : no implicit software rollback
db-rollback <Alarm::DbRollback> specifies implicit database rollback is performed or
Possible values are : not.
- yes : implicit database rollback This element is always shown.
performed
- no : no implicit database rollback
prev-status <Alarm::DbRollback> status of db-rollback with its previous logged value.
Command Description
This command displays the xDSL alarm log status.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm log xdsl misc (index)
Command Parameters
Table 31.8-1 "Alarm xDSL Common Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm log table index
Command Output
Table 31.8-2 "Alarm xDSL Common Status Command" Display parameters
Specific Information
name Type Description
port <Eqpt::Rack> / <Eqpt::Shelf> / identifies the physical position of the port
<Eqpt::Slot> / <Eqpt::Port> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]/
<Eqpt::Port>= range: [1...48]
line-config <Alarm::LineConfig> specifies whether line configuration data is used or
Possible values are : not.
- config-error : line configuration data This element is always shown.
cannot be used
- config-ok : Line configuration data OK
prev-status <Alarm::LineConfig> status of line-config with its previous logged value.
Possible values are : This element is only shown in detail mode.
- config-error : line configuration data
cannot be used
- config-ok : Line configuration data OK
line-capacity <Alarm::LineCapacity> specifies whether line capacity is set up or not.
Possible values are : This element is always shown.
- below-requirement : line capacity not
enough to set up requested profile
- meets-requirement : line capacity enough
Command Description
This command displays the xDSL alarm log status.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm log xdsl near-end (index)
Command Parameters
Table 31.9-1 "Alarm xDSL Near End Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm log table index
Command Output
Table 31.9-2 "Alarm xDSL Near End Status Command" Display parameters
Specific Information
name Type Description
port <Eqpt::Rack> / <Eqpt::Shelf> / Specifies where the alarm occurred.
<Eqpt::Slot> / <Eqpt::Port> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]/
<Eqpt::Port>= range: [1...48]
los <Alarm::NearEndLOS> specifies near end loss of signal occured or not.
Possible values are : This element is always shown.
- occured : near end loss of signal occured
- not-occured : no near end loss of signal
prev-status <Alarm::NearEndLOS> status of los with its previous logged value.
Possible values are : This element is only shown in detail mode.
- occured : near end loss of signal occured
- not-occured : no near end loss of signal
lof <Alarm::NearEndLOF> specifies near end loss of frame occured or not.
Possible values are : This element is always shown.
- occured : near end loss of frame occured
- not-occured : no near end loss of frame
prev-status <Alarm::NearEndLOF> status of lof with its previous logged value.
Possible values are : This element is only shown in detail mode.
- occured : near end loss of frame occured
Command Description
This command displays the xDSL alarm log status.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm log xdsl far-end (index)
Command Parameters
Table 31.10-1 "Alarm xDSL Far End Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm log table index
Command Output
Table 31.10-2 "Alarm xDSL Far End Status Command" Display parameters
Specific Information
name Type Description
port <Eqpt::Rack> / <Eqpt::Shelf> / identifies where the alarm occurred
<Eqpt::Slot> / <Eqpt::Port> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]/
<Eqpt::Port>= range: [1...48]
los <Alarm::FarEndLOS> specifies whether far end loss of signal occured or
Possible values are : not.
- occured : far end loss of signal occured This element is always shown.
- not-occured : no far end loss of signal
prev-status <Alarm::FarEndLOS> status of los with its previous logged value.
Possible values are : This element is only shown in detail mode.
- occured : far end loss of signal occured
- not-occured : no far end loss of signal
lof <Alarm::FarEndLOF> specifies whether far end loss of frame occured or
Possible values are : not.
- occured : far end loss of frame occured This element is always shown.
- not-occured : no far end loss of frame
prev-status <Alarm::FarEndLOF> status of lof with its previous logged value.
Possible values are : This element is only shown in detail mode.
- occured : far end loss of frame occured
Command Description
show the xDSL threshold cross alarm log status.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm log tca-xdsl (index)
Command Parameters
Table 31.11-1 "Alarm TCA-xDSL Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm log table index
Command Output
Table 31.11-2 "Alarm TCA-xDSL Log Status Command" Display parameters
Specific Information
name Type Description
port <Eqpt::Rack> / <Eqpt::Shelf> / identifies where the alarm occurred
<Eqpt::Slot> / <Eqpt::Port> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]/
<Eqpt::Port>= range: [1...48]
errored-secs <Alarm::ErroredSeconds> number of errored seconds exceeded or below
Possible values are : threshold
- above-thres : number of errored seconds This element is always shown.
exceeded threshold
- below-thres : number of errored seconds
below threshold
prev-status <Alarm::ErroredSeconds> status of errored-secs with its previous logged
Possible values are : value.
- above-thres : number of errored seconds This element is only shown in detail mode.
exceeded threshold
- below-thres : number of errored seconds
below threshold
es-in-a-day <Alarm::ErroredSecondsInAday> errored seconds in a day exceeded or below
Possible values are : threshold
- above-thres : number of errored seconds This element is always shown.
Command Description
show the electrical to optical conversion alarm log status
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm log eo-conversion (index)
Command Parameters
Table 31.12-1 "Alarm log Electrical to Optical Conversion Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm log table index
Command Output
Table 31.12-2 "Alarm log Electrical to Optical Conversion Status Command" Display parameters
Specific Information
name Type Description
port <SignedInteger> identifies where the alarm occurred
This element is always shown.
loss-of-signal <Alarm::EoConvLOS> specifies whether loss of signal detected or not in
Possible values are : the EO conversion module
- detected : loss of signal detected in the This element is always shown.
EO conversion module
- not-detected : no loss of signal detected
in the EO conversion module
prev-status <Alarm::EoConvLOS> status of loss-of-signal with its previous logged
Possible values are : value.
- detected : loss of signal detected in the This element is only shown in detail mode.
EO conversion module
- not-detected : no loss of signal detected
in the EO conversion module
transmission <Alarm::EoConvTx> specifies whether transmission fault is occurred or
Possible values are : not in the EO module
- faulty : transmission fault in the EO This element is always shown.
module
Command Description
This command displays the authentication related alarm log status.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm log authentication (index)
Command Parameters
Table 31.13-1 "Alarm Authentication Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm log table index
Command Output
Table 31.13-2 "Alarm Authentication Status Command" Display parameters
Specific Information
name Type Description
vrf-assignment <Alarm::VRFassignment> specifies whether VRF for a user session is
Possible values are : assigned or failed
- failed : failure to assign a VRF for a user This element is always shown.
session
- successful : assigned a VRF for a user
session
prev-status <Alarm::VRFassignment> status of vrf-assignment with its previous logged
Possible values are : value.
- failed : failure to assign a VRF for a user This element is only shown in detail mode.
session
- successful : assigned a VRF for a user
session
vlan-assignment <Alarm::VLANassignment> specifies whether a VLAN for a user session is
Possible values are : assigned or failed
- failed : failure to assign a VLAN for a This element is always shown.
user session
- successful : assigned a VLAN for a user
session
prev-status <Alarm::VLANassignment> status of vlan-assignment with its previous logged
Possible values are : value.
- failed : failure to assign a VLAN for a This element is only shown in detail mode.
Command Description
This command displays all the current alarms.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm current table (index)
Command Parameters
Table 32.1-1 "Alarm Current Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm type
Command Output
Table 32.1-2 "Alarm Current Status Command" Display parameters
Specific Information
name Type Description
type <Alarm::alarmType> type of the alarms that are active.
Possible values are : This element is always shown.
- equipment : equipment alarms
- eqpt-holder : equipment holder alarms
- plugin-unit : plugin unit alarms
- atm : ATM alarms
- custom : customizable alarms
- ether-itf : ethernet interface alarms
- software-mngt : software management
alarms
- xdsl : xDSL alarms
- xdsl-tca : xDSL threshold cross alarms
- eo-conv : E/O conversion related alarms
- authentication : authentication related
alarms
status <UnsignedInteger> current status of all alarms within one alarm type
This element is always shown.
last-updated-on <Sys::Time> time in seconds when the entry was updated.
This element is always shown.
Only Show Details: number of changes since start up and number of entires in the table
Command Description
This command displays the current alarms of the equipment.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm current equipment (index)
Command Parameters
Table 32.2-1 "Alarm Current Equipment Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm type
Command Output
Table 32.2-2 "Alarm Current Equipment Status Command" Display parameters
Specific Information
name Type Description
persist-data <Alarm::persistDataLoss> current status specifing persistant data is lost or not
Possible values are : This element is always shown.
- lost : persistant data is lost
- not-lost : persistant data is not lost
sntp-comm <Alarm::sntpCommLoss> current status of sntp communication is lost or not
Possible values are : This element is always shown.
- lost : SNTP communication lost
- not-lost : SNTP communication is not
lost
nt-disk <Alarm::ntDiskSpace> current status of nt disk space is 90% full or less
Possible values are : than that
- ninty-perc-full : NT disk space is 90% This element is always shown.
full
- less-than-ninty-perc : NT disk space
usage less that 90%
connection-lost <Alarm::ShubLoc> current status of nt shub communication is lost or
Possible values are : intact
- lost : NT shub communication lost This element is always shown.
- not-lost : NT shub communication intact
Command Description
This command displays the alarms, current in the equipment holder.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm current eqpt-holder (index)
Command Parameters
Table 32.3-1 "Alarm Equipment Holder Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm type
Command Output
Table 32.3-2 "Alarm Equipment Holder Status Command" Display parameters
Specific Information
name Type Description
rack-power <Alarm::rackPower> current status of rack power alarm, indicating fuse
Possible values are : is broken or intact
- fuse-broken : the fuse is broken This element is always shown.
- fuse-ok : the fuse is intact
fan-unit1 <Alarm::fanUnit1> current status of fan-unit1
Possible values are : This element is always shown.
- failing : fan unit 1 is failing
- ok : fan unit 1 is ok
fan-unit2 <Alarm::fanUnit2> current status of fan-unit2
Possible values are : This element is always shown.
- failing : fan unit 2 is failing
- ok : fan unit 2 is ok
shelf-type-mismatch <Alarm::shelfTypeMismatch> current status specifies installed and planned shelf
Possible values are : types are different
- mismatch : installed and planned shelf This element is always shown.
types are different
- no-mismatch : installed and planned
shelf types are the same
ext-chain-instl <Alarm::extChainInstl> current alarm status of consistency problem
Possible values are : detected for installation of extension chain
- consistancy-problem : consistency This element is always shown.
Command Description
This command displays the plug in unit alarm logs generated.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm current plug-in-unit (index)
Command Parameters
Table 32.4-1 "Alarm Plug In Unit Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm type
Command Output
Table 32.4-2 "Alarm Plug In Unit Status Command" Display parameters
Specific Information
name Type Description
board-position <Eqpt::Rack> / <Eqpt::Shelf> / identify where the alarm has occurred.
<Eqpt::Slot> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
board-mismatch <Alarm::boardMismatch> alarm specifing the planned and plugged-in types
Possible values are : are different
- yes : planned and plugged-in types are This element is always shown.
different
- no : planned and plugged-in types are
same
sw-download <Alarm::swStatus> alarm specifing download of the software is
Possible values are : completed or not.
- waiting : not able to download all the This element is always shown.
applicable SW files
- completed : download completed
temperature <Alarm::tempStatus> alarm specifing board temperature is crossed the
Possible values are : threshold or not.
- above-thres : temperature threshold on This element is only shown in detail mode.
board exceeded
- below-thres : board temperature within
Command Description
This command displays the current ATM alarm status.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm current atm (index)
Command Parameters
Table 32.5-1 "Alarm Current ATM Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm type
Command Output
Table 32.5-2 "Alarm Current ATM Status Command" Display parameters
Specific Information
name Type Description
port <Eqpt::Rack> / <Eqpt::Shelf> / identify where the alarm has occurred.
<Eqpt::Slot> / <Eqpt::Port> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]/
<Eqpt::Port>= range: [1...48]
vpi-vci <Alarm::VpiVciValues> identify where the alarm has occurred.
This element is always shown.
cell-discard-up <Alarm::CellDiscardUpstream> specifies ATM cell is discarded or not in upstream
Possible values are : direction.
- discarded : ATM cell discarded in This element is always shown.
upstream direction
- no-discard : no ATM cell discarded in
upstream direction
cell-discard-down <Alarm::CellDiscardDownstream> specifies ATM cell is discarded or not in
Possible values are : downstream direction.
- discarded : ATM cell discarded in This element is always shown.
downstream direction
- no-discard : no ATM cell discarded in
downstream direction
mac-conflict <Alarm::MACconflict> specifies whether duplicate MAC address from the
Command Description
show the current ethernet interface alarm status
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm current ether-itf (index)
Command Parameters
Table 32.6-1 "Alarm Current Ethernet Interface Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm type
Command Output
Table 32.6-2 "Alarm Current Ethernet Interface Status Command" Display parameters
Specific Information
name Type Description
ether-ifindex <SignedInteger> identify where the alarm has occurred.
This element is always shown.
link-down <Alarm::EtherLinkStatus> specifies ethernet link status.
Possible values are : This element is always shown.
- yes : board switched off - excess
temperature
- no : board switched on
Command Description
show the software management alarm current status
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm current sw-mgmt (index)
Command Parameters
Table 32.7-1 "Alarm Current Software Management Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm type
Command Output
Table 32.7-2 "Alarm Current Software Management Status Command" Display parameters
Specific Information
name Type Description
nt-position <Eqpt::Rack> / <Eqpt::Shelf> / identifies the physical position of the slot
<Eqpt::Slot> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
sw-rollback <Alarm::SwRollback> specifies implicit software rollback is performed or
Possible values are : not.
- yes : implicit software rollback This element is always shown.
performed
- no : no implicit software rollback
db-rollback <Alarm::DbRollback> specifies implicit database rollback is performed or
Possible values are : not.
- yes : implicit database rollback This element is always shown.
performed
- no : no implicit database rollback
Command Description
This command displays the current xDSL alarms.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm current xdsl (index)
Command Parameters
Table 32.8-1 "Alarm Current xDSL Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm type
Command Output
Table 32.8-2 "Alarm Current xDSL Status Command" Display parameters
Specific Information
name Type Description
port <Eqpt::Rack> / <Eqpt::Shelf> / identifies the physical position of the port
<Eqpt::Slot> / <Eqpt::Port> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]/
<Eqpt::Port>= range: [1...48]
near-end-los <Alarm::NearEndLOS> specifies near end loss of signal occured or not.
Possible values are : This element is only shown in detail mode.
- occured : near end loss of signal occured
- not-occured : no near end loss of signal
near-end-lof <Alarm::NearEndLOF> specifies near end loss of frame occured or not.
Possible values are : This element is only shown in detail mode.
- occured : near end loss of frame occured
- not-occured : no near end loss of frame
near-end-lom <Alarm::NearEndLOM> specifies near end loss of margin occured or not.
Possible values are : This element is only shown in detail mode.
- occured : near end loss of margin
occured
- not-occured : no near end loss of margin
near-end-ese <Alarm::NearEndESE> specifies near end excessive server errors occured
Possible values are : or not.
Command Description
show the xDSL threshold cross alarm log status
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm current tca-xdsl (index)
Command Parameters
Table 32.9-1 "Alarm TCA-xDSL Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm type
Command Output
Table 32.9-2 "Alarm TCA-xDSL Log Status Command" Display parameters
Specific Information
name Type Description
port <Eqpt::Rack> / <Eqpt::Shelf> / identifies where the alarm occurred
<Eqpt::Slot> / <Eqpt::Port> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]/
<Eqpt::Port>= range: [1...48]
errored-secs <Alarm::ErroredSeconds> number of errored seconds exceeded or below
Possible values are : threshold
- above-thres : number of errored seconds This element is always shown.
exceeded threshold
- below-thres : number of errored seconds
below threshold
es-in-a-day <Alarm::ErroredSecondsInAday> errored seconds in a day exceeded or below
Possible values are : threshold
- above-thres : number of errored seconds This element is always shown.
in a day, exceeded threshold
- below-thres : number of errored seconds
in a day, below threshold
severely-es <Alarm::SeverelyErroredSeconds> number of severely errored seconds exceeded or
Possible values are : below threshold
- above-thres : number of severely errored This element is only shown in detail mode.
Command Description
show the electrical to optical conversion alarm log status
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm current eo-conversion (index)
Command Parameters
Table 32.10-1 "Alarm Electrical to Optical Conversion Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm type
Command Output
Table 32.10-2 "Alarm Electrical to Optical Conversion Status Command" Display parameters
Specific Information
name Type Description
port <SignedInteger> identifies where the alarm occurred.
This element is always shown.
loss-of-signal <Alarm::EoConvLOS> specifies whether loss of signal detected or not in
Possible values are : the EO conversion module
- detected : loss of signal detected in the This element is always shown.
EO conversion module
- not-detected : no loss of signal detected
in the EO conversion module
transmission <Alarm::EoConvTx> specifies whether transmission fault is occurred or
Possible values are : not in the EO module
- faulty : transmission fault in the EO This element is always shown.
module
- ok : transmission OK
Command Description
This command displays the authentication related alarms.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm current authentication (index)
Command Parameters
Table 32.11-1 "Alarm Current Authentication Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm type
Command Output
Table 32.11-2 "Alarm Current Authentication Status Command" Display parameters
Specific Information
name Type Description
vrf-assignment <Alarm::VRFassignment> specifies whether VRF for a user session is
Possible values are : assigned or failed
- failed : failure to assign a VRF for a user This element is always shown.
session
- successful : assigned a VRF for a user
session
vlan-assignment <Alarm::VLANassignment> specifies whether a VLAN for a user session is
Possible values are : assigned or failed
- failed : failure to assign a VLAN for a This element is always shown.
user session
- successful : assigned a VLAN for a user
session
ip-addr-pool-assign <Alarm::IPaddrPoolAssign> specifies whether IP address pool for a user session
Possible values are : is assigned or failed
- failed : failure to assign IP address pool This element is always shown.
for a user session
- successful : assigned IP address pool for
a user session
Command Description
This command displays the snap shot alarm entries.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm snap-shot table (index)
Command Parameters
Table 33.1-1 "Alarm Snap-shot Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 33.1-2 "Alarm Snap-shot Status Command" Display parameters
Common Information
name Type Description
timeout-period <TimeTicks> specifies the time out of the snapshot table
This element is always shown.
entries <Gauge> specifies nbr of entries in the snapshot table.
This element is always shown.
indeterminate <Alarm::IndetSevState> active indeterminate severity levels of the alarms in
Possible values are : the snapshot table.
- active : at least one entry of this severity This element is always shown.
is present
- not-active : no entries of this severity
warning <Alarm::WarnSevState> active warning severity levels of the alarms in the
Possible values are : snapshot table.
- active : at least one entry of this severity This element is always shown.
is present
- not-active : no entries of this severity
minor <Alarm::MinorSevState> active minor severity levels of the alarms in the
Possible values are : snapshot table.
- active : at least one entry of this severity This element is always shown.
is present
- not-active : no entries of this severity
major <Alarm::MajorSevState> active major severity levels of the alarms in the
Possible values are : snapshot table.
Command Description
show the snap-shot of equipment
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm snap-shot equipment (index)
Command Parameters
Table 33.2-1 "Alarm Snap-shot Equipment Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 33.2-2 "Alarm Snap-shot Equipment Status Command" Display parameters
Specific Information
name Type Description
persist-data <Alarm::persistDataLoss> current status specifing persistant data is lost or not
Possible values are : This element is always shown.
- lost : persistant data is lost
- not-lost : persistant data is not lost
sntp-comm <Alarm::sntpCommLoss> current status of sntp communication is lost or not
Possible values are : This element is always shown.
- lost : SNTP communication lost
- not-lost : SNTP communication is not
lost
nt-disk <Alarm::ntDiskSpace> current status of nt disk space is 90% full or less
Possible values are : than that
- ninty-perc-full : NT disk space is 90% This element is always shown.
full
- less-than-ninty-perc : NT disk space
usage less that 90%
connection-lost <Alarm::ShubLoc> current status of nt shub communication is lost or
Possible values are : intact
- lost : NT shub communication lost This element is always shown.
- not-lost : NT shub communication intact
Command Description
show the snap-shot equipment holder status
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm snap-shot eqpt-holder (index)
Command Parameters
Table 33.3-1 "Alarm Equipment Holder Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 33.3-2 "Alarm Equipment Holder Status Command" Display parameters
Specific Information
name Type Description
rack-power <Alarm::rackPower> current status of rack power alarm, indicating fuse
Possible values are : is broken or intact
- fuse-broken : the fuse is broken This element is always shown.
- fuse-ok : the fuse is intact
fan-unit1 <Alarm::fanUnit1> current status of fan-unit1
Possible values are : This element is always shown.
- failing : fan unit 1 is failing
- ok : fan unit 1 is ok
fan-unit2 <Alarm::fanUnit2> current status of fan-unit2
Possible values are : This element is always shown.
- failing : fan unit 2 is failing
- ok : fan unit 2 is ok
shelf-type-mismatch <Alarm::shelfTypeMismatch> current status specifies installed and planned shelf
Possible values are : types are different
- mismatch : installed and planned shelf This element is always shown.
types are different
- no-mismatch : installed and planned
shelf types are the same
ext-chain-instl <Alarm::extChainInstl> current alarm status of consistency problem
Possible values are : detected for installation of extension chain
- consistancy-problem : consistency This element is always shown.
Command Description
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm snap-shot plug-in-unit (index)
Command Parameters
Table 33.4-1 "Alarm Plug In Unit Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 33.4-2 "Alarm Plug In Unit Status Command" Display parameters
Specific Information
name Type Description
board-position <Eqpt::Rack> / <Eqpt::Shelf> / identify where the alarm has occurred.
<Eqpt::Slot> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
board-mismatch <Alarm::boardMismatch> alarm specifing the planned and plugged-in types
Possible values are : are different
- yes : planned and plugged-in types are This element is always shown.
different
- no : planned and plugged-in types are
same
sw-download <Alarm::swStatus> alarm specifing download of the software is
Possible values are : completed or not.
- waiting : not able to download all the This element is always shown.
applicable SW files
- completed : download completed
temperature <Alarm::tempStatus> alarm specifing board temperature is crossed the
Possible values are : threshold or not.
- above-thres : temperature threshold on This element is only shown in detail mode.
board exceeded
- below-thres : board temperature within
threshold
temp-shutoff <Alarm::tempShutoffStatus> alarm specifing board is swiched off because of
Command Description
This command displays the ATM alarm log status.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm snap-shot atm (index)
Command Parameters
Table 33.5-1 "Alarm ATM Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 33.5-2 "Alarm ATM Status Command" Display parameters
Specific Information
name Type Description
port <Eqpt::Rack> / <Eqpt::Shelf> / identify where the alarm has occurred.
<Eqpt::Slot> / <Eqpt::Port> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]/
<Eqpt::Port>= range: [1...48]
vpi-vci <Alarm::VpiVciValues> identify where the alarm has occurred.
This element is always shown.
cell-discard-up <Alarm::CellDiscardUpstream> specifies ATM cell is discarded or not in upstream
Possible values are : direction.
- discarded : ATM cell discarded in This element is always shown.
upstream direction
- no-discard : no ATM cell discarded in
upstream direction
cell-discard-down <Alarm::CellDiscardDownstream> specifies ATM cell is discarded or not in
Possible values are : downstream direction.
- discarded : ATM cell discarded in This element is always shown.
downstream direction
- no-discard : no ATM cell discarded in
downstream direction
mac-conflict <Alarm::MACconflict> specifies whether duplicate MAC address from the
Command Description
show the current ethernet interface alarm status
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm snap-shot ether-itf (index)
Command Parameters
Table 33.6-1 "Alarm Snap-shot Ethernet Interface Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 33.6-2 "Alarm Snap-shot Ethernet Interface Status Command" Display parameters
Specific Information
name Type Description
ether-ifindex <SignedInteger> identify where the alarm has occurred.
This element is always shown.
link-down <Alarm::EtherLinkStatus> specifies ethernet link status.
Possible values are : This element is always shown.
- yes : board switched off - excess
temperature
- no : board switched on
Command Description
show the snap-shot software management status.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm snap-shot sw-mgmt (index)
Command Parameters
Table 33.7-1 "Alarm Snap-shot Software Management Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 33.7-2 "Alarm Snap-shot Software Management Status Command" Display parameters
Specific Information
name Type Description
nt-position <Eqpt::Rack> / <Eqpt::Shelf> / identifies the physical position of the slot
<Eqpt::Slot> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
sw-rollback <Alarm::SwRollback> specifies implicit software rollback is performed or
Possible values are : not.
- yes : implicit software rollback This element is always shown.
performed
- no : no implicit software rollback
db-rollback <Alarm::DbRollback> specifies implicit database rollback is performed or
Possible values are : not.
- yes : implicit database rollback This element is always shown.
performed
- no : no implicit database rollback
Command Description
This command displays the snap-shot xDSL alarm status
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm snap-shot xdsl (index)
Command Parameters
Table 33.8-1 "Alarm xDSL Snap-shot Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 33.8-2 "Alarm xDSL Snap-shot Status Command" Display parameters
Specific Information
name Type Description
port <Eqpt::Rack> / <Eqpt::Shelf> / identifies the physical position of the port
<Eqpt::Slot> / <Eqpt::Port> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]/
<Eqpt::Port>= range: [1...48]
near-end-los <Alarm::NearEndLOS> specifies near end loss of signal occured or not.
Possible values are : This element is only shown in detail mode.
- occured : near end loss of signal occured
- not-occured : no near end loss of signal
near-end-lof <Alarm::NearEndLOF> specifies near end loss of frame occured or not.
Possible values are : This element is only shown in detail mode.
- occured : near end loss of frame occured
- not-occured : no near end loss of frame
near-end-lom <Alarm::NearEndLOM> specifies near end loss of margin occured or not.
Possible values are : This element is only shown in detail mode.
- occured : near end loss of margin
occured
- not-occured : no near end loss of margin
near-end-ese <Alarm::NearEndESE> specifies near end excessive server errors occured
Possible values are : or not.
Command Description
show the xDSL threshold cross alarm status
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm snap-shot tca-xdsl (index)
Command Parameters
Table 33.9-1 "Alarm TCA-xDSL Log Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 33.9-2 "Alarm TCA-xDSL Log Status Command" Display parameters
Specific Information
name Type Description
port <Eqpt::Rack> / <Eqpt::Shelf> / identifies where the alarm occurred
<Eqpt::Slot> / <Eqpt::Port> This element is always shown.
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]/
<Eqpt::Port>= range: [1...48]
errored-secs <Alarm::ErroredSeconds> number of errored seconds exceeded or below
Possible values are : threshold
- above-thres : number of errored seconds This element is always shown.
exceeded threshold
- below-thres : number of errored seconds
below threshold
es-in-a-day <Alarm::ErroredSecondsInAday> errored seconds in a day exceeded or below
Possible values are : threshold
- above-thres : number of errored seconds This element is always shown.
in a day, exceeded threshold
- below-thres : number of errored seconds
in a day, below threshold
severely-es <Alarm::SeverelyErroredSeconds> number of severely errored seconds exceeded or
Possible values are : below threshold
- above-thres : number of severely errored This element is only shown in detail mode.
Command Description
show the electrical to optical conversion alarm log status
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm snap-shot eo-conversion (index)
Command Parameters
Table 33.10-1 "Alarm Electrical to Optical Conversion for Snap-shot" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 33.10-2 "Alarm Electrical to Optical Conversion for Snap-shot" Display parameters
Specific Information
name Type Description
loss-of-signal <Alarm::EoConvLOS> specifies whether loss of signal detected or not in
Possible values are : the EO conversion module
- detected : loss of signal detected in the This element is always shown.
EO conversion module
- not-detected : no loss of signal detected
in the EO conversion module
transmission <Alarm::EoConvTx> specifies whether transmission fault is occurred or
Possible values are : not in the EO module
- faulty : transmission fault in the EO This element is always shown.
module
- ok : transmission OK
Command Description
This command displays the authentication related alarm status.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm snap-shot authentication (index)
Command Parameters
Table 33.11-1 "Alarm Authentication Alarms for Snap-shot Status Command" Resource
Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 33.11-2 "Alarm Authentication Alarms for Snap-shot Status Command" Display parameters
Specific Information
name Type Description
vrf-assignment <Alarm::VRFassignment> specifies whether VRF for a user session is
Possible values are : assigned or failed
- failed : failure to assign a VRF for a user This element is always shown.
session
- successful : assigned a VRF for a user
session
vlan-assignment <Alarm::VLANassignment> specifies whether a VLAN for a user session is
Possible values are : assigned or failed
- failed : failure to assign a VLAN for a This element is always shown.
user session
- successful : assigned a VLAN for a user
session
ip-addr-pool-assign <Alarm::IPaddrPoolAssign> specifies whether IP address pool for a user session
Possible values are : is assigned or failed
- failed : failure to assign IP address pool This element is always shown.
for a user session
- successful : assigned IP address pool for
Command Description
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm snap-shot ipox (index)
Command Parameters
Table 33.12-1 "Alarm IPoX Snap-shot Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 33.12-2 "Alarm IPoX Snap-shot Status Command" Display parameters
Specific Information
name Type Description
ip-addr-pool <Alarm::IPAddrPoolPreempt> specifies whether the ip addr pool on the DHCP
Possible values are : server and the local pool are preempted or not
- preempted : the ip addr pool on the This element is always shown.
DHCP server and the 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 common values related to delta log alarm.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm delta-log alarm-changes
Command Output
Table 34.1-2 "Alarm Generic Delta Alarm Log Status Command" Display parameters
Specific Information
name Type Description
all <Counter> total number of changes of all alarms since startup
and is independent of the alarm severity level.
This element is always shown.
indeterminate <Counter> total number of changes of all alarms with a
severity level indeterminate since startup.
This element is always shown.
warning <Counter> total number of changes of all alarms with a
severity level warning since startup.
This element is always shown.
minor <Counter> total number of changes of all alarms with a
severity level minor since startup.
This element is always shown.
major <Counter> total number of changes of all alarms with a
severity level major since startup.
This element is always shown.
critical <Counter> total number of changes of all alarms with a
severity level critical since startup.
This element is always shown.
Command Description
This command displays all the possible alarms at the agent. For each alarm, there is an entry. Each entry consists
of an index for the table, alarm id, alarm category, alarm On/Off thresholds and timebases and an alarm logging
mode. The severity, reporting and logging are manageable objects for the SNMP Manager
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm shub current table (index)
Command Parameters
Table 35.1-1 "SHub Alarm Current Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm type
Command Output
Table 35.1-2 "SHub Alarm Current Status Command" Display parameters
Common Information
name Type Description
changes <Counter> the number of changes that have occurred at the
current alarm table since startup.
This element is always shown.
entries <Gauge> the number of entries in the current alarm table.
This element is always shown.
Specific Information
name Type Description
type <Alarm::alarmType> specifies the type of the alarm
Possible values are : This element is always shown.
- equipment : equipment alarms
- eqpt-holder : equipment holder alarms
- plugin-unit : plugin unit alarms
- atm : ATM alarms
- custom : customizable alarms
- ether-itf : ethernet interface alarms
- software-mngt : software management
alarms
- xdsl : xDSL alarms
- xdsl-tca : xDSL threshold cross alarms
Command Description
This command shows the log generated for equipment related persistent-data (data that is stored on the system's
data disk, and that survives power failures and resets of the system), sntp-communication, nt-disk,
shub-communication. It also give their previous status.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm shub current equipment (index)
Command Parameters
Table 35.2-1 "SHub Alarm Current Equipment Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm type
Command Output
Table 35.2-2 "SHub Alarm Current Equipment Status Command" Display parameters
Specific Information
name Type Description
fan <Alarm::ShubFanState> specifies whether the fan-unit is failed or not.
Possible values are : This element is always shown.
- failed : fan unit falied
- working : fan unit OK
power-fan <Alarm::ShubPowerFanState> specifies whether the power fan unit is failed or
Possible values are : not.
- failed : power fan unit falied This element is always shown.
- working : power fan unit OK
db-restore <Alarm::ShubDBrestore> specifies whether the DB restore is successful or
Possible values are : not.
- failed : DB restore falied This element is always shown.
- successful : DB restore successful
emergency-reboot <Alarm::ShubEmergencyRebbot> status of shub reboot from emergency boot package
Possible values are : This element is always shown.
- occured : shub has rebooted from
emergency boot package
Command Description
This command displays whether the ethernet interface link status has gone down or not. It also shows the previous
status, by which Operator can know that the link has gone down previously.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm shub current ethernet (index)
Command Parameters
Table 35.3-1 "SHub Alarm Current Ethernet Interface Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 35.3-2 "SHub Alarm Current Ethernet Interface Status Command" Display parameters
Specific Information
name Type Description
port-number <Alarm::ShubPortNumber> port number of the shub
range: [1...24] This element is always shown.
link-down <Alarm::ShubLinkDown> specifies whether the shub link is down or not.
Possible values are : This element is always shown.
- yes : fan unit falied
- no : fan unit OK
mac-conflict <Alarm::ShubMACconflict> specifies whether there is a duplicate MAC address
Possible values are : from the ethernet port of LAN switch.
- yes : duplicate MAC address from This element is always shown.
ethernet port of LAN switch
- no : no duplciate MAC address
Only Show Details: vlan id - applicable only in case of mac conflict
name Type Description
vlan-id <SignedInteger> identify where the alarm occurred
This element is only shown in detail mode.
Command Description
This command displays the snap-shot table for SHub.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm shub snap-shot table (index)
Command Parameters
Table 35.4-1 "SHub Alarm Snap-shot Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 35.4-2 "SHub Alarm Snap-shot Status Command" Display parameters
Common Information
name Type Description
timeout-period <TimeTicks> specifies the time out of the snapshot table
This element is always shown.
entries <Gauge> specifies nbr of entries inthe snapshot table, when
table status is in-use.
This element is always shown.
owner-id <Alarm::alarmSnapShotOwner> the actual owner of the snap-shot
This element is always shown.
Specific Information
name Type Description
type <Alarm::ShubAlarmType> specifies the type of the alarm
Possible values are : This element is always shown.
- shub : alarms related with an equip
- eth-shub : alarms related with the
ethernet interface
status <UnsignedInteger> defines the status of alarms in an alarm type at the
time the snapshot was taken.
This element is always shown.
last-updated-on <Sys::Time> gives the time information in seconds elapsed since
the 1st January 1970, when the entry was
updated/added.
This element is always shown.
Command Description
This show the log generated for the Equipment like persistent-data(data that is stored on the system's data disk, and
that survives power failures and resets of the system), sntp-communication, nt-disk, communication. It also give
their previous status.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm shub snap-shot shub (index)
Command Parameters
Table 35.5-1 "SHub Alarm Equipment Snap-shot Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 35.5-2 "SHub Alarm Equipment Snap-shot Status Command" Display parameters
Specific Information
name Type Description
fan <Alarm::ShubFanState> specifies whether the fan-unit is failed or not.
Possible values are : This element is always shown.
- failed : fan unit falied
- working : fan unit OK
power-fan <Alarm::ShubPowerFanState> specifies whether the power fan unit is failed or
Possible values are : not.
- failed : power fan unit falied This element is always shown.
- working : power fan unit OK
db-restore <Alarm::ShubDBrestore> specifies whether the DB restore is successful or
Possible values are : not.
- failed : DB restore falied This element is always shown.
- successful : DB restore successful
emergency-reboot <Alarm::ShubEmergencyRebbot> status of shub reboot from emergency boot package
Possible values are : This element is always shown.
- occured : shub has rebooted from
emergency boot package
Command Description
This command displays whether the ethernet interface link status has gone down or not. It also shows the previous
status, by which Operator can know that the link has gone down previously.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm shub snap-shot eth-shub (index)
Command Parameters
Table 35.6-1 "SHub Alarm Snap-shot Ethernet Interface Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 35.6-2 "SHub Alarm Snap-shot Ethernet Interface Status Command" Display parameters
Specific Information
name Type Description
port-number <Alarm::ShubPortNumber> port number of the shub
range: [1...24] This element is always shown.
link-down <Alarm::ShubLinkDown> specifies whether the shub link is down or not.
Possible values are : This element is always shown.
- yes : fan unit falied
- no : fan unit OK
mac-conflict <Alarm::ShubMACconflict> specifies whether there is a duplicate MAC address
Possible values are : from the ethernet port of LAN switch.
- yes : duplicate MAC address from This element is always shown.
ethernet port of LAN switch
- no : no duplciate MAC address
Only Show Details: vlan id - applicable only in case of mac conflict
name Type Description
vlan-id <SignedInteger> specifies where the alarm has occurred.
This element is only shown in detail mode.
Command Description
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm shub snap-shot rip (index)
Command Parameters
Table 35.7-1 "SHub Alarm RIP Snap-shot Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 35.7-2 "SHub Alarm RIP Snap-shot Status Command" Display parameters
Specific Information
name Type Description
config-err <Alarm::ShubConfigErr> RIP interface configuration error
Possible values are : This element is always shown.
- error : configuration error occured
- no-error : configuration error not occured
auth-fail <Alarm::ShubAuthFail> RIP interface authentication failure
Possible values are : This element is always shown.
- failure : authentication failed
- no-failure : authentication not failed
rcv-bad-pkt <Alarm::ShubRcvPkt> bad packet received on RIP interface
Possible values are : This element is always shown.
- bad-pkt-rcv : bad packets received
- no-bad-pkt-rcv : no bad packets received
Only Show Details: interface index describing the interface
name Type Description
if-index <SignedInteger> This element is only shown in detail mode.
Command Description
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm shub snap-shot ospf (index)
Command Parameters
Table 35.8-1 "SHub Alarm OSPF Snap-shot Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Alarm::genAlarmIndex> alarm snap shot table index
Command Output
Table 35.8-2 "SHub Alarm OSPF Snap-shot Status Command" Display parameters
Specific Information
name Type Description
config-err <Alarm::ShubConfigErr> interface configuration error
Possible values are : This element is always shown.
- error : configuration error occured
- no-error : configuration error not occured
auth-fail <Alarm::ShubAuthFail> interface authentication failure
Possible values are : This element is always shown.
- failure : authentication failed
- no-failure : authentication not failed
rcv-bad-pkt <Alarm::ShubRcvPkt> bad packet received on the interface
Possible values are : This element is always shown.
- bad-pkt-rcv : bad packets received
- no-bad-pkt-rcv : no bad packets received
lsdb-overflow-90 <Alarm::ShubLSDB90> specifies whether the external LSA database
Possible values are : reached 90% of the limit
- approaching-90% : external LSA This element is always shown.
database reached 90% of the limit
- not-approaching : external LSA database
not reached 90% of the limit
lsdb-overflowed <Alarm::ShubLSDBOverFlow> specifies whether the external LSA database count
Possible values are : reached overflow limit
Command Description
Alarm changes give a summary report of number of alarms occured.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm shub nbr-changed-alarms
Command Output
Table 35.9-2 "SHub Alarm Delta-Log Changes Status Command" Display parameters
Specific Information
name Type Description
all <Counter> total number of changes of all alarms since startup.
This element is always shown.
indeterminate <Counter> the total number of changes of all alarms with
severity level indeterminate since startup.
This element is always shown.
warning <Counter> the total number of changes of all alarms with
severity level warning since startup.
This element is always shown.
minor <Counter> the total number of changes of all alarms with
severity level minor since startup.
This element is always shown.
major <Counter> the total number of changes of all alarms with
severity level major since startup.
This element is always shown.
critical <Counter> the total number of changes of all alarms with
severity level critical since startup.
This element is always shown.
Command Description
This command displays the alarm entries.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm shub entry (alarm-id)
Command Parameters
Table 35.10-1 "SHub Alarm Entries Status Command" Resource Parameters
Resource Identifier Type Description
(alarm-id) <Alarm::ShubAlarmIndex> alarm type
Possible values are :
- 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 doen
status
- mac-conflict : MAC conflict
Command Output
Table 35.10-2 "SHub Alarm Entries Status Command" Display parameters
Specific Information
name Type Description
category <Alarm::category> defines the category of an alarm.
Possible values are : This element is always shown.
- communications : communications
related alarms
- qos : QoS related alarms
- processing-error : processing failure
related alarms
- equipment : equipment related alarms
- environmental : environmental related
alarms
severity <Alarm::alarmSeverity> defined to assign a severity level to an alarm.
Command Description
This command displays the alarm entries.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show alarm entry (alarm-id)
Command Parameters
Table 36.1-1 "Alarm Entries Status Command" Resource Parameters
Resource Identifier Type Description
(alarm-id) <Alarm::alarmIndex> alarm type
Possible values are :
- eo-conv-loss : loss of signal in eo
conversion module
- eo-conv-tx : transmission fault in eo
conversion module
- xtca-ne-es : xdsl near end TCA alarm -
errored seconds in 15 min
- xtca-ne-ses : xdsl near end TCA alarm -
severely errored seconds in 15 min
- xtca-ne-uas : xdsl near end TCA alarm -
unavailable seconds in 15 min
- xtca-ne-day-es : xdsl near end TCA
alarm - errored seconds in 1 day
- xtca-ne-day-ses : xdsl near end TCA
alarm - severely errored seconds in 1 day
- xtca-ne-day-uas : xdsl near end TCA
alarm - unavailable seconds in 1 day
- xtca-fe-es : xdsl far end TCA alarm -
errored seconds in 15 min
- xtca-fe-ses : xdsl far end TCA alarm -
severely errored secs in 15 min
- xtca-fe-uas : xdsl far end TCA alarm -
unavailable seconds in 15 min
- xtca-fe-day-es : xdsl far end TCA alarm -
errored seconds in 1 day
- xtca-fe-day-ses : xdsl far end TCA alarm
- severely errored secs in 1 day
- xtca-fe-day-uas : xdsl far end TCA alarm
- unavailable seconds in 1 day
Command Output
Table 36.1-2 "Alarm Entries Status Command" Display parameters
Specific Information
name Type Description
category <Alarm::category> category of an alarm
Possible values are : This element is always shown.
- communications : communications
related alarms
- qos : QoS related alarms
- processing-error : processing failure
related alarms
- equipment : equipment related alarms
- environmental : environmental related
alarms
severity <Alarm::alarmSeverity> severity of the alarm, may be indeterminate,
Possible values are : warning, minor, major and critical.
- indeterminate : not a definite known This element is always shown.
Command Description
Displays the ATM interface configuration table.
User Level
The command can be accessed by operators with atm priviliges.
Command Syntax
The command has the following syntax:
> show atm interface (port)
Command Parameters
Table 37.1-1 "ATM Interface Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 37.1-2 "ATM Interface Status Command" Display parameters
Specific Information
name Type Description
type <Atm::asamAtmItfType> type of ATM interface.
Possible values are : This element is always shown.
- not-specified : not specified
- network-termination : network
termination
- access-to-access : access to access
interface
- user-to-access : user to access interface
- internal-server : internal server interface
- external-server : external server interface
number-of-pvcs <Atm::CrossConnectedPVccs> specifies the number of vcttp connections on this
range: [0...65535] ATM interface (only PVC).
This element is always shown.
Command Description
Displays the TC adaptor protocol performance status.
User Level
The command can be accessed by operators with atm priviliges.
Command Syntax
The command has the following syntax:
> show atm tc-int (port)
Command Parameters
Table 37.2-1 "TC Adaptor Protocol Performance Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / the identification of the ATM interface
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 37.2-2 "TC Adaptor Protocol Performance Status Command" Display parameters
Specific Information
name Type Description
valid-15-min-intervals <SignedInteger> the number of previous intervals (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.
valid-1-day-intervals <SignedInteger> The number of previous intervals (maximum 2) for
which valid data has been stored. The value of this
object will be 2 unless the device was brought
online within the last nx24 hours, in which case the
value will be the number of complete 24 hours
intervals the device has been online
This element is always shown.
Command Description
Allows the operator to view TC adaptor protocol monitoring current data parameters.
User Level
The command can be accessed by operators with atm priviliges.
Command Syntax
The command has the following syntax:
> show atm tc-current-int fifteen-min (port)
Command Parameters
Table 37.3-1 "TC Adaptor Protocol Monitoring Status For Near End" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 37.3-2 "TC Adaptor Protocol Monitoring Status For Near End" Display parameters
Specific Information
name Type Description
ocds15min-far-end <Counter> number of out of cell delinations anomalies which
occurred for incoming cells on the far end ATM
interface connected to this ATM interface since the
start of this current 15 minute interval.
This element is always shown.
dhecvs15min-far-end <Counter> number of ATM cells discarded on the far end
ATM interface connnected to this ATM interface,
due to a HEC error, since the start of this current 15
minute interval.
This element is always shown.
ocds15min-near-end <Counter> number of out of cell delinations anomalies which
occurred for incoming cells on an ATM interface
since the start of this current 15 minute interval.
This element is always shown.
dhecvs15min-near-end <Counter> number of ATM cells discarded on this interface,
due to a HEC error, since the start of this current 15
minute interval.
Command Description
Allows the operator to view TC adaptor protocol monitoring current data parameters.
User Level
The command can be accessed by operators with atm priviliges.
Command Syntax
The command has the following syntax:
> show atm tc-current-int one-day (port)
Command Parameters
Table 37.4-1 "TC Adaptor Protocol Monitoring Status For Far End" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 37.4-2 "TC Adaptor Protocol Monitoring Status For Far End" Display parameters
Specific Information
name Type Description
ocds1day-far-end <Counter> number of Out of Cell Delinations anomalies which
occurred for incoming cells on the far end ATM
interface connected to this ATM interface since the
start of this current 24 hour interval.
This element is always shown.
dhecvs1day-far-end <Counter> number of ATM cells discarded on the far end
ATM interface connnected to this ATM interface,
due to a HEC error, since the start of this current 24
hour interval.
This element is always shown.
ocds1day-near-end <Counter> number of out of cell delinations anomalies which
occurred for incoming cells on an ATM interface
since the start of this current 24 hour interval.
This element is always shown.
dhecvs1day-near-end <Counter> number of ATM cells discarded on this interface,
due to a HEC error, since the start of this current 24
hour interval.
Command Description
Allows the operator to view TC adaptor protocol monitoring 1day interval data parameters.
User Level
The command can be accessed by operators with atm priviliges.
Command Syntax
The command has the following syntax:
> show atm tc-1day-int (port) intvl-number <Atm::AtmItvlNo1day>
Command Parameters
Table 37.5-1 "TC Adaptor Protocol Monitoring 1day Interval Status For Data" Resource
Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port>
intvl-number <Atm::AtmItvlNo1day> interval for which the set of statistics is available
range: [1...2]
Command Output
Table 37.5-2 "TC Adaptor Protocol Monitoring 1day Interval Status For Data" Display parameters
Specific Information
name Type Description
ocds-near-end <Counter> number of out of cell delinations anomalies which
occurred for incoming cells on an ATM interface in
a particular 24 hour interval.
This element is always shown.
dhecvs-near-end <Counter> number of ATM cells discarded on this interface,
due to a HEC error, in a particular 24 hour interval.
This element is always shown.
ocds-far-end <Counter> number of out of cell delinations anomalies which
occurred for incoming cells on the far end ATM
interface connected to this ATM interface in a
particular 24 hour interval.
This element is always shown.
dhecvs-far-end <Counter> number of ATM cells discarded on the far end
ATM interface connnected to this ATM interface,
Command Description
Allows the operator to view TC adaptor protocol monitoring 15min interval data parameters.
User Level
The command can be accessed by operators with atm priviliges.
Command Syntax
The command has the following syntax:
> show atm tc-15min-int (port) intvl-number <Atm::AtmItvlNumber>
Command Parameters
Table 37.6-1 "TC Adaptor Protocol Monitoring 15min Interval Status For Data" Resource
Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port>
intvl-number <Atm::AtmItvlNumber> interval for which statistics is available
range: [1...192]
Command Output
Table 37.6-2 "TC Adaptor Protocol Monitoring 15min Interval Status For Data" Display
parameters
Specific Information
name Type Description
ocds-near-end <Counter> number of out of cell delinations anomalies which
occurred for incoming cells on an ATM interface.
This element is always shown.
dhecvs-near-end <Counter> number of ATM cells discarded on this interface,
due to a HEC error
This element is always shown.
ocds-far-end <Counter> number of out of cell delinations anomalies which
occurred for incoming cells on the far end ATM
interface connected to this ATM interface
This element is always shown.
dhecvs-far-end <Counter> number of ATM cells discarded on the far end
ATM interface connnected to this ATM interface,
due to a HEC error
Command Description
Allows the operator to know the status of the Permanent virtual circuit.
User Level
The command can be accessed by operators with atm priviliges.
Command Syntax
The command has the following syntax:
> show atm pvc (port-index)
Command Parameters
Table 37.7-1 "PVC Status Command" Resource Parameters
Resource Identifier Type Description
(port-index) <Eqpt::Rack> / <Eqpt::Shelf> / the atm static Interface with vpi and vci
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 37.7-2 "PVC Status Command" Display parameters
Specific Information
name Type Description
admin-status <Atm::adminStatus> specifies the desired administrative state of the
Possible values are : VCL.
- admin-up : enable traffic flow This element is always shown.
- admin-down : disable traffic flow
opertional-status <Atm::atmVclOperStatus> indicates the current operational status of the VCL.
Possible values are : This element is always shown.
- up : traffic flow is enabled in the virtual
link
- down : traffic flow is disabled in the
virtual link
- unknown : state is unknown
last-change <TimeTicks> time the VCL entered its current operational state.
unit: msec This element is always shown.
Command Description
This command shows 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 will indicate 'dynamic'.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show bridge port (port)
Command Parameters
Table 38.1-1 "Bridge Port Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 38.1-2 "Bridge Port Status Command" Display parameters
Specific Information
name Type Description
bridge-port <Vlan::BridgePort> the port identifier assigned by the system to this
range: [1...3104] terminated VCL. A port identifier identifies
uniquely a port of the VLAN-Bridge within the
system.
This element is always shown.
pvid <Vlan::UVlanIndex> | stacked : the dynamic or static (if no dynamic) default
<Vlan::SVlanIndex> : VLAN assigned to a port
<Vlan::CVlanIndex> This element is always shown.
default-priority <Vlan::Priority> port dynamic or static (if no dynamic) default
range: [0...7] priority
This element is always shown.
qos-profile none | name : QOS profile, dynamically or statically (if no
<Vlan::IgnoredQosProfileName> dynamic) assigned to a port
This element is always shown.
status <Vlan::DataStatus> nature of the data shown. The value true indicates
Possible values are : that any or all of the displayed parameters is
- static : data configured by operator dynamic.
Command Description
This command shows the mapping between a bridge port and its ATM interface.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show bridge port-to-atm-pvc (bridge-port)
Command Parameters
Table 38.2-1 "Bridge Port to ATM PVC mapping Status Command" Resource Parameters
Resource Identifier Type Description
(bridge-port) <Vlan::BridgePort> bridge port
range: [1...3104]
Command Output
Table 38.2-2 "Bridge Port to ATM PVC mapping Status Command" Display parameters
Specific Information
name Type Description
port <Eqpt::Rack> / <Eqpt::Shelf> / the atm static Interface with vpi and vci
<Eqpt::LtSlot> / <Eqpt::Port> : This element is always shown.
<Atm::vpi> : <Atm::vci>
Command Description
This command shows global information regarding the bridge on the Service Hub.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show bridge shub-info
Command Output
Table 38.3-2 "SHub Bridge Status Command" Display parameters
Only Show Details: bridge parameters
name Type Description
mac-address <Vlan::MacAddr> the MAC address used by this bridge when it must
length: 6 be referred to in a unique fashion
This element is always shown.
learnt-entry-discards <UnsignedInteger> the total number of Filtering 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 shows port related parameters for a bridge port on the Service Hub.
When detailled 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show bridge network-port (port)
Command Parameters
Table 38.4-1 "SHub Bridge Port Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Shub::NetworkPort> port number
range: [1...7]
Command Output
Table 38.4-2 "SHub Bridge Port Status Command" Display parameters
Common Information
name Type Description
mac-address <Vlan::MacAddr> the MAC address used by this bridge when it must
length: 6 be referred to in a unique fashion
This element is always shown.
learned-entry-discards <UnsignedInteger> the total number of Filtering 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 <Shub::PortOperStatus> the operational status of the port. This status is only
Possible values are : valid if the administrative status of the
- down : down corresponding interface is up.
- up : up This element is always shown.
max-frame-info <SignedInteger> the maximum size of the INFO (non-MAC) field
Command Description
This command shows information common to all VLANs.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan global
Command Output
Table 39.1-2 "Global VLAN Status Command" Display parameters
Common Information
name Type Description
configured-vlans <UnsignedInteger> current number of vlans that are configured
This element is always shown.
management <Vlan::MgntVlanMode> specifies how the node is managed
Possible values are : This element is always shown.
- inband : inband
- outband : outband
max-rb-vlan <UnsignedInteger> maximum number of residential bridge vlans that
are supported
This element is always shown.
max-layer2-term-vlan <UnsignedInteger> maximum number of layer2 terminated vlans that
are supported
This element is always shown.
Only Show Details: vlan parameters
name Type Description
configured-vlans <UnsignedInteger> current number of vlans that are configured
This element is always shown.
management <Vlan::MgntVlanMode> specifies how the node is managed
Possible values are : This element is always shown.
- inband : inband
- outband : outband
max-rb-vlan <UnsignedInteger> maximum number of residential bridge vlans that
are supported
This element is always shown.
max-layer2-term-vlan <UnsignedInteger> maximum number of layer2 terminated vlans that
are supported
This element is always shown.
Command Description
This command shows all parameters for a particular VLAN of the type Residential Bridge VLAN.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan residential-bridge (vlan-id) bridge-port <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::vpi> : <Atm::vci>
Command Parameters
Table 39.2-1 "Residential Bridge VLAN Status Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
bridge-port <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 39.2-2 "Residential Bridge VLAN Status Command" Display parameters
Specific Information
name Type Description
qos-profile none | name : QOS profile, dynamically or statically (if no
<Vlan::IgnoredQosProfileName> dynamic) assigned to a port
This element is always shown.
status <Vlan::DataStatus> nature of the data shown. The value true indicates
Possible values are : that any or all of the displayed parameters is
- static : data configured by operator dynamic.
- dynamic : dynamic data This element is only shown in detail mode.
Command Description
This command shows all parameters for a particular VLAN of the type Cross-connect VLAN.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan cross-connect (vlan-id)
Command Parameters
Table 39.3-1 "Cross-connect VLAN Status Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
Command Output
Table 39.3-2 "Cross-connect VLAN Status Command" Display parameters
Specific Information
name Type Description
bridge-port <Vlan::Port> bridge port
This element is always shown.
port <Eqpt::Rack> / <Eqpt::Shelf> / the atm static Interface with vpi and vci
<Eqpt::LtSlot> / <Eqpt::Port> : This element is always shown.
<Atm::vpi> : <Atm::vci>
fdb-id <UnsignedInteger> identity of the filtering database
This element is always shown.
filter-entries <UnsignedInteger> number of entries in the filtering database
This element is always shown.
qos-profile none | name : QOS profile, dynamically or statically (if no
<Vlan::IgnoredQosProfileName> dynamic) assigned to a port
This element is always shown.
status <Vlan::DataStatus> nature of the data shown. The value true indicates
Possible values are : that any or all of the displayed parameters is
- static : data configured by operator dynamic.
- dynamic : dynamic data This element is only shown in detail mode.
Command Description
This command shows the Stacked Vlans configured in the system and their status.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan stacked-vlan (s-vlanid) vlan-id <Vlan::UVlanIndex> | stacked :
<Vlan::SVlanIndex> : <Vlan::CVlanIndex>
Command Parameters
Table 39.4-1 "Stacked VLAN Status Command" Resource Parameters
Resource Identifier Type Description
(s-vlanid) <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
vlan-id <Vlan::UVlanIndex> | stacked : customer vlan
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
Command Description
This command shows the Stacked Vlans configured in the system and their status.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan stacked-qos-vlan (s-vlanid) vlan-id <Vlan::UVlanIndex> | stacked :
<Vlan::SVlanIndex> : <Vlan::CVlanIndex>
Command Parameters
Table 39.5-1 "Stacked QoS VLAN Status Command" Resource Parameters
Resource Identifier Type Description
(s-vlanid) <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
vlan-id <Vlan::UVlanIndex> | stacked : customer vlan
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
Command Description
This command shows all parameters for a particular VLAN of the type Layer-2 terminated VLAN.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan layer2-terminated (vlanid)
Command Parameters
Table 39.6-1 "Layer-2 terminated VLAN Status Command" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
Command Output
Table 39.6-2 "Layer-2 terminated VLAN Status Command" Display parameters
Specific Information
name Type Description
fdb-id <UnsignedInteger> identity of the filtering database
This element is always shown.
filter-entries <UnsignedInteger> number of entries in the filtering database
This element is always shown.
network-ifindex <SignedInteger> interface index of the IpoE interface related to this
VLAN, at the network side
This element is always shown.
Command Description
This command shows the VLAN identity that corresponds to a given VLAN name.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan name (name)
Command Parameters
Table 39.7-1 "VLAN Name mapping Status Command" Resource Parameters
Resource Identifier Type Description
(name) <Vlan::AdminString> name used to identify the vlan
length: x<32
Command Output
Table 39.7-2 "VLAN Name mapping Status Command" Display parameters
Specific Information
name Type Description
id <Vlan::UVlanIndex> | stacked : the vlan identity
<Vlan::SVlanIndex> : This element is always shown.
<Vlan::CVlanIndex>
Command Description
This command shows, 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, i.e. a filtering
entry can be configured or dynamically learned.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan fdb (vlanid) mac <Vlan::MacAddr> port <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::vpi> : <Atm::vci>
Command Parameters
Table 39.8-1 "VLAN Filtering Database Status Command" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::VlanIndexOrZero> vlan id
range: [0...4092]
mac <Vlan::MacAddr> mac address
length: 6
port <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 39.8-2 "VLAN Filtering Database Status Command" Display parameters
Specific Information
name Type Description
bridge-port <Vlan::BridgePort> the port identifier assigned by the system to this
range: [1...3104] terminated VCL. A port identifier identifies
uniquely a port of the VLAN-Bridge within the
system.
This element is always shown.
status <Vlan::FdbEntryStatus> the origin of the entry, unless invalid. Invalid
Possible values are : indicates the entry is in progress of being deleted.
- other : entry does not determine the This element is always shown.
forwarding of frames
- invalid : entry is being removed
Command Description
This command shows all entries of the Filtering Database for a particular bridge port. 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, i.e. a filtering
entry can be configured or dynamically learned.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan bridge-port-fdb (port)
Command Parameters
Table 39.9-1 "Bridge Port Filtering Database Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 39.9-2 "Bridge Port Filtering Database Status Command" Display parameters
Specific Information
name Type Description
vlan-id <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> : This element is always shown.
<Vlan::CVlanIndex>
mac <Vlan::MacAddr> mac address
length: 6 This element is always shown.
status <Vlan::FdbEntryStatus> the origin of the entry, unless invalid
Possible values are : This element is always shown.
- 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
Command Description
This command shows all VLANs associated to a given port.
Such assocation is either static while it has been configured by the operator or the association has been established
dynamically as a result of port authentication via Radius protocol.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan port-vlan-map (port)
Command Parameters
Table 39.10-1 "Port VLAN association Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 39.10-2 "Port VLAN association Status Command" Display parameters
Specific Information
name Type Description
vlanid <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> : This element is always shown.
<Vlan::CVlanIndex>
association <Vlan::DataStatus> the way the association was established
Possible values are : This element is always shown.
- static : data configured by operator
- dynamic : dynamic data
Command Description
This command shows 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan priority-regen (profile-id)
Command Parameters
Table 39.11-1 "VLAN Priority Regeneration Profile Status Command" Resource Parameters
Resource Identifier Type Description
(profile-id) <Vlan::PrioRegenProfile> profile id
Possible values are :
- 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
- l2-vpn-4 : L2 VPN with 4 traffic classes
Command Output
Table 39.11-2 "VLAN Priority Regeneration Profile Status Command" Display parameters
Specific Information
Command Description
This command is usefull when a Duplicate MAC Alarm has occured. 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, i.e.within the same Filtering Database. The information displayed indicates the port where the MAC
address is assigned, 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan dup-mac-alarm (dup-port) dup-vlan-id <Vlan::UVlanIndex> | stacked :
<Vlan::SVlanIndex> : <Vlan::CVlanIndex> dup-mac <Vlan::MacAddr>
Command Parameters
Table 39.12-1 "Duplicate Mac Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(dup-port) <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
dup-vlan-id <Vlan::UVlanIndex> | stacked : duplicate vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
dup-mac <Vlan::MacAddr> duplicate mac address
length: 6
Command Output
Table 39.12-2 "Duplicate Mac Alarm Status Command" Display parameters
Specific Information
name Type Description
port <Eqpt::Rack> / <Eqpt::Shelf> / the atm static Interface with vpi and vci
<Eqpt::LtSlot> / <Eqpt::Port> : This element is always shown.
<Atm::vpi> : <Atm::vci>
Command Description
This commands shows all kind of events that ocurred on a given port. These events relate to error cases.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan port-event (port)
Command Parameters
Table 39.13-1 "Port Event Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 39.13-2 "Port Event Status Command" Display parameters
Specific Information
name Type Description
bridge-port <Vlan::BridgePort> bridge port
range: [1...3104] This element is always shown.
event-time <Vlan::StatsTime> the time in seconds when the event ocurred
unit: sec This element is always shown.
aal5-fcs-error <Vlan::Aal5FcsError> error of the aal5 frame or fcs error
short name:aal5-fcs Possible values are : This element is always shown.
- aal5-fcs : aal5 or fcs error
- no-aal5-fcs : no aal5 or fcs error
llc-error <Vlan::LlcError> incorrect llc format
short name:llc Possible values are : This element is always shown.
- llc : incorrect llc
- no-llc : correct llc
no-mac-learn <Vlan::MacNoLearnError> new MAC address could not be learned, upstream
short name:no-mac Possible values are : pkt is discarded
- mac-learn-error : mac learn error This element is always shown.
- no-mac-learn-error : no mac learn error
dup-mac <Vlan::MacDuplicateError> failure of MAC address learning while MAC
Possible values are : address already exists on another port within the
- mac-dup-error : mac duplicate error same VLAN
Command Description
This commands shows 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan port-curr-15min-stats (port)
Command Parameters
Table 39.14-1 "Port Statistics for Current Quarter" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 39.14-2 "Port Statistics for Current Quarter" Display parameters
Specific Information
name Type Description
elapsed-time <Vlan::StatsTime> elapsed time in this interval, i.e. for the current 15
unit: sec minutes interval; expressed in seconds
This element is always shown.
measure-time <Vlan::StatsTime> actually measured time in this interval; expressed in
unit: sec seconds
This element is always shown.
Only Show Details: up stream counters
name Type Description
forward-frame <Vlan::OctetCounter> number of frames forwarded in upstream direction
on a bridge port, for the specified interval
This element is always shown.
forward-byte <Vlan::OctetCounter> number of bytes forwarded in upstream direction
on a bridge port, for the specified interval
This element is always shown.
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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan port-curr-day-stats (port)
Command Parameters
Table 39.15-1 "Port Statistics for Current Day" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 39.15-2 "Port Statistics for Current Day" Display parameters
Specific Information
name Type Description
elapsed-time <Vlan::StatsTime> elapsed time in this interval, i.e. for the current day
unit: sec interval; expressed in seconds
This element is always shown.
measure-time <Vlan::StatsTime> actually measured time in this interval; expressed in
unit: sec seconds
This element is always shown.
Only Show Details: up stream counters
name Type Description
forward-frame <Vlan::OctetCounter> number of frames forwarded in upstream direction
on a bridge port, for the specified interval
This element is always shown.
forward-byte <Vlan::OctetCounter> number of bytes forwarded in upstream direction
on a bridge port, for the specified interval
This element is always shown.
Command Description
This command shows 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 though completed quarter interval, from there
onwards 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan port-15min-stats (port) interval-number <SignedInteger>
Command Parameters
Table 39.16-1 "Port Statistics for Previous Quarter Intervals" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
interval-number <SignedInteger> interval number, where 1 is the most recent
completed interval
Command Output
Table 39.16-2 "Port Statistics for Previous Quarter Intervals" Display parameters
Specific Information
name Type Description
measure-time <Vlan::StatsTime> actually measured time in this interval; expressed in
unit: sec seconds
This element is always shown.
Only Show Details: up stream counters
name Type Description
forward-frame <Vlan::OctetCounter> number of frames forwarded in upstream direction
on a bridge port, for the specified interval
This element is always shown.
forward-byte <Vlan::OctetCounter> number of bytes forwarded in upstream direction
on a bridge port, for the specified interval
Command Description
This command shows 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 though completed day interval, from there
onwards 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan port-prev-day-stats (port) interval-number <SignedInteger>
Command Parameters
Table 39.17-1 "Port Statistics for Previous Day Intervals" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
interval-number <SignedInteger> interval number
Command Output
Table 39.17-2 "Port Statistics for Previous Day Intervals" Display parameters
Specific Information
name Type Description
measure-time <Vlan::StatsTime> actually measured time in this interval; expressed in
unit: sec seconds
This element is always shown.
Only Show Details: up stream counters
name Type Description
forward-frame <Vlan::OctetCounter> number of frames forwarded in upstream direction
on a bridge port, for the specified interval
This element is always shown.
forward-byte <Vlan::OctetCounter> number of bytes forwarded in upstream direction
on a bridge port, for the specified interval
This element is always shown.
Command Description
This commands shows 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan current-15min-stats (vlanid) port <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::vpi> : <Atm::vci>
Command Parameters
Table 39.18-1 "VLAN Port Statistics for Current Quarter" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
port <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 39.18-2 "VLAN Port Statistics for Current Quarter" Display parameters
Specific Information
name Type Description
elapsed-time <Vlan::StatsTime> elapsed time in this interval, i.e. for the current 15
unit: sec minutes interval; expressed in seconds
This element is always shown.
measure-time <Vlan::StatsTime> actually measured time in this interval; expressed in
unit: sec seconds
This element is always shown.
Only Show Details: up stream counters
name Type Description
forward-frame <Vlan::OctetCounter> number of frames forwarded in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.
forward-byte <Vlan::OctetCounter> number of frames forwarded in upstream direction
Command Description
This commands shows 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan current-day-stats (vlanid) port <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::vpi> : <Atm::vci>
Command Parameters
Table 39.19-1 "VLAN Port Statistics for Current Day" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
port <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 39.19-2 "VLAN Port Statistics for Current Day" Display parameters
Specific Information
name Type Description
elapsed-time <Vlan::StatsTime> elapsed time in this interval, i.e. for the current 15
unit: sec minutes interval; expressed in seconds
This element is always shown.
measure-time <Vlan::StatsTime> actually measured time in this interval; expressed in
unit: sec seconds
This element is always shown.
Only Show Details: up stream counters
name Type Description
forward-frame <Vlan::OctetCounter> number of frames forwarded in upstream direction
per VLAN on a bridge port, for the specified
interval
Command Description
This command shows 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 though completed quarter interval, from there
onwards 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan previous-15min-stats (vlanid) port <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::vpi> : <Atm::vci> interval-number
<SignedInteger>
Command Parameters
Table 39.20-1 "VLAN Port Statistics for Previous Quarter Intervals" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
port <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
interval-number <SignedInteger> interval number
Command Output
Table 39.20-2 "VLAN Port Statistics for Previous Quarter Intervals" Display parameters
Specific Information
name Type Description
measure-time <Vlan::StatsTime> actually measured time in this interval; expressed in
unit: sec seconds
This element is always shown.
Command Description
This command shows 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 though completed day interval, from there
onwards 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan vlan-day-stats (vlanid) port <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot>
/ <Eqpt::Port> : <Atm::vpi> : <Atm::vci> interval-number <SignedInteger>
Command Parameters
Table 39.21-1 "VLAN Port Statistics for Previous Day Intervals" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
port <Eqpt::Rack> / <Eqpt::Shelf> / identity of the PVC
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
interval-number <SignedInteger> interval number
Command Output
Table 39.21-2 "VLAN Port Statistics for Previous Day Intervals" Display parameters
Specific Information
name Type Description
measure-time <Vlan::StatsTime> actually measured time in this interval; expressed in
unit: sec seconds
This element is always shown.
Only Show Details: up stream counters
Command Description
This command shows all VLANs associated to a given port on the Service Hub. 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan shub-port-vlan-map (port) vlan-id <Vlan::VlanIndex>
Command Parameters
Table 39.22-1 "SHub Port VLAN association Status Command" Resource Parameters
Resource Identifier Type Description
(port) lt : <Eqpt::Rack> / <Eqpt::Shelf> / port
<Eqpt::LtSlot> | network :
<Shub::NetworkPort>
vlan-id <Vlan::VlanIndex> identity of the vlan
range: [1...4093]
Command Description
This command shows the VLAN identity that corresponds to a given VLAN name, for a VLAN configured on the
Service Hub.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan shub-vlan-name (name)
Command Parameters
Table 39.23-1 "SHub VLAN Name mapping Status Command" Resource Parameters
Resource Identifier Type Description
(name) <Vlan::AdminString> name identifying the vlan
length: x<32
Command Output
Table 39.23-2 "SHub VLAN Name mapping Status Command" Display parameters
Specific Information
name Type Description
vlan-id <Vlan::VlanIndex> vlan identity
range: [1...4093] This element is always shown.
Command Description
This command shows all entries of the Filtering Database given a particular VLAN on the Serice Hub. 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, i.e. a filtering
entry can be configured or dynamically learned.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan shub-fdb (vlanid)
Command Parameters
Table 39.24-1 "SHub VLAN Filtering Database Status Command" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::VlanIndex> vlan id
range: [1...4093]
Command Output
Table 39.24-2 "SHub VLAN Filtering Database Status Command" Display parameters
Specific Information
name Type Description
mac <Vlan::MacAddr> mac address
length: 6 This element is always shown.
bridge-port <Vlan::BridgePort> bridge port
range: [1...3104] This element is always shown.
status <Vlan::FdbEntryStatus> the origin of the entry, unless invalid
Possible values are : This element is always shown.
- 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
Command Description
This command shows one entry of the Filtering Database -if any- given a particular VLAN, a unicast MAC address
and a bridge port on the Service Hub. 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, i.e. a filtering
entry can be configured or dynamically learned.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan shub-filter-entry (vlanid) unicast-mac <Vlan::MacAddr>
Command Parameters
Table 39.25-1 "SHub Filtering Database Entry Status Command" Resource Parameters
Resource Identifier Type Description
(vlanid) <Vlan::VlanIndex> vlan id
range: [1...4093]
unicast-mac <Vlan::MacAddr> mac address
length: 6
Command Output
Table 39.25-2 "SHub Filtering Database Entry Status Command" Display parameters
Specific Information
name Type Description
learnt-port <Shub::LearntBridgePort> port where the mac address was learnt
range: [0...24] This element is always shown.
status <Vlan::FdbEntryStatus> the origin of the entry, unless invalid
Possible values are : This element is always shown.
- 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
Command Description
This command is usefull when a Duplicate MAC Alarm has occured. A Duplicate MAC Alarm is raised when a new
MAC Address could not be learned on a Port of the Service Hub because this MAC Address already exists on
another Port of the Service Hub for the same VLAN, i.e.within the same Filtering Database.
When a Duplicate MAC Alarm is raised it provides the Port and Vlan identity where the alarm occured but it does
not carry the MAC Address itself.
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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show vlan shub-dup-mac-alarm (dup-port) dup-vlan-id <Vlan::VlanIndex>
Command Parameters
Table 39.26-1 "SHub Duplicate Mac Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(dup-port) lt : <Eqpt::Rack> / <Eqpt::Shelf> / duplicate bridge port
<Eqpt::LtSlot> | network :
<Shub::NetworkPort> | nt
dup-vlan-id <Vlan::VlanIndex> duplicate vlan id
range: [1...4093]
Command Output
Table 39.26-2 "SHub Duplicate Mac Alarm Status Command" Display parameters
Specific Information
name Type Description
duplicate-mac <Vlan::MacAddr> duplicate mac address
length: 6 This element is always shown.
Command Description
This command shows information about a Link Aggregation Group configured on the Service Hub. The information
pertains to the Group. The operator will identify the Group by means of the primary link or primary port.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show la aggregator-info (port)
Command Parameters
Table 40.1-1 "Link Aggregation Group Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Shub::NetworkPort> interface index of the port
range: [1...7]
Command Output
Table 40.1-2 "Link Aggregation Group Status Command" Display parameters
Specific Information
name Type Description
mac-address <Vlan::MacAddr> Specifies MAC address assigned to the Aggregator.
length: 6 This element is shown in normal mode.
aggregate <Shub::AggregateFlag> Specifies whether the aggregator represents an
Possible values are : aggregate or an individual link.
- aggregate : aggregate This element is shown in normal mode.
- individual : individual
actor-oper-key <Shub::LacpKey> The current operational value of the key for the
range: [0...65535] aggregator.
This element is shown in normal mode.
partner-sys-id <Vlan::MacAddr> Specifies MAC address for the current protocol
length: 6 partner of this aggregator
This element is shown in normal mode.
partner-sys-priority <Shub::LaPartnerSysPriority> Specifies priority value associated with the
range: [0...65535] partner's system id.
This element is shown in normal mode.
partner-oper-key <Shub::LacpKey> The current operational value for the aggregator's
range: [0...65535] current protocol partner.
This element is shown in normal mode.
Only Show Details: aggregator parameters
Command Description
This command show 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, else the list of ports will be empty.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show la aggregate-list (network-port) participant-port <Shub::NetworkPort>
Command Parameters
Table 40.2-1 "Link Aggregation Member List Status Command" Resource Parameters
Resource Identifier Type Description
(network-port) <Shub::NetworkPort> port
range: [1...7]
participant-port <Shub::NetworkPort> participants in the aggregation group
range: [1...7]
Command Description
This command shows information for a member of a Link Aggregation Group configured on the Service Hub. The
member link is identified by its port number.
Detailled information can be obtained on LACP protocol statistics and debugging information.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show la network-port-info (port)
Command Parameters
Table 40.3-1 "Link Aggregate Member Link Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Shub::NetworkPort> interface index of the network port
range: [1...7]
Command Output
Table 40.3-2 "Link Aggregate Member Link Status Command" Display parameters
Only Show Details: aggregate/individual parameters
name Type Description
actor-sys-id <Vlan::MacAddr> Specifies MAC address that defines the value of the
length: 6 system id for the system that contains this
aggregation port.
This element is always shown.
actor-key <Shub::LacpKey> The current operational value of the key for the
range: [0...65535] aggregation port.
This element is always shown.
partner-sys-priority <Shub::LaPortPartnerAdminSysPrio> The operational value of priority associated with
range: [0...255] the partner's system id.
This element is always shown.
partner-sys-id <Vlan::MacAddr> Specifies MAC address value representing the
length: 6 current value of the aggregation port's protocol
partner's system id.
This element is always shown.
partner-key <Shub::LacpKey> The current operational value of the key for the
range: [0...65535] protocol partner.
This element is always shown.
actual-aggregator-port <Shub::NetworkPort> Specifies the aggregator that this aggregation port
Command Description
This command shows information regarding the Rapid Spanning Tree of the Bridge.
Spanning tree information is shown for the bridge and for the particular bridge port specified in the request,
mainly operational information is displayed.
Detailled statistics can be obtained on the RSTP protocol regarding the reception and transmission of BPDUs.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> show rstp port-info (port)
Command Parameters
Table 41.1-1 "RSTP Bridge and Port Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Shub::NetworkPort> interface index of the port
range: [1...7]
Command Output
Table 41.1-2 "RSTP Bridge and Port Status Command" Display parameters
Common Information
name Type Description
protocol <Shub::StpProtocolSpec> Indicates the version of the spanning tree protocol
Possible values are : being run.
- unknown : unknown This element is always shown.
- dec-lb-100 : dec lb 100
- ieee-802-1d : ieee 802 id
version <Shub::RstpVersion> Indicates the stp version running on the bridge
Possible values are : This element is always shown.
- stp-compatible : ieee 802.1d stp
- rstp : ieee 802.1w rstp
designated-root <Vlan::Binary-08-08> Specifies the bridge identifier of the root of the
length: 8 spanning tree as determined by the spanning tree
protocol.
This element is always shown.
root-cost <SignedInteger> Specifies the cost of the path to the root.
This element is always shown.
root-port <SignedInteger> The port number of the port which offers the lowest
Command Description
A QoS profile in use cannot be deleted. This command displays the usage of QoS Session profiles. The QoS Session
profile usage represents the total user sessions (both for statically configured and dynamic ones).
User Level
The command can be accessed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> show qos profile-usage session (name)
Command Parameters
Table 42.1-1 "QoS Session Profile Status Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Command Output
Table 42.1-2 "QoS Session Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count <AsamProfileRefCount> Indicates the number of entities using this profile. If
range: [0...65535] the reference 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
A QoS profile in use cannot be deleted. This command displays the usage of QoS Marker profiles. The QoS Marker
profile usage shows the references from existing QoS Session profiles as these latter ones are not applied on their
own.
User Level
The command can be accessed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> show qos profile-usage marker (name)
Command Parameters
Table 42.2-1 "QoS Marker Profile Status Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Command Output
Table 42.2-2 "QoS Marker Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count <AsamProfileRefCount> Indicates the number of entities using this profile. If
range: [0...65535] the reference 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
A QoS profile in use cannot be deleted. This command displays the usage of QoS Policer profiles. The QoS Policer
profile usage shows the references from existing QoS Session profiles as these latter ones are not applied on their
own.
User Level
The command can be accessed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> show qos profile-usage policer (name)
Command Parameters
Table 42.3-1 "QoS Policer Profile Status Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Command Output
Table 42.3-2 "QoS Policer Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count <AsamProfileRefCount> Indicates the number of entities using this profile. If
range: [0...65535] the reference 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
A QoS profile in use cannot be deleted. This command displays the usage of QoS Queue profiles. The QoS Queue
profile usage shows the references from existing QoS Session profiles as these latter ones are not applied on their
own.
User Level
The command can be accessed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> show qos profile-usage queue (name)
Command Parameters
Table 42.4-1 "QoS Queue Profile Status Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Command Output
Table 42.4-2 "QoS Queue Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count <AsamProfileRefCount> indicates the number of entities using this profile. If
range: [0...65535] the reference 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
A QoS profile in use cannot be deleted. Use this command to display the usage of QoS Scheduler profiles. The QoS
Scheduler profile usage shows the references from existing QoS Session profiles as these latter ones are not applied
on their own.
User Level
The command can be accessed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> show qos profile-usage scheduler (name)
Command Parameters
Table 42.5-1 "QoS Scheduler Profile Status Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Command Output
Table 42.5-2 "QoS Scheduler Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count <AsamProfileRefCount> Indicates the number of entities using this profile. If
range: [0...65535] the reference 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
A QoS profile in use cannot be deleted. Use this command to display the usage of QoS CAC profiles. The QoS CAC
profile usage shows the references from existing QoS Session profiles as these latter ones are not applied on their
own.
User Level
The command can be accessed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> show qos profile-usage cac (name)
Command Parameters
Table 42.6-1 "QoS CAC Profile Status Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> A unique profile name
range: [a-zA-Z0-9-_]length: 1<=x<32
Command Output
Table 42.6-2 "QoS CAC Profile Status Command" Display parameters
Specific Information
name Type Description
ref-count <AsamProfileRefCount> indicates the number of entities using this profile. If
range: [0...65535] the reference 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 per DSL link.
User Level
The command can be accessed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> show qos dsl-bandwidth (index)
Command Parameters
Table 42.7-1 "QoS DSL Bandwidth Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Eqpt::Rack> / <Eqpt::Shelf> / physical port of a dsl link
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 42.7-2 "QoS DSL Bandwidth Status Command" Display parameters
Specific Information
name Type Description
frame-net-bw <SignedInteger> Represents the approximate 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 <SignedInteger> The portion the frame-net-bw that is reserved for
all data services (typically HSI user traffic). This is
a reserved value per DSL interface (and not per
user session) and applicable in the downstream
direction only.
This element is only shown in detail mode.
res-voice-bw <SignedInteger> The portion of the frame-net-bw that is reserved for
all voice services (typically HSI user traffic). This
is a reserved value per DSL interface (and not per
voice call) and applicable in the downstream
direction only. The usage of this value is to set
apart a minimum rate such that video and voice
services can never impact each other.
This element is only shown in detail mode.
m-cast-max-bw <SignedInteger> Represents the rate limitation imposed by the
Command Description
This command shows the QoS buffer overflow statistics of the previous 15 minute interval.
User Level
The command can be accessed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow prev-15min (equip-slot) interval-num
<Qos::CounterInterval>
Command Parameters
Table 42.8-1 "QoS Buffer Overflow Statistics for Previous Quarter" Resource Parameters
Resource Identifier Type Description
(equip-slot) <Eqpt::Rack> / <Eqpt::Shelf> / physical position of the board
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
interval-num <Qos::CounterInterval> time interval interms of 15 min
range: [1...32]
Command Output
Table 42.8-2 "QoS Buffer Overflow Statistics for Previous Quarter" Display parameters
Specific Information
name Type Description
upstream <Counter> the number of buffer overflows on an EBLT LIM
module in the upstream direction on a 15 minute
interval basis. The upstream direction on the LIM is
non-blocking, hence this value should always read
zero under normal working conditions.
This element is always shown.
upstream-obc <Counter> number of buffer overflows on an EBLT LIM
module for the OBC-directed traffic upstream on a
15 minute interval basis. 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.
Command Description
This command shows the QoS buffer overflow statistics of the current 15 minute interval.
User Level
The command can be accessed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow current-15min (equip-slot)
Command Parameters
Table 42.9-1 "QoS Buffer Overflow Statistics for Current Quarter" Resource Parameters
Resource Identifier Type Description
(equip-slot) <Eqpt::Rack> / <Eqpt::Shelf> / physical position of the board
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
Command Output
Table 42.9-2 "QoS Buffer Overflow Statistics for Current Quarter" Display parameters
Specific Information
name Type Description
upstream <Counter> number of buffer overflows on an EBLT LIM
module in the upstream direction on a 15 minute
interval basis in the current measurement epoch.
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 <Counter> number of buffer overflows on an EBLT LIM
module for the OBC-directed traffic upstream on a
15 minute interval basis in the current
measurement. 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.
Command Description
This command shows the QoS buffer overflow statistics of the previous 1 day interval.
User Level
The command can be accessed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow prev-1day (equip-slot)
Command Parameters
Table 42.10-1 "QoS Buffer Overflow Statistics for Previous Day " Resource Parameters
Resource Identifier Type Description
(equip-slot) <Eqpt::Rack> / <Eqpt::Shelf> / physical position of the board
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
Command Output
Table 42.10-2 "QoS Buffer Overflow Statistics for Previous Day " Display parameters
Specific Information
name Type Description
upstream <Counter> number of buffer overflows on an EBLT LIM
module in the upstream direction on a one day
interval basis. 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 <Counter> number of buffer overflows on an EBLT LIM
module for the OBC-directed traffic upstream on a
one day interval basis. 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 <Counter> number of buffer overflows on a EBLT LIM
Command Description
This command shows the QoS buffer overflow statistics of the current 1 day interval.
User Level
The command can be accessed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow current-1day (equip-slot)
Command Parameters
Table 42.11-1 "QoS Buffer Overflow Statistics for Current Day" Resource Parameters
Resource Identifier Type Description
(equip-slot) <Eqpt::Rack> / <Eqpt::Shelf> / physical position of the board
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
Command Output
Table 42.11-2 "QoS Buffer Overflow Statistics for Current Day" Display parameters
Specific Information
name Type Description
upstream <Counter> number of buffer overflows 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 <Counter> number of buffer overflows 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.
Command Description
This command shows buffer overflow per line card applicable on dedicated buffer pools and not on individual
qeueues. The EBLT-C and EBLT-D line cards 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 in case of experiencing QoS problems under heavy load condition.
User Level
The command can be accessed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow total (equip-slot)
Command Parameters
Table 42.12-1 "QoS Buffer Overflow Statistics Total" Resource Parameters
Resource Identifier Type Description
(equip-slot) <Eqpt::Rack> / <Eqpt::Shelf> / physical position of the board
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
Command Output
Table 42.12-2 "QoS Buffer Overflow Statistics Total" Display parameters
Specific Information
name Type Description
upstream <Counter> Number of buffer overflows per EBLT LIM
module in the upstream direction since the statistics
were last reset. 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 <Counter> Number of buffer overflows on a LIM module for
the OBC-directed traffic upstream since the statistic
was last reset. 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 <Counter> number of buffer overflows on a LIM module for
Command Description
Displays the number of times the meter entry has actually been instantiated on any port.
User Level
The command can be accessed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> show qos shub meter (index)
Command Parameters
Table 42.13-1 "QoS SHub Meter Statistics" Resource Parameters
Resource Identifier Type Description
(index) <Qos::MeterIndex> index used to identify a meter
range: [1...64]
Command Output
Table 42.13-2 "QoS SHub Meter Statistics" Display parameters
Specific Information
name Type Description
ref-count <SignedInteger> nbr of times the meter is instantiated/used on any
port
This element is always shown.
Command Description
Displays the number of times the flow has been actually instantiated on any port.
User Level
The command can be accessed by operators with qos priviliges.
Command Syntax
The command has the following syntax:
> show qos shub flow (index)
Command Parameters
Table 42.14-1 "QoS SHub Flow Statistics" Resource Parameters
Resource Identifier Type Description
(index) <Qos::FlowIndex> index used to identify a flow
range: [1...64]
Command Output
Table 42.14-2 "QoS SHub Flow Statistics" Display parameters
Specific Information
name Type Description
ref-count <SignedInteger> nbr of times the meter is instantiated/used on any
port
This element is always shown.
Command Description
Virtual Routing and Forwarding statistics is shown.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ip vrf-statistics (vrf-id)
Command Parameters
Table 43.1-1 "IP VRF Statistics Status Command" Resource Parameters
Resource Identifier Type Description
(vrf-id) <AsamProfileIndex> an unique id of a VRF.
range: [1...65535]
Command Output
Table 43.1-2 "IP VRF Statistics Status Command" Display parameters
Specific Information
name Type Description
ip-route-entries <Counter> the total number of routes in the system.
This element is always shown.
ip-net2media-entries <Counter> the total number net2media entries.
This element is always shown.
Only Show Details: system statistics
name Type Description
ip-route-entries <Counter> the total number of IP routes in the system.
This element is always shown.
ip-net2media-entries <Counter> the total number of IP net2media entries.
This element is always shown.
Command Description
Displays the IP interface status parameters.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ip ip-statistics (index)
Command Parameters
Table 43.2-1 "IP Interface Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Eqpt::Rack> / <Eqpt::Shelf> / specifies the if-index uniquely indentifying each
<Eqpt::NtSlot> : <Itf::EthernetId> interface
Command Output
Table 43.2-2 "IP Interface Status Command" Display parameters
Specific Information
name Type Description
description <PrintableString> shows the description of the interface
This element is only shown in detail mode.
oper-status <Ip::OperStatus> shows the operational status of the interface
Possible values are : This element is always shown.
- up : the interface in operational state
- down : the interface in down state
- testing : testing state, no operational
packet can be passed
- unknown : state not known
- dormant : ready to transmit, but waiting
for action
last-changed <TimeTicks> shows the time when the interface is changed for
unit: msec the last-time
This element is only shown in detail mode.
in-octets <Counter> shows the total number of octets recieved on the
interface
This element is only shown in detail mode.
in-ucast-pkts <Counter> shows the number of packets delivered by this
sub-layer, which were not addressed to a multicast
or broadcast address at this sub-layer
Command Description
This is used to show User Side VRF IP interface Statistics parameters.There is no Network side IP interfaces
parameter.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ip vrf-interface
Command Description
Display the User Side VRF IP interface Statistics parameters.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ip vrf-interface user port (port-interface)
Command Parameters
Table 43.4-1 "IP VRF Interface User Port Status Command" Resource Parameters
Resource Identifier Type Description
(port-interface) xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port user-port
<Eqpt::LtSlot> / <Eqpt::Port> | slip : identification
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> | ethernet : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::NtSlot> :
<Itf::EthernetId> | pppoeses :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vci> : <PPPoE::LogicalSesId> |
xdsl-channel : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> | atm-if : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> | atm-pvc : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> : <Atm::vpi> : <Atm::vci> |
bridge-port : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> : <Atm::vpi> : <Atm::vci> |
pppoe : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci> | l2-vlan :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Vlan::VlanIndex> | ip :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Ip::LogicalId> |
sw-loopback : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::NtSlot>
Command Output
Table 43.4-2 "IP VRF Interface User Port Status Command" Display parameters
Specific Information
name Type Description
rx-pkts <Binary-08-08> show the number of received packets
length: 8 This element is always shown.
rx-octets <Binary-08-08> show the number of received octets
length: 8 This element is only shown in detail mode.
rx-drop-pkts <Binary-08-08> show the number of received packets which are
length: 8 dropped
This element is always shown.
rx-drop-octets <Binary-08-08> show the number of received octets which are
length: 8 dropped
This element is only shown in detail mode.
tx-pkts <Binary-08-08> show the number of transmitted packets
length: 8 This element is always shown.
tx-octets <Binary-08-08> show the number of transmitted octets
length: 8 This element is only shown in detail mode.
tx-drop-pkts <Binary-08-08> show the number of transmitted packets which are
length: 8 dropped
This element is only shown in detail mode.
tx-drop-octets <Binary-08-08> show the number of transmitted octets which are
length: 8 dropped
This element is only shown in detail mode.
Command Description
This node displays the VRF routes.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ip vrf-route (index) dest-ip-address <Ip::V4Address> / <Ip::PrefixLengthFull>
next-hop-address <Ip::V4Address>
Command Parameters
Table 43.5-1 "IP VRF Routes Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Vrf::VrfIndex> an unique index of a vrf
range: [1...127]
dest-ip-address <Ip::V4Address> / <Ip::PrefixLengthFull> inet-address with prefix
next-hop-address <Ip::V4Address> next hop IP address
Command Output
Table 43.5-2 "IP VRF Routes Status Command" Display parameters
Specific Information
name Type Description
layer3-itf <Ip::Layer3ID> the ipox interface on NT.
This element is always shown.
route-type <Vrf::RouteType> the type of route.
Possible values are : This element is only shown in detail mode.
- local : local destination or direct route
- remote : remote destination or indirect
route
route-proto <Vrf::RouteProtocol> the routing protocol via which this route was
Possible values are : learned.
- local : direct route This element is only shown in detail mode.
- net-mgnt : indirect route
last-changed <Ip::Age> the network time when this was last changed.
This element is only shown in detail mode.
Command Description
This node displays the VRF net to Media statistics.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ip vrf-media (equip-slot) ip-address <Ip::V4Address>
Command Parameters
Table 43.6-1 "IP VRF Net To Media Statistics" Resource Parameters
Resource Identifier Type Description
(equip-slot) <Eqpt::Rack> / <Eqpt::Shelf> / equipment slot ID.
<Eqpt::LtSlot> : <Vrf::VrfIndex>
ip-address <Ip::V4Address> the IP-address.
Command Output
Table 43.6-2 "IP VRF Net To Media Statistics" Display parameters
Specific Information
name Type Description
physical-addr <Ip::PhysicalAddress> the physical IP-address.
length: x<65535 This element is always shown.
last-changed <Sys::Time> date when it is changed for the last time.
This element is only shown in detail mode.
Command Description
This node shows the VRF mapping.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ip vrf-mapping (name)
Command Parameters
Table 43.7-1 "IP VRF Mapping" Resource Parameters
Resource Identifier Type Description
(name) <Vrf::VrfName> name of the vrf
length: 1<=x<32
Command Output
Table 43.7-2 "IP VRF Mapping" Display parameters
Specific Information
name Type Description
vrf-index <Vrf::VrfIndex> A number which uniquely identifies a particular
range: [1...127] VRF context within the system.
This element is always shown.
Command Description
This node shows the next VRF index.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ip vrf-next-index
Command Output
Table 43.8-2 "IP VRF Next Index" Display parameters
Specific Information
name Type Description
next-vrf-index <Vrf::VrfIndex> The next free Virtual Routing and Forwarding
range: [1...127] (VRF) index.
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 priviliges.
Command Syntax
The command has the following syntax:
> show ip shub vrf (index) vlan-id <Vlan::VlanIndex>
Command Parameters
Table 43.9-1 "IP SHub VRF Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Vrf::ShubVrfID> the VRF ID.
range: [0...127]
vlan-id <Vlan::VlanIndex> vlan id
range: [1...4093]
Command Output
Table 43.9-2 "IP SHub VRF Status Command" Display parameters
Specific Information
name Type Description
admin-status <Vrf::ShubIpIfAdminStatus> the administrative status of the VLAN IP interface.
Possible values are : This element is always shown.
- up : ready to pass packets
- down : not ready
- testing : in some test mode
oper-status <Vrf::ShubIpIfOperStatus> the operational status of the VLAN IP interface.
Possible values are : This element is always shown.
- up : ready to pass packets
- down : not ready
- testing : in some test mode
name <PrintableString> the name of the VLAN IP interface.
This element is only shown in detail mode.
ip-address <Ip::V4Address> the IP-address of the VLAN IP interface.
This element is always shown.
mask <Ip::V4Address> the mask of the VLAN IP interface.
This element is always shown.
Command Description
Displays the IP SHub Vrf Route Status parameters.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ip shub vrf-route (index) dest <Ip::V4Address> / <Ip::PrefixLength> next-hop
<Ip::V4Address>
Command Parameters
Table 43.10-1 "IP SHub VRF Route Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Vrf::ShubVrfID> the vrf id
range: [0...127]
dest <Ip::V4Address> / <Ip::PrefixLength> the destination ip address and mask of this route
next-hop <Ip::V4Address> the next hop ip address of this route
Command Output
Table 43.10-2 "IP SHub VRF Route Status Command" Display parameters
Specific Information
name Type Description
protocol <Vrf::ShubRouteProtocol> The routing mechanism that was responsible for
Possible values are : adding this route
- other : not specified This element is always shown.
- local : local interface
- netmgmt : static route
- rip : rip route
- ospf : ospf route
age <SignedInteger> The number of seconds since this route was last
updated
This element is always shown.
Command Description
Displays the IP SHub ARP Statistics per vrf.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ip shub arp (vrf-id)
Command Parameters
Table 43.11-1 "IP SHub ARP VRF Based Statistics Command" Resource Parameters
Resource Identifier Type Description
(vrf-id) <Vrf::ShubVrfID> the vrf number
range: [0...127]
Command Output
Table 43.11-2 "IP SHub ARP VRF Based Statistics Command" Display parameters
Common Information
name Type Description
in-packets <Counter> total number of arp datagrams received from
interfaces, including those received in error.
This element is always shown.
discard <Counter> total number of packets discarded
This element is always shown.
in-request <Counter> number of arp request packets received
This element is always shown.
in-resp <Counter> number of arp response packets received
This element is always shown.
out-request <Counter> number of arp requests transmitted
This element is always shown.
out-resp <Counter> number of arp responses transmitted
This element is always shown.
Specific Information
name Type Description
rx-arp-pkts <Counter> number of arp received packets
This element is always shown.
arp-discards <Counter> number of arp discard packets
This element is always shown.
rx-arp-req <Counter> number of received arp request packets
Command Description
This command displays xDSL profiles.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl profiles
Command Output
Table 44.1-2 "xDSL Profiles Status Command" Display parameters
Specific Information
name Type Description
next-av-serv-pr <AsamNextProfileIndex> next available index for the profile
range: [0...65535] This element is always shown.
max-serv-pr <AsamMaxProfileIndex> max number of profile indices that can be created
range: [0...65535] This element is always shown.
next-av-spec-pr <AsamNextProfileIndex> next available spectrum index
range: [0...65535] This element is always shown.
max-spec-pr <AsamMaxProfileIndex> max number of spectrum indices that can be
range: [0...65535] created
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 priviliges.
Command Syntax
The command has the following syntax:
> show xdsl xdsl-int (if-index)
Command Parameters
Table 44.2-1 "xDSL PM Interval Per Interface Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.2-2 "xDSL PM Interval Per Interface Status Command" Display parameters
Specific Information
name Type Description
cur-int-elapsedtime <SignedInteger> nbr of sec elapsed in cur intvl err-measurement
This element is always shown.
cur-1day-elapsedtime <SignedInteger> nbr of sec elapsed in cur one day err-measurement
This element is always shown.
valid-intervals <SignedInteger> nbr of prev intvl for which valid data has been
stored
This element is always shown.
valid-1days <SignedInteger> nbr of prev 1Days for which valid data has been
stored
This element is always shown.
Only Show Details: global settings
name Type Description
xdsl-coding-type <Xdsl::Coding> nbr of prev 1 day for which valid data has been
Possible values are : stored
- other : other type This element is always shown.
- dmt : DMT type
- cap : CAP type
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 priviliges.
Command Syntax
The command has the following syntax:
> show xdsl operational-data near-end line (if-index)
Command Parameters
Table 44.3-1 "xDSL Operational Data Near End Line Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.3-2 "xDSL Operational Data Near End Line Status Command" Display parameters
Specific Information
name Type Description
rel-cap-occ-up <Xdsl::CapacityUtil> ratio of actual bitrate over the max attainable bitrate
range: [0...100] unit: % This element is always shown.
noise-margin-up <Xdsl::DB> current noise margin for the upstream direction
unit: 1/10 db This element is always shown.
output-power-down <Xdsl::DB> actual aggregate output power for the downstream
unit: 1/10 db carriers
This element is always shown.
sig-attenuation-up <Xdsl::DB> diff btw pwr at far-end rx-ver and that tx-ed from
unit: 1/10 db near-end
This element is always shown.
loop-attenuation-up <Xdsl::DB> diff btw pwr at far-end rx-ver and that tx-ed from
unit: 1/10 db near-end over all sub-carriers
This element is always shown.
actual-opmode <Xdsl::OpModeType> bitmap which represents the operational modes of
length: 8 the ATU-C
This element is always shown.
xtu-c-opmode <Xdsl::OpModeType> bitmap which represents the operational modes
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 priviliges.
Command Syntax
The command has the following syntax:
> show xdsl operational-data near-end channel (if-index)
Command Parameters
Table 44.4-1 "xDSL Operational Data Near End Channel Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.4-2 "xDSL Operational Data Near End Channel Status Command" Display parameters
Specific Information
name Type Description
actual-bitrate-up <Xdsl::bitrate> atm bitrate for upstream fast or interleaved data
unit: kbits/sec flow
This element is always shown.
attain-bitrate-up <Xdsl::bitrate> maximum attainable atm rate the modem can
unit: kbits/sec support
This element is always shown.
interleave-delay-down <Xdsl::milliseconds> delay caused by the interleaving and deinterleaving
unit: msec functionality
This element is always shown.
imp-noise-prot-down <Xdsl::impNoise> actual impulse noise protection
unit: 1/10 symbols This element is always shown.
Command Description
This command displays the xDSL operational data for the far end.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl operational-data far-end
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 priviliges.
Command Syntax
The command has the following syntax:
> show xdsl operational-data far-end channel (if-index)
Command Parameters
Table 44.6-1 "xDSL Operational Data Far End Channel" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.6-2 "xDSL Operational Data Far End Channel" Display parameters
Specific Information
name Type Description
actual-bitrate-down <Xdsl::bitrate> atm bitrate for downstream fast or interleaved data
unit: kbits/sec flow
This element is always shown.
attain-bitrate-down <Xdsl::bitrate> maximum attainable atm rate the modem can
unit: kbits/sec support
This element is always shown.
interleave-delay-up <Xdsl::milliseconds> delay caused by the interleaving and deinterleaving
unit: msec functionality
This element is always shown.
imp-noise-prot-up <Xdsl::impNoise> actual impulse noise protection
unit: 1/10 symbols This element is always shown.
Command Description
This command displays xDSL carrier data near end.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl carrier-data near-end (if-index)
Command Parameters
Table 44.7-1 "xDSL Carrier Data Near End Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.7-2 "xDSL Carrier Data Near End Status Command" Display parameters
Specific Information
name Type Description
spacing <Xdsl::CarrierSpacingType> nbr of bits per carrier over the downstream
Possible values are : passband
- single : single This element is always shown.
- double : double
- half : half
- quarter : quarter
load-distribution-down <BinaryString> gain allocation over the downstream passband
This element is always shown.
gain-allocation-down <BinaryString> transmit spectrum shaping for the downstream
direction
This element is always shown.
tss-down <Xdsl::CustomPsdShape> signal to noise ratio per carrier over the upstream
length: x<60 passband
This element is always shown.
snr-up <BinaryString> quiet line noise per carrier over the upstream
passband
This element is always shown.
qln-up <BinaryString> char function values in linear scale over upstream
passband
This element is always shown.
Command Description
This command displays xDSL carrier data far end.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl carrier-data far-end (if-index)
Command Parameters
Table 44.8-1 "xDSL Carrier Data Far End Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.8-2 "xDSL Carrier Data Far End Status Command" Display parameters
Specific Information
name Type Description
spacing <Xdsl::CarrierSpacingType> the actual carrier spacing used on the XDSL line in
Possible values are : the downstream direction
- single : single This element is always shown.
- double : double
- half : half
- quarter : quarter
load-distribution-up <BinaryString> nbr of bits per carrier over the upstream passband
This element is always shown.
gain-allocation-up <BinaryString> gain allocation over the upstream passband
This element is always shown.
tss-up <Xdsl::CustomPsdShape> transmit spectrum shaping for the upstream
length: x<60 direction
This element is always shown.
snr-down <BinaryString> signal to noise ratio per carrier over the
downstream passband
This element is always shown.
qln-down <BinaryString> quiet line noise per carrier over the downstream
passband
This element is always shown.
char-func-complex <BinaryString> char function values in linear scale over
Command Description
This command displays the xDSL failure status near end.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl failure-status near-end (if-index)
Command Parameters
Table 44.9-1 "xDSL Failure Status Near End Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.9-2 "xDSL Failure Status Near End Status Command" Display parameters
Specific Information
name Type Description
status <SignedInteger> failure status of the xdsl near end line
This element is always shown.
Command Description
This command displays the xDSL failure of the far end.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl failure-status far-end (if-index)
Command Parameters
Table 44.10-1 "xDSL Failure Status Far End Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.10-2 "xDSL Failure Status Far End Status Command" Display parameters
Specific Information
name Type Description
status <SignedInteger> failure status of xdsl far end line
This element is always shown.
Command Description
This command displays xDSL counters near end line current 15 min.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl counters near-end line current-interval (if-index)
Command Parameters
Table 44.11-1 "xDSL Counters Near End Line Current 15 Min" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.11-2 "xDSL Counters Near End Line Current 15 Min" Display parameters
Specific Information
name Type Description
los <Counter> number of occurences of an LOS failure event
This element is always shown.
lof <Counter> number of occurences of an LOF failure event
This element is always shown.
lom <Counter> number of occurences of a LOM failure event
This element is always shown.
ese <Counter> number of occurences of an ESE failure event
This element is always shown.
es <Counter> number of errored seconds encountered by the line
This element is always shown.
sec <Counter> number of severely errored seconds encountered by
the line
This element is always shown.
uas <Counter> number of unavailable seconds encountered by the
line
This element is always shown.
re-init <Counter> number of times the modem re-initialize the line
This element is always shown.
failed-init <Counter> number of times the modem failed to initialize the
line
Command Description
This command displays the xDSL counters near end line current day.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl counters near-end line current-1day (if-index)
Command Parameters
Table 44.12-1 "xDSL Counters Near End Line Current Day" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.12-2 "xDSL Counters Near End Line Current Day" Display parameters
Specific Information
name Type Description
los <Counter> number of occurences of an LOS failure event
This element is always shown.
lof <Counter> number of occurences of an LOF failure event
This element is always shown.
lom <Counter> number of occurences of a LOM failure event
This element is always shown.
ese <Counter> number of occurences of an ESE failure event
This element is always shown.
es <Counter> number of errored seconds encountered by the line
This element is always shown.
sec <Counter> number of severely errored seconds encountered by
the line
This element is always shown.
uas <Counter> number of unavailable seconds encountered by the
line
This element is always shown.
re-init <Counter> number of times the modem re-initialize the line
This element is always shown.
failed-init <Counter> number of times the modem failed to initialize the
line
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 priviliges.
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 44.13-1 "xDSL Counters Near End Line Previous 15 Min" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
interval-no <Xdsl::IntervalNumber15min> Interval number
range: [1...192]
Command Output
Table 44.13-2 "xDSL Counters Near End Line Previous 15 Min" Display parameters
Specific Information
name Type Description
los <Counter> number of occurences of an LOS failure event
This element is always shown.
lof <Counter> number of occurences of an LOF failure event
This element is always shown.
lom <Counter> number of occurences of a LOM failure event
This element is always shown.
ese <Counter> number of occurences of an ESE failure event
This element is always shown.
es <Counter> number of errored seconds encountered by the line
This element is always shown.
sec <Counter> number of severely errored seconds encountered by
the line
This element is always shown.
uas <Counter> number of unavailable seconds encountered by the
line
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 priviliges.
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 44.14-1 "xDSL Counters Near End Of Line Previous Day" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
interval-no <Xdsl::IntervalNumber1day> Interval number
range: [1...7]
Command Output
Table 44.14-2 "xDSL Counters Near End Of Line Previous Day" Display parameters
Specific Information
name Type Description
los <Counter> number of occurences of an LOS failure event
This element is always shown.
lof <Counter> number of occurences of an LOF failure event
This element is always shown.
lom <Counter> number of occurences of a LOM failure event
This element is always shown.
ese <Counter> number of occurences of an ESE failure event
This element is always shown.
es <Counter> number of errored seconds encountered by the line
This element is always shown.
sec <Counter> number of severely errored seconds encountered by
the line
This element is always shown.
uas <Counter> number of unavailable seconds encountered by the
line
Command Description
This command displays xDSL counters near end channel current 15 min.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl counters near-end channel current-interval (if-index)
Command Parameters
Table 44.15-1 "xDSL Counters Near End Channel Current 15 Min" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.15-2 "xDSL Counters Near End Channel Current 15 Min" Display parameters
Specific Information
name Type Description
cv <Counter> number of coding violations encountered by the
channel
This element is always shown.
fecc <Counter> number of corrected codewords encountered by the
channel
This element is always shown.
measured-time <Xdsl::IntervalMeasureTime> amt of time in sec that statistics have been counted
range: [0...86400] unit: sec This element is always shown.
in-valid-flag <Xdsl::IntervalValidityFlag> validity of the corresponding PM data
Possible values are : This element is always shown.
- true : data is not valid
- false : data is valid
Command Description
This command displays xDSL counters near end channel current day.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl counters near-end channel current-1day (if-index)
Command Parameters
Table 44.16-1 "xDSL Counters Near End Channel Current Day" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.16-2 "xDSL Counters Near End Channel Current Day" Display parameters
Specific Information
name Type Description
cv <Counter> number of coding violations encountered by the
channel
This element is always shown.
fecc <Counter> number of corrected codewords encountered by the
channel
This element is always shown.
measured-time <Xdsl::IntervalMeasureTime> amt of time in sec that statistics have been counted
range: [0...86400] unit: sec This element is always shown.
in-valid-flag <Xdsl::IntervalValidityFlag> validity of the corresponding PM data
Possible values are : This element is always shown.
- true : data is not valid
- false : data is valid
Command Description
This command displays xDSL counters near end channel previous 15 min.
User Level
The command can be accessed by operators with xdsl priviliges.
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 44.17-1 "xDSL Counters Near End Channel Previous 15 Min" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
interval-no <Xdsl::IntervalNumber15min> Interval number
range: [1...192]
Command Output
Table 44.17-2 "xDSL Counters Near End Channel Previous 15 Min" Display parameters
Specific Information
name Type Description
cv <Counter> number of coding violations encountered by the
channel
This element is always shown.
fecc <Counter> number of corrected codewords encountered by the
channel
This element is always shown.
measured-time <Xdsl::IntervalMeasureTime> amt of time in sec that statistics have been counted
range: [0...86400] unit: sec This element is always shown.
in-valid-flag <Xdsl::IntervalValidityFlag> validity of the corresponding PM data
Possible values are : This element is always shown.
- true : data is not valid
- false : data is valid
Command Description
This command displays xDSL counters near end channel previous day.
User Level
The command can be accessed by operators with xdsl priviliges.
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 44.18-1 "xDSL Counters Near End Channel Previous Day" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
interval-no <Xdsl::IntervalNumber1day> Interval number
range: [1...7]
Command Output
Table 44.18-2 "xDSL Counters Near End Channel Previous Day" Display parameters
Specific Information
name Type Description
cv <Counter> number of coding violations encountered by the
channel
This element is always shown.
fecc <Counter> number of corrected codewords encountered by the
channel
This element is always shown.
measured-time <Xdsl::IntervalMeasureTime> amt of time in sec that statistics have been counted
range: [0...86400] unit: sec This element is always shown.
in-valid-flag <Xdsl::IntervalValidityFlag> validity of the corresponding PM data
Possible values are : This element is always shown.
- true : data is not valid
- false : data is valid
Command Description
This command displays xDSL counters far end line current 15 min.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl counters far-end line current-interval (if-index)
Command Parameters
Table 44.19-1 "xDSL Counters Far End Line Current 15 Min" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the xdsl port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.19-2 "xDSL Counters Far End Line Current 15 Min" Display parameters
Specific Information
name Type Description
los <Counter> number of occurences of an los failure event
This element is always shown.
lof <Counter> number of occurences of an lof failure event
This element is always shown.
lom <Counter> number of occurences of an lom failure event
This element is always shown.
lpr <Counter> number of occurences of an lpr failure event
This element is always shown.
lol <Counter> number of occurences of an lol failure event
This element is always shown.
ese <Counter> number of occurences of an ese failure event
This element is always shown.
es <Counter> number of errored seconds encountered by the line
This element is always shown.
ses <Counter> number of severely errored seconds encountered by
the line
This element is always shown.
uas <Counter> number of unavailable seconds encountered by the
line
This element is always shown.
Command Description
This command displays xDSL counters far end line current day.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl counters far-end line current-1day (if-index)
Command Parameters
Table 44.20-1 "xDSL Counters Far End Line Current Day" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.20-2 "xDSL Counters Far End Line Current Day" Display parameters
Specific Information
name Type Description
los <Counter> number of occurences of an los failure event
This element is always shown.
lof <Counter> number of occurences of an lof failure event
This element is always shown.
lom <Counter> number of occurences of an lom failure event
This element is always shown.
lpr <Counter> number of occurences of an lpr failure event
This element is always shown.
lol <Counter> number of occurences of an lol failure event
This element is always shown.
ese <Counter> number of occurences of an ese failure event
This element is always shown.
es <Counter> number of errored seconds encountered by the line
This element is always shown.
ses <Counter> number of severely errored seconds encountered by
the line
This element is always shown.
uas <Counter> number of unavailable seconds encountered by the
line
This element is always shown.
Command Description
This command displays xDSL counters far end line previous 15 min.
User Level
The command can be accessed by operators with xdsl priviliges.
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 44.21-1 "xDSL Counters Far End Line Previous 15 Min" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
interval-no <Xdsl::IntervalNumber15min> Interval number
range: [1...192]
Command Output
Table 44.21-2 "xDSL Counters Far End Line Previous 15 Min" Display parameters
Specific Information
name Type Description
los <Counter> number of occurences of an los failure event
This element is always shown.
lof <Counter> number of occurences of an lof failure event
This element is always shown.
lom <Counter> number of occurences of an lom failure event
This element is always shown.
lpr <Counter> number of occurences of an lpr failure event
This element is always shown.
lol <Counter> number of occurences of an lol failure event
This element is always shown.
ese <Counter> number of occurences of an ese failure event
This element is always shown.
es <Counter> number of errored seconds encountered by the line
This element is always shown.
ses <Counter> number of severely errored seconds encountered by
the line
This element is always shown.
uas <Counter> number of unavailable seconds encountered by the
Command Description
This command displays xDSL counters far end line previous day.
User Level
The command can be accessed by operators with xdsl priviliges.
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 44.22-1 "xDSL Counters Far End Line Previous Day" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
interval-no <Xdsl::IntervalNumber1day> Interval number
range: [1...7]
Command Output
Table 44.22-2 "xDSL Counters Far End Line Previous Day" Display parameters
Specific Information
name Type Description
los <Counter> number of occurences of an los failure event
This element is always shown.
lof <Counter> number of occurences of an lof failure event
This element is always shown.
lom <Counter> number of occurences of an lom failure event
This element is always shown.
lpr <Counter> number of occurences of an lpr failure event
This element is always shown.
lol <Counter> number of occurences of an lol failure event
This element is always shown.
ese <Counter> number of occurences of an ese failure event
This element is always shown.
es <Counter> number of errored seconds encountered by the line
This element is always shown.
ses <Counter> number of severely errored seconds encountered by
the line
This element is always shown.
uas <Counter> number of unavailable seconds encountered by the
Command Description
This command displays xDSL counters far end channel current 15 min.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl counters far-end channel current-interval (if-index)
Command Parameters
Table 44.23-1 "xDSL Counters Far End Channel Current 15 Min" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.23-2 "xDSL Counters Far End Channel Current 15 Min" Display parameters
Specific Information
name Type Description
cv <Counter> nbr of coding violations encountered by far end
channel
This element is always shown.
fecc <Counter> nbr of corrected codewords encountered by far end
channel
This element is always shown.
measured-time <Xdsl::IntervalMeasureTime> amt of time in sec that statistics have been counted
range: [0...86400] unit: sec This element is always shown.
in-valid-flag <Xdsl::IntervalValidityFlag> validity of the corresponding PM data
Possible values are : This element is always shown.
- true : data is not valid
- false : data is valid
Command Description
This command displays xDSL counters far end channel current day.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl counters far-end channel current-1day (if-index)
Command Parameters
Table 44.24-1 "xDSL Counters Far End Channel Current Day" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.24-2 "xDSL Counters Far End Channel Current Day" Display parameters
Specific Information
name Type Description
cv <Counter> nbr of coding violations encountered by far end
channel
This element is always shown.
fecc <Counter> nbr of corrected codewords encountered by far end
channel
This element is always shown.
measured-time <Xdsl::IntervalMeasureTime> amt of time in sec that statistics have been counted
range: [0...86400] unit: sec This element is always shown.
in-valid-flag <Xdsl::IntervalValidityFlag> validity of the corresponding PM data
Possible values are : This element is always shown.
- true : data is not valid
- false : data is valid
Command Description
This command displays xDSL counters far end channel previous 15 min.
User Level
The command can be accessed by operators with xdsl priviliges.
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 44.25-1 "xDSL Counters Far End Channel Previous 15 Min" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
interval-no <Xdsl::IntervalNumber15min> Interval number
range: [1...192]
Command Output
Table 44.25-2 "xDSL Counters Far End Channel Previous 15 Min" Display parameters
Specific Information
name Type Description
cv <Counter> number of coding violations in the past 24 hours
This element is always shown.
fecc <Counter> number of corrected codewords in the past 24 hours
This element is always shown.
measured-time <Xdsl::IntervalMeasureTime> amt of time in sec that statistics have been counted
range: [0...86400] unit: sec This element is always shown.
in-valid-flag <Xdsl::IntervalValidityFlag> validity of the corresponding PM data
Possible values are : This element is always shown.
- true : data is not valid
- false : data is valid
Command Description
This command displays xDSL counters far end channel previous day.
User Level
The command can be accessed by operators with xdsl priviliges.
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 44.26-1 "xDSL Counters Far End Channel Previous Day" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
interval-no <Xdsl::IntervalNumber1day> Interval number
range: [1...7]
Command Output
Table 44.26-2 "xDSL Counters Far End Channel Previous Day" Display parameters
Specific Information
name Type Description
cv <Counter> number of coding violations in the previous one
day
This element is always shown.
fecc <Counter> number of corrected codewords in the previous one
day
This element is always shown.
measured-time <Xdsl::IntervalMeasureTime> amt of time in sec that statistics have been counted
range: [0...86400] unit: sec This element is always shown.
in-valid-flag <Xdsl::IntervalValidityFlag> validity of the corresponding PM data
Possible values are : This element is always shown.
- true : data is not valid
- false : data is valid
Command Description
This command displays xDSL inventory XT/RT.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl cpe-inventory (if-index)
Command Parameters
Table 44.27-1 "xDSL Inventory XT/RT Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.27-2 "xDSL Inventory XT/RT Status Command" Display parameters
Specific Information
name Type Description
modem-vendor-id <Xdsl::VendorID> vendor ID retrieved during handshaking
length: x<16 This element is always shown.
sys-serial-no <Xdsl::SystemSerialNumber> serial number that identifies the vendor equipment
length: x<32 This element is always shown.
sys-vendor-id <Xdsl::VendorID> vendor ID retrieved via the xdsl EOC
length: x<16 This element is always shown.
sys-version-no <Xdsl::SystemVersionNo> version number retrieved via the the xdsl EOC
length: x<34 This element is always shown.
self-test-result <Xdsl::SelfTestResult> self test results value retrieved via the the xdsl EOC
length: x<8 This element is always shown.
Command Description
This command displays xDSL board capability.
User Level
The command can be accessed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> show xdsl board (if-index)
Command Parameters
Table 44.28-1 "xDSL Board Capability Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Command Output
Table 44.28-2 "xDSL Board Capability Status Command" Display parameters
Specific Information
name Type Description
capability <Xdsl::OpModeType> operational mode supported by the board
length: 8 This element is always shown.
Command Description
PPP CC Engine represents the engine in charge of establishing PPP CC's and forwarding the associated traffic.
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect engine (engine-id)
Command Parameters
Table 45.1-1 "PPPoX CC Engine Status Command" Resource Parameters
Resource Identifier Type Description
(engine-id) <Vlan::VlanId> engine identification
range: [1...4093]
Command Description
This command shows statistics for a particular Vlan ID.
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect engine (engine-id) statistics
Command Parameters
Table 45.2-1 "PPPoX CC Engine Statistics" Resource Parameters
Resource Identifier Type Description
(engine-id) <Vlan::VlanId> engine identification
range: [1...4093]
Command Output
Table 45.2-2 "PPPoX CC Engine Statistics" Display parameters
Specific Information
name Type Description
vlan-id <Vlan::VlanId> PPP CC Engine related vlan id
range: [1...4093] This element is always shown.
engine-name <PPPoX::EngineName> name to identify the engine/service
length: 1<=x<32 This element is always shown.
in-ctrl-frm <Counter> number of ingress control messages
This element is always shown.
out-ctrl-frm <Counter> number of egress control messages
This element is always shown.
err-ctrl-frm <Counter> nbr of errored upstream and downstream control
msgs
This element is only shown in detail mode.
ppp-cc <SignedInteger> nbr of PPP cross-connections currently in use
This element is always shown.
Only Show Details: engine-monitor statistics
name Type Description
generic-err-cnt <Counter> nbr of discovery msgs that carried the Generic
Error tag
This element is only shown in detail mode.
inv-serv-name <Counter> nbr of PAD-S msgs containing Service-Name-Error
tag
Command Description
This command shows associated ports of PPP CC Engine2Client Port.
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect engine (engine-id) associated-ports
Command Parameters
Table 45.3-1 "PPPoX CC Engine to Port Association Status Command" Resource Parameters
Resource Identifier Type Description
(engine-id) <Vlan::VlanId> engine identification
range: [1...4093]
Command Output
Table 45.3-2 "PPPoX CC Engine to Port Association Status Command" Display parameters
Specific Information
name Type Description
vlan-id <Vlan::VlanId> PPP CC Engine related vlan id
range: [1...4093] This element is always shown.
engine-name <PPPoX::EngineName> name to identify the engine/service
length: 1<=x<32 This element is always shown.
Only Show Details: engine to client-port
name Type Description
assoc-ports <Eqpt::Rack> / <Eqpt::Shelf> / PPP CC client port associated to this PPP CC
<Eqpt::LtSlot> / <Eqpt::Port> : engine
<Atm::vpi> : <Atm::vci> This element is always shown.
Command Description
The PPP Port represents an interface of the PPP CC Engine.A PPP CC is established between two of those PPP
Ports, one at the network side and the other, at the user side.
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect client-port (client-port)
Command Parameters
Table 45.4-1 "PPPoX CC Client Port Status Command" Resource Parameters
Resource Identifier Type Description
(client-port) <Eqpt::Rack> / <Eqpt::Shelf> / client port identification
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 45.4-2 "PPPoX CC Client Port Status Command" Display parameters
Specific Information
name Type Description
in-ctrl-frm <Counter> number of ingress control messages
This element is always shown.
out-ctrl-frm <Counter> number of egress control messages
This element is always shown.
err-ctrl-frm <Counter> number of errored control messages
This element is always shown.
Only Show Details: client-port monitor
name Type Description
unexp-ctrl-msg <Counter> number of unexpected control messages discarded
This element is only shown in detail mode.
unexp-data-pkts <Counter> number of discarded data packets on this port
This element is only shown in detail mode.
prt-mru-err-cnt <Counter> number of long messages discarded on this port
This element is only shown in detail mode.
trans-age-out <Counter> nbr of events cleared because the transaction timed
out
This element is only shown in detail mode.
session-age-out <Counter> nbr of events timed out for this port
Command Description
This command shows session data for engine
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect session engine (vlan-id)
Command Parameters
Table 45.5-1 "PPPoX CC Session Engine Status Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) <Vlan::VlanId> engine identification
range: [1...4093]
Command Output
Table 45.5-2 "PPPoX CC Session Engine Status Command" Display parameters
Specific Information
name Type Description
server-mac-addr <Vlan::MacAddr> mac-addr of the PPPoE Server of this PPP
length: 6 cross-connection
This element is always shown.
ext-session-id <SignedInteger> PPPoE session id of this PPP cross-connection
This element is always shown.
client-port <Eqpt::Rack> / <Eqpt::Shelf> / Index to which the PPPoE client is directly
<Eqpt::LtSlot> / <Eqpt::Port> : associated
<Atm::vpi> : <Atm::vci> This element is always shown.
int-session-id <SignedInteger> index that uniquely indicate a PPP cross-connection
This element is always shown.
Command Description
This command shows session data for client port
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect session client-port (client-port)
Command Parameters
Table 45.6-1 "PPPoX CC Session Client Port Status Command" Resource Parameters
Resource Identifier Type Description
(client-port) <Eqpt::Rack> / <Eqpt::Shelf> / client port identification
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 45.6-2 "PPPoX CC Session Client Port Status Command" Display parameters
Specific Information
name Type Description
server-mac-addr <Vlan::MacAddr> mac-addr of the PPPoE server of this PPP
length: 6 cross-connection
This element is always shown.
ext-session-id <SignedInteger> PPPoE session id of this PPP cross-connection
This element is always shown.
engine-id <PPPoX::EngineIndex> index to where this PPP cross-connection belongs
range: [1...64] This element is always shown.
int-session-id <SignedInteger> index that uniquely indicate a PPP cross-connection
This element is always shown.
Command Description
Shows pppoe session parameters like pppoe session id, ppoe session lowerlayer Ifindex, ppoe session local Mac
Address, pppoe Remote Mac Address.
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppoe session (port)
Command Parameters
Table 46.1-1 "PPPoE Sessions Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci> :
<PPPoE::LogicalSesId>
Command Output
Table 46.1-2 "PPPoE Sessions Status Command" Display parameters
Specific Information
name Type Description
session-id <SignedInteger> PPPoE session id associated for a PPP session
This element is always shown.
local-mac <Vlan::MacAddr> The MAC address of the PPPoE server on which
length: 6 PPPoE session is established.
This element is always shown.
remote-mac <Vlan::MacAddr> The MAC address of the user who established the
length: 6 PPPoE session.
This element is always shown.
Command Description
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppoe connection (connection)
Command Parameters
Table 46.2-1 "PPPoE Sessions/Connection Status Command" Resource Parameters
Resource Identifier Type Description
(connection) <Eqpt::Rack> / <Eqpt::Shelf> / the identification of a pppoe interface
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 46.2-2 "PPPoE Sessions/Connection Status Command" Display parameters
Specific Information
name Type Description
session <Eqpt::Rack> / <Eqpt::Shelf> / the identification of a session
<Eqpt::LtSlot> / <Eqpt::Port> : This element is always shown.
<Atm::vpi> : <Atm::vci> :
<PPPoE::LogicalSesId>
session-id <SignedInteger> PPPoE session id associated for a PPP session
This element is always shown.
local-mac <Vlan::MacAddr> The MAC address of the PPPoE server on which
length: 6 PPPoE session is established.
This element is always shown.
remote-mac <Vlan::MacAddr> The MAC address of the user who established the
length: 6 PPPoE session.
This element is always shown.
Command Description
This node shows the PPPoE interface parameters.
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppoe if-table (session)
Command Parameters
Table 46.3-1 "PPPoE Interface Status Command" Resource Parameters
Resource Identifier Type Description
(session) <Eqpt::Rack> / <Eqpt::Shelf> / the identification of a pppoe session
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci> :
<PPPoE::LogicalSesId>
Command Output
Table 46.3-2 "PPPoE Interface Status Command" Display parameters
Specific Information
name Type Description
state <PPPoE::pppIfState> current PPP state of the session.
Possible values are : This element is always shown.
- 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 <PrintableString> username (along with the domain name) who
established the PPPoE session.
This element is always shown.
local-ip-addr <Ip::V4Address> IP address of the system on which PPPoE session is
established
This element is only shown in detail mode.
remote-ip-addr <Ip::V4Address> IP address of the user who established the PPPoE
session.
This element is only shown in detail mode.
local-mru <SignedInteger> The MRU of the system link, on which PPPoE
Command Description
Shows the statistics of PPP on PPPoX interface. This command takes the rack/subrack/slot/port and vpi and vci
values as argument on which the pppoe was configured, or for which to show the arguments.
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppoe ppp-statistics (port)
Command Parameters
Table 46.4-1 "PPPoX Interface Statistics" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 46.4-2 "PPPoX Interface Statistics" Display parameters
Specific Information
name Type Description
open-sess <Counter> total number of opened sessions.
This element is always shown.
low-layer-down-event <Counter> total number of session terminates due to link down
events.
This element is always shown.
chap-auth-fail <Counter> total number of CHAP authentication failure.
This element is always shown.
pap-auth-fail <Counter> total number of PAP authentication failure.
This element is always shown.
ip-addr-fail <Counter> total number of failed retrievals for local IP
address.
This element is only shown in detail mode.
lcp-nego-mis <Counter> total number of negotiation mismatch occurred in
LCP phase.
This element is only shown in detail mode.
ipcp-nego-mis <Counter> total number of negotiation mismatch occurred in
IPCP phase.
This element is only shown in detail mode.
Command Description
Shows the statistics of pppoe interface. This command takes the rack/subrack/slot/port and vpi and vci values as
argument on which the pppoe was configured, or for which to show the arguments.
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppoe statistics-pppoe-itf stats (port)
Command Parameters
Table 46.5-1 "PPPoE Interface Statistics" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 46.5-2 "PPPoE Interface Statistics" Display parameters
Specific Information
name Type Description
act-sess <Gauge> Total number of active PPPoE sessions.
This element is always shown.
estab-sess <Counter> Total number of PPPoE sessions established after
the system has been reset.
This element is always shown.
error <Counter> The statistics indicates the number of errors
experienced in performing the host request.
This element is always shown.
padi-inv-id <Counter> Total number of invalid session-id received in
PADI packets.
This element is always shown.
padr-inv-id <Counter> Total number of invalid session-id received in
PADR packets.
This element is always shown.
Command Description
Displays the PPPoE interface recieved statistics.
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppoe statistics-pppoe-itf rx-pkt (port)
Command Parameters
Table 46.6-1 "PPPoE Interface Received Statistics" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 46.6-2 "PPPoE Interface Received Statistics" Display parameters
Specific Information
name Type Description
inv-header <Counter> Total number of PPPoE invalid header packets
received.
This element is always shown.
inv-type <Counter> Total number of PPPoE invalid type packets
received.
This element is always shown.
inv-code <Counter> Total number of PPPoE invalid code packets
received.
This element is always shown.
invl-tag <Counter> Total number of invalid tag received in the PPPoE
header.
This element is always shown.
invl-length <Counter> Total number packets received with invalid length
in PPPoE header.
This element is always shown.
padi <Counter> Total number of PPPoE active discovery initiation
(PADI) packets received.
This element is always shown.
padr <Counter> Total number of PPPoE active discovery request
Command Description
Displays the PPPoE interface transmitted statistics.
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppoe statistics-pppoe-itf tx-pkt (port)
Command Parameters
Table 46.7-1 "PPPoE Interface Transmitted Statistics" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 46.7-2 "PPPoE Interface Transmitted Statistics" Display parameters
Specific Information
name Type Description
pado <Counter> Total number of PPPoE active discovery offer
(PADO) packets transmitted
This element is always shown.
pads <Counter> Total number of PPPoE active discovery
session-confirmation (PADS) packets transmitted
This element is always shown.
padt <Counter> Total number of PPPoE active discovery terminate
(PADT) packets transmitted
This element is always shown.
rej-padi <Counter> Total number of PPPoE active discovery initiation
(PADI) packets that were rejected
This element is always shown.
rej-padr <Counter> Total number of PPPoE active discovery request
(PADR) packets that were rejected
This element is always shown.
Command Description
This command shows the value of ppp-profile name, used-status and the version of the profile.
The manager can associate a version number to the profile. It is set to 1 when the profile is first created and will be
incremented by the manager when the profile is modified.
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 may 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 priviliges.
Command Syntax
The command has the following syntax:
> show pppoe ppp-profile (name)
Command Parameters
Table 46.8-1 "PPPoE Profile Status Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> name of the profile
range: [a-zA-Z0-9-_]length: 1<=x<32
Command Output
Table 46.8-2 "PPPoE Profile Status Command" Display parameters
Specific Information
name Type Description
used-status <AsamProfileRefCount> indicates the number of entities using this profile.
range: [0...65535] This element is always shown.
version <SignedInteger> version number associated with the profile.
This element is always shown.
auth-type <PPPoE::pppProfileAuthenType> specifies the type of PPP authentication used.
Possible values are : This element is always shown.
- 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
keep-alive-intvl <PPPoE::ProfileKeepAliveInterval> keep alive time, after the request packet is sent.
range: [0...65535] unit: sec This element is always shown.
Command Description
This command shows the ppp data per ip-address.
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppoe ip-address (remote-ip-addr)
Command Parameters
Table 46.9-1 "Ip-address Related PPP Status Command" Resource Parameters
Resource Identifier Type Description
(remote-ip-addr) <Ip::V4Address> IP address of the user who established the PPPoE
session.
Command Output
Table 46.9-2 "Ip-address Related PPP Status Command" Display parameters
Specific Information
name Type Description
session <Eqpt::Rack> / <Eqpt::Shelf> / the identification of a pppoe session
<Eqpt::LtSlot> / <Eqpt::Port> : This element is always shown.
<Atm::vpi> : <Atm::vci> :
<PPPoE::LogicalSesId>
state <PPPoE::pppIfState> current PPP state of the session.
Possible values are : This element is always shown.
- 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 <PrintableString> username (along with the domain name) who
established the PPPoE session.
This element is always shown.
Command Description
This command shows the ppp data per mac-address.
User Level
The command can be accessed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> show pppoe mac-address (remote-mac)
Command Parameters
Table 46.10-1 "Mac-address Related PPP Status Command" Resource Parameters
Resource Identifier Type Description
(remote-mac) <Vlan::MacAddr> The MAC address of the user who established the
length: 6 PPPoE session.
Command Output
Table 46.10-2 "Mac-address Related PPP Status Command" Display parameters
Specific Information
name Type Description
session <Eqpt::Rack> / <Eqpt::Shelf> / the identification of a PPPoE session
<Eqpt::LtSlot> / <Eqpt::Port> : This element is always shown.
<Atm::vpi> : <Atm::vci> :
<PPPoE::LogicalSesId>
user-name <PrintableString> username (along with the domain name) who
established the PPPoE session.
This element is always shown.
Command Description
This node allows the user to view 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 equip priviliges.
Command Syntax
The command has the following syntax:
> show interface alarm (interface-type)
Command Parameters
Table 47.1-1 "Interface Alarm Status Command" Resource Parameters
Resource Identifier Type Description
(interface-type) <Itf::AlarmItfType> type of the interface
Command Output
Table 47.1-2 "Interface Alarm Status Command" Display parameters
Specific Information
name Type Description
default-severity <Itf::asamIfExtAlmReportingSeverityDefault>
The default minimal severity for an alarm to be
Possible values are : reported that will be used for interfaces.
- indeterminate : not a definite known This element is always shown.
severity
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
Command Description
This node allows the user to view the summary of the phy interface i.e.number of changes occurred,bitmap for the
operational-status and bitmap for the presence of the physical interface
User Level
The command can be accessed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> show interface phy-itf-status (shelf)
Command Parameters
Table 47.2-1 "Physical Interface Status Command" Resource Parameters
Resource Identifier Type Description
(shelf) <Eqpt::Rack> / <Eqpt::Shelf> the physical position of the shelf
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]
Command Output
Table 47.2-2 "Physical Interface Status Command" Display parameters
Specific Information
name Type Description
no-of-change-occur <Counter> Number of state changes of physical lines,
equipped on boards within this shelf.
This element is always shown.
opr-status-bitmap <PrintableString> Operational status of the physical interfaces of
boards which can be equipped within this shelf.
This element is always shown.
bitmap-phy-itf <PrintableString> Specifies the presence of the physical interfaces of
boards which can be equipped within this shelf.
This element is always shown.
Command Description
This node allows the user to view all the parameters related to the interface like the type of interface,current
bandwidth of the interface,max size of the packet supported,connector-present etc
User Level
The command can be accessed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> show interface port (port)
Command Parameters
Table 47.3-1 "Interface Status Command" Resource Parameters
Resource Identifier Type Description
(port) xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> / the interface index
<Eqpt::LtSlot> / <Eqpt::Port> | slip :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> | ethernet : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::NtSlot> :
<Itf::EthernetId> | pppoeses :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vci> : <PPPoE::LogicalSesId> |
xdsl-channel : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> | atm-if : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> | atm-pvc : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> : <Atm::vpi> : <Atm::vci> |
bridge-port : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> : <Atm::vpi> : <Atm::vci> |
pppoe : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci> | l2-vlan :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Vlan::VlanIndex> | ip :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Ip::LogicalId> |
sw-loopback : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::NtSlot>
Command Output
Table 47.3-2 "Interface Status Command" Display parameters
Specific Information
name Type Description
if-index <SignedInteger> Specifies a unique value for each interface.
This element is always shown.
info <PrintableString> A textual string containing 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 always shown.
type <Itf::IANAifType> Specifies the type of interface.
Possible values are : This element is always shown.
- ethernet : ethernet csmacd
- sw-loopback : software loopback
interface
- slip : generic SLIP interface
- atm : atm interface
- 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
largest-pkt-size <Itf::packetSize> The size of the largest packet which can be
unit: octets sent/received on the interface, specified in octets.
For interfaces that are used for transmitting
network datagrams, this is the size of the largest
network datagram that can be sent on the interface.
This element is only shown in detail mode.
current-bandwidth <Itf::bandWidth> Specifies the interface's current bandwidth.
unit: bits/sec This element is only shown in detail mode.
phy-addr <PrintableString> The interface's address at its protocol sub-layer.
This element is always shown.
admin-status <Itf::ifAdminStatus> Specifies state of the interface.
Possible values are : This element is always shown.
- not-applicable : not-applicable
- admin-up : admin status is up
- admin-down : admin status is down
- testing : no operational packets can be
passed
opr-status <Itf::ifOperStatus> The current operational state of the interface.
Possible values are : This element is always shown.
- up : permanent virtual circuit
- down : bridge port
- testing : l2 VLAN
- unknown : IPoE
- dormant : PPPoE
last-chg-opr-stat <TimeTicks> The value of system up time at the time the
unit: msec interface entered its current operational state. If the
current state was entered prior to the last
re-initialization of the local network management
subsystem, then this contains a zero value.
Command Description
This node allows the user to view the parameters related to the testing of an interface
User Level
The command can be accessed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> show interface test (port)
Command Parameters
Table 47.4-1 "Interface Test Status Command" Resource Parameters
Resource Identifier Type Description
(port) xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/3/0..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port> | slip :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> | ethernet : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::NtSlot> :
<Itf::EthernetId> | pppoeses :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vci> : <PPPoE::LogicalSesId> |
xdsl-channel : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> | atm-if : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> | atm-pvc : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> : <Atm::vpi> : <Atm::vci> |
bridge-port : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> : <Atm::vpi> : <Atm::vci> |
pppoe : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci> | l2-vlan :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Vlan::VlanIndex> | ip :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Ip::LogicalId> |
sw-loopback : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::NtSlot>
Command Output
Table 47.4-2 "Interface Test Status Command" Display parameters
Specific Information
name Type Description
id <TestAndIncr> Specifies the current invocation of the interface's
range: [0...2147483647] test.
This element is always shown.
result <Itf::ifTestResult> Specifies the result of the most recently requested
Possible values are : test
- none : no tests have been requested since This element is always shown.
the last reset
- success : test successfully completed
- in-progress : test is still in progress
- not-supported : test is not supported
- unable-to-run : test is unable to run
- aborted : test is aborted
- failed : test is failed
code <Object> Specifies a code which contains more specific
information on the test result
This element is always shown.
Command Description
This node allows the user to view the status of the stack.
User Level
The command can be accessed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> show interface stack (higher) lower xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> | slip : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::NtSlot> |
ethernet : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::NtSlot> : <Itf::EthernetId> |
pppoeses : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot> / <Eqpt::Port> : <Atm::vpi> :
<Atm::vci> : <PPPoE::LogicalSesId> | no-interface | ip-gateway : <Vrf::VrfIndex> |
xdsl-channel : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot> / <Eqpt::Port> | atm-if :
<Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot> / <Eqpt::Port> | atm-pvc : <Eqpt::Rack>
/ <Eqpt::Shelf> / <Eqpt::LtSlot> / <Eqpt::Port> : <Atm::vpi> : <Atm::vci> |
bridge-port : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci> | pppoe : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> : <Atm::vpi> : <Atm::vci> | l2-vlan : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Vlan::VlanIndex> | ip : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Ip::LogicalId> | sw-loopback : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot>
Command Parameters
Table 47.5-1 "Interface Stack Status Command" Resource Parameters
Resource Identifier Type Description
(higher) xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> / a higher layer interface index
<Eqpt::LtSlot> / <Eqpt::Port> | slip :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> | ethernet : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::NtSlot> :
<Itf::EthernetId> | pppoeses :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci> :
<PPPoE::LogicalSesId> | no-interface |
ip-gateway : <Vrf::VrfIndex> |
xdsl-channel : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> | atm-if : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> | atm-pvc : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> : <Atm::vpi> : <Atm::vci> |
bridge-port : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> : <Atm::vpi> : <Atm::vci> |
pppoe : <Eqpt::Rack> / <Eqpt::Shelf> /
Command Description
This node allows the user to view the current operational state of an interface
User Level
The command can be accessed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> show interface shub vlan (vlan-id)
Command Parameters
Table 47.6-1 "SHub Interface Status Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) <Vlan::VlanIndex> vlan id
range: [1...4093]
Command Output
Table 47.6-2 "SHub Interface Status Command" Display parameters
Specific Information
name Type Description
admin-status <Shub::AdminStatus> The administrative state of the vlan interface.
Possible values are : This element is always shown.
- up : up
- down : down
- testing : testing
- auto-up : autoup
oper-status <Shub::OperStatus> The current operational state of the vlan interface.
Possible values are : This element is always shown.
- up : ready to pass packets
- down : down
- testing : in some test mode
- unknown : status can not be determined
forsome reason
- dormant : dormant
- not-present : some component is missing
- lower-layer-down : down due to state of
lower-layer interface
port <Qos::ShubInterfaceIndex> the local port.
range: [1...24] This element is only shown in detail mode.
Command Description
This node shows the port control status.
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show interface shub port (port)
Command Parameters
Table 47.7-1 "SHub Interface Port Control Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Shub::NetworkPort> control index of the port
range: [1...7]
Command Output
Table 47.7-2 "SHub Interface Port Control Status Command" Display parameters
Specific Information
name Type Description
admin-status <Shub::AdminStatus> Specifies the administrative status of the interface
Possible values are : This element is always shown.
- up : up
- down : down
- testing : testing
- auto-up : autoup
oper-status <Shub::AdminStatus> Specifies the operational status of the interface
Possible values are : This element is always shown.
- up : up
- down : down
- testing : testing
- auto-up : autoup
speed <Sys::Speed> Specifies the interface speed.
Possible values are : This element is always shown.
- ten-mbps : speed of 10MBPS
- hundred-mbps : speed of 100MBPS
- one-gb : speed of 1GB
type <Sys::Type> Specifies the type of port.
Possible values are : This element is always shown.
- user : port to a directly connected user
Command Description
This node allows the user to view the parametrs related to an interface like 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 equip priviliges.
Command Syntax
The command has the following syntax:
> show interface availability (port-type)
Command Parameters
Table 47.8-1 "Interface Extensive Status Command" Resource Parameters
Resource Identifier Type Description
(port-type) <Itf::AvailablePortType> the port type
Command Output
Table 47.8-2 "Interface Extensive Status Command" Display parameters
Common Information
name Type Description
change-count <Counter> Number of state changes of the physical line.
This element is always shown.
interface-cnt <SignedInteger> The number of network interfaces (regardless of
their current state) present on this system.
This element is always shown.
Specific Information
name Type Description
next-available xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> / Specifies the next available physical interface can
<Eqpt::LtSlot> / <Eqpt::Port> | none be retrieved.
This element is always shown.
Only Show Details: common
name Type Description
change-count <Counter> Number of state changes of the physical line.
This element is always shown.
interface-cnt <SignedInteger> The number of network interfaces (regardless of
their current state) present on this system.
This element is always shown.
Command Description
This node displays the information about the SNTP and its related parameters.
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show sntp
Command Output
Table 48.1-2 "SNTP Status Command" Display parameters
Specific Information
name Type Description
operating-mode <Sys::SNTPOperatingMode> specifies the operating mode for the SNTP
Possible values are : application at the SNMP agent.
- unicast : operating mode unicast value 1 This element is always shown.
- anycast : operating mode anycast value 2
- multicast : operating mode multicast
value 3
system-time <Sys::Time> specifies the network time.
This element is always shown.
shub-time <Sys::Time> specifies shub network time.
This element is always shown.
Command Description
This node shows the SHub IP parameters.
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show system shub entry ip
Command Output
Table 49.1-2 "SHub System IP Status Command" Display parameters
Specific Information
name Type Description
ip-addr-cfg-mode <Sys::DefIpAddr> Specifies the mode by which the default interface
Possible values are : in the device gets the IP address.
- manual : ip address got from the system This element is always shown.
- dynamic : ip address got through
dynamic IP address
def-ip-addr <Ip::V4Address> Specifies default IP Address of the system. and if
modified, will take effect only when the
configuration is stored and restored.
This element is always shown.
eff-ip-addr <Ip::V4Address> Specifies Effective IP address of the switch to be
used for contacting through SNMP interface or web
interface.
This element is always shown.
subnet-mask <Ip::V4Address> Specifies IP subnet mask for the default IP address
and if modified, will take effect only when the
configuration is stored and restored.
This element is always shown.
def-gateway <Ip::V4Address> Specifies default IP Address of the system and if
modified, will take effect only when the
configuration is stored and restored.
This element is always shown.
Command Description
This node shows the version of the SHub system parameters.
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show system shub entry version
Command Output
Table 49.2-2 "SHub System Version Status Command" Display parameters
Specific Information
name Type Description
sw-ver-name <Sys::FileName> Specifies the name of the shub software release.
length: 1<=x<256 This element is always shown.
sw-release-num <Sys::ReleaseNum> Specifies the software version number.
length: 1<=x<7 This element is always shown.
hw-ver <Sys::DisplayString> Specifies version number of the hardware.
length: 1<=x<15 This element is always shown.
fw-ver <Sys::DisplayString> Specifies version number of the firmware.
length: 1<=x<15 This element is always shown.
Command Description
This node shows the last changed time of the status of the SHub HTTP access.
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show system shub entry status
Command Output
Table 49.3-2 "SHub System HTTP Status Command" Display parameters
Specific Information
name Type Description
last-chg-status <PrintableString> Specifies whether last configuration change has
been saved in flash/remote and current status of
restore.
This element is always shown.
http-status <Sys::HttpStatus> Specifies whether http access for the users is
Possible values are : enabled or disabled.
- http-access : enable http access for the This element is always shown.
users
- no-http-access : disable http access for
the users
Command Description
This node shows the common system parameters of the SHub.
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show system shub entry misc
Command Output
Table 49.4-2 "SHub System Common Status Command" Display parameters
Specific Information
name Type Description
def-intf <Sys::DefInterface> Name of the default interface that can be used for
length: 1<=x<16 communicating with the system for configuration
through SNMP.
This element is always shown.
base-bdg-addr <Vlan::MacAddr> Specifies the MAC address used by the bridge
length: 6 when it must be referred to in a unique fashion.
This element is always shown.
sys-mac-addr <Vlan::MacAddr> Specifies the system MAC address used by this
length: 6 bridge when it must be referred to in a unique
fashion.
This element is always shown.
Command Description
This node displays the system control parameters.
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show system shub config-control (ctrl-index)
Command Parameters
Table 49.5-1 "SHub System Control Status Command" Resource Parameters
Resource Identifier Type Description
(ctrl-index) <Shub::NetworkPort> control index of the config
range: [1...7]
Command Output
Table 49.5-2 "SHub System Control Status Command" Display parameters
Specific Information
name Type Description
egress <Sys::EgressStatus> Specifies the transmission of egress traffic over this
Possible values are : interface is enabled or not.
- egress-enabled : enable this status This element is always shown.
- egress-disabled : disable this status
collection <Sys::CollectionStatus> Specifies the statistics collection for this interface is
Possible values are : enabled or not.
- collection : enable the collection of This element is always shown.
statistics
- no-collection : disable the collection of
statistics
ctrl-status <Sys::ConfigCtrlStatus> Specifies the config control status.
Possible values are : This element is always shown.
- enable : makes the entry valid
- disable : makes the entry invalid
Command Description
This node displays IP filter related information.
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show system shub filters ip (index-num)
Command Parameters
Table 49.6-1 "SHub IP Filter Status Command" Resource Parameters
Resource Identifier Type Description
(index-num) <Sys::Number> L3 Filter rule number
range: [1...65535]
Command Output
Table 49.6-2 "SHub IP Filter Status Command" Display parameters
Specific Information
name Type Description
priority <Sys::Priority> Specifies the priority of the filter which is used to
range: [1...65535] decide which filter rule is applicable when the
packet matches with more than one filter rules or
all the filter rules result in 'allow'ing the packet
This element is always shown.
protocol <Sys::Protocol> Specifies the type of protocol to be checked against
Possible values are : the packet.
- icmp : check the packet for icmp This element is always shown.
- igmp : check the packet for igmp
- ggp : check the packet for ggp
- ip : check the packet for ip
- tcp : check the packet for tcp
- egp : check the packet for egp
- igp : check the packet for igp
- nvp : check the packet for nvp
- udp : check the packet for udp
- irtp : check the packet for irtp
- idrp : check the packet for idrp
- rsvp : check the packet for rsvp
- msrp : check the packet for msrp
Command Description
This node displays the manager parameters.
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show system shub filters shub-manager (index)
Command Parameters
Table 49.7-1 "SHub System Manager Status Command" Resource Parameters
Resource Identifier Type Description
(index) <Sys::SrcIpIndex> index number of the SrcIp
range: [1...100]
Command Output
Table 49.7-2 "SHub System Manager Status Command" Display parameters
Specific Information
name Type Description
src-ip-addr <Ip::V4Address> Specifies the management vlan filter IP address to
be matched with the packet.
This element is always shown.
Command Description
This node displays the status of the copy file command in the SHub.
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show system shub copy-file
Command Output
Table 49.8-2 "SHub Copy File Status Command" Display parameters
Specific Information
name Type Description
copy-src-ip <Ip::V4Address> The Ip Address of machine from where the file has
to be copied
This element is always shown.
copy-src-filename <Sys::FileName> The file name which is to be copied from the
length: 1<=x<256 source
This element is always shown.
copy-dst-ip <Ip::V4Address> The Ip Address of machine to where the file has to
be copied
This element is always shown.
copy-dst-filename <Sys::FileName> The file name which is to be copied has a
length: 1<=x<256 destination
This element is always shown.
initiate-copy <Sys::InitiateValue> Initiates the copy operation from source to
destination.
This element is always shown.
Command Description
This node displays the contents of the shub flash file system.
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show system shub list-file (file-index)
Command Parameters
Table 49.9-1 "List the contents of the SHub Flash" Resource Parameters
Resource Identifier Type Description
(file-index) <SignedInteger> file index of the file
Command Output
Table 49.9-2 "List the contents of the SHub Flash" Display parameters
Specific Information
name Type Description
name <Sys::FileName> the file name
length: 1<=x<256 This element is always shown.
attributes <PrintableString> the file attributes
This element is always shown.
size <SignedInteger> the file size
This element is always shown.
last-modified <PrintableString> file last modified time
This element is always shown.
Command Description
This node displays the status of the file operation on the SHub flash file system.
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show system shub status-del
Command Output
Table 49.10-2 "Status of the file opration command of the SHub Flash" Display parameters
Specific Information
name Type Description
file-del-status <Sys::FlashDelStatus> Specifies the status of the previous flash file
Possible values are : operation.
- ok : flash file delete operation successful This element is only shown in detail mode.
- failed : flash file delete operation failed
Command Description
Status of the list command
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show system shub status-list
Command Output
Table 49.11-2 "Flash List command status" Display parameters
Specific Information
name Type Description
status-list <Sys::FlashListStatus> Specifies the status of the list file operation.
Possible values are : This element is only shown in detail mode.
- ok : flash file list operation successful
- failed : flash file list operation failed
Command Description
The counter depicts the number of software licenses for the 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 onfiguration and supported by the LT board and for which the XDSL board is
equipped.
READSL2 operational mode (US mode 1 and/or US mode2) 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 priviliges.
Command Syntax
The command has the following syntax:
> show system license (feature)
Command Parameters
Table 49.12-1 "Show System Licenses" Resource Parameters
Resource Identifier Type Description
(feature) <Sys::LicenseFeatureIndex> table index
Possible values are :
- adsl2-plus : number of xdsl lines for
which ADSL2 is enabled
- readsl2 : number of xdsl lines for which
READSL2 is enabled
- igmp : number of DSL subscribers
configured for IGMP
- ip-forward : number of DSL subscribers
configured for Ip-forwarding
- pppox-relay : number of DSL subscribers
configured for PPPOX relay
- pppox-termination : number of DSL
subscribers configured for PPPOX
termination
Command Output
Table 49.12-2 "Show System Licenses" Display parameters
Common Information
name Type Description
routing-licence <Sys::RoutingLicStatus> shows the status of the routing license.
Possible values are : This element is always shown.
- not-active : routing license unavailable
- active : routing license available
Specific Information
name Type Description
number-license <SignedInteger> Specifies number of license.
This element is always shown.
Only Show Details: routing-licence
name Type Description
routing-licence <Sys::RoutingLicStatus> shows the status of the routing license.
Possible values are : This element is always shown.
- not-active : routing license unavailable
- active : routing license available
Command Description
This node displays the transaction set log parameters.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show transaction set-log-table (log-table-index)
Command Parameters
Table 50.1-1 "Transaction Log Status Command" Resource Parameters
Resource Identifier Type Description
(log-table-index) <SignedInteger> the key in the set Log table
Command Output
Table 50.1-2 "Transaction Log Status Command" Display parameters
Specific Information
name Type Description
log-ipaddr <Ip::V4Address> IP address of the Manager who changed this object
This element is always shown.
changed-object-id <Object> the Object Identifier of an object which has been
changed.
This element is always shown.
Command Description
show transaction log-entry related parameters.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show transaction log-entry
Command Output
Table 50.2-2 "Transaction Log Entry Status Command" Display parameters
Specific Information
name Type Description
set-log-lastentry <SignedInteger> index of the last entry that has been added to the set
log table.
This element is always shown.
set-log-resettime <Sys::Time> time when set log has been reset
unit: UTC This element is always shown.
set-log-overflowed <Trans::overflowed> specifies whether the set log buffer is overflowed
Possible values are : or not.
- not-overflowed : log buffer not This element is always shown.
overflowed is 1
- overflowed : log buffer overflowed is 2
set-log-buffersize <SignedInteger> the size of the internal set log buffer.
This element is always shown.
nbr-of-sets <SignedInteger> nbr of successfull sets since systme is up.
This element is always shown.
Command Description
This command displays the error log status.
User Level
The command can be accessed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> show error (id)
Command Parameters
Table 51.1-1 "Error Log Status Command" Resource Parameters
Resource Identifier Type Description
(id) <SignedInteger> error number
Command Output
Table 51.1-2 "Error Log Status Command" Display parameters
Common Information
name Type Description
last-entry <Error::ErrLogLastEntry> index of the last entry that is added to the error log
table.
This element is always shown.
reset-time <Sys::Time> time value when the error log is resetted
unit: UTC This element is always shown.
buffer-size <SignedInteger> size of the internal log buffer.
This element is always shown.
overflowed <Error::LogOverFlow> specifies whether log buffer is overflowed or not.
Possible values are : This element is always shown.
- no : when log buffer is reset
- yes : full action set to warp around
Specific Information
name Type Description
timestamp <Sys::Time> network time when the error is generated.
unit: UTC This element is always shown.
originator <SignedInteger> @ <Ip::V4Address> request-id and IP address that generated the error
This element is only shown in detail mode.
description <Description-127> description of the error.
length: x<127 This element is always shown.
info <PrintableString> additional information to guide to correct the error
This element is only shown in detail mode.
Command Description
This commands displays the various parameters of the database.
User Level
The command can be accessed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> show software-mngt database (db-container) oswp-number <SwMngt::DbmOswpIndex>
Command Parameters
Table 52.1-1 "Database Status Command" Resource Parameters
Resource Identifier Type Description
(db-container) <SwMngt::dbmDatabaseIndex> the database container ID
Possible values are :
- first : first container
- second : second container
- third : third container
oswp-number <SwMngt::DbmOswpIndex> index in the database table
range: [1...2]
Command Output
Table 52.1-2 "Database Status Command" Display parameters
Specific Information
name Type Description
name <PrintableString-0-32> A string representing the database. The value
length: x<32 'NO-NAME' will be used by the system for the
default databases.
This element is always shown.
oper-status <SwMngt::dBaseOperStatus> The operational status of the database.
Possible values are : This element is always shown.
- actual : actual oper status
- preferable : preferable oper status
- previous : previous oper status
- failed : failed oper status
- not-useful : not useful oper status
version <PrintableString-0-32> The version of the database.
length: x<32 This element is always shown.
Command Description
This command displays the values of the various attributes of SWM disk file.
User Level
The command can be accessed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> show software-mngt descriptor-files (index)
Command Parameters
Table 52.2-1 "Disk Status Command" Resource Parameters
Resource Identifier Type Description
(index) <SwMngt::oswpName> index to the swm disk file table
range: [a-zA-Z0-9-_.-/]
Command Output
Table 52.2-2 "Disk Status Command" Display parameters
Specific Information
name Type Description
type <SwMngt::diskFileType> Specifies the type of the file.
Possible values are : This element is always shown.
- overall-descriptor : over all descriptor
file
- descriptor : descriptor file
- file-type-a : file type a
- file-type-b : file type b
- not-specified : file type not specified
file-size <SwMngt::DiskFileSize> Specifies the size of the file.
unit: bytes This element is always shown.
Command Description
The user can display various states and attributes of the OSWP using this show command.
User Level
The command can be accessed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> show software-mngt oswp (index)
Command Parameters
Table 52.3-1 "Overall Software Package Status Command" Resource Parameters
Resource Identifier Type Description
(index) <SwMngt::swmOswpIdx> index to the swm oswp table
range: [1...2]
Command Output
Table 52.3-2 "Overall Software Package Status Command" Display parameters
Specific Information
name Type Description
name <PrintableString-0-32> Name of the OSWP. The name of an OSWP
length: x<32 corresponds to the path name:
/path_to_OSWP/file_name.
This element is always shown.
availability <SwMngt::operAvailStatus> Specifies the availability status of the OSWP.
Possible values are : This element is always shown.
- empty : no OSWP is related to
asamSwmOswpIndex
- enabled : related OSWP is active
- disabled : download of related OSWP
failed
- downloading : download of related
OSWP is ongoing
- aborting : not related to OSWP files are
removed
act-status <SwMngt::operActStatus> Specifies the related OSWP is currently active or
Possible values are : not.
- active : related OSWP is active This element is always shown.
- not-active : related OSWP is not active
commit-status <SwMngt::operCommitStatus> Specifies the OSWP is committed or uncommitted
Command Description
This command shows the parameters of the Dynamic SWP table, which represents 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 sw priviliges.
Command Syntax
The command has the following syntax:
> show software-mngt swp (name)
Command Parameters
Table 52.4-1 "Software Package Status Command" Resource Parameters
Resource Identifier Type Description
(name) <PrintableString-0-32> index to the swm-swp table
length: x<32
Command Output
Table 52.4-2 "Software Package Status Command" Display parameters
Specific Information
name Type Description
type <SwMngt::swmSwpType> Specifies the type of the software package.
Possible values are : This element is always shown.
- asam-core : asam core
- vdsl-gateway : vdsl gateway
- ip-server : ip server
dbase-ver-no <PrintableString-0-32> Specifies the version number of the database that is
length: x<32 compatible with the software package.
This element is always shown.
primary-file-id <Ip::V4Address> Specifies the IP address of the TFTP server where
the software package can be found.
This element is always shown.
secondary-file-id <Ip::V4Address> Specifies the IP address of a possible second TFTP
server where the software package can be found.
This element is always shown.
Command Description
This command displays information on the relationships between the files known by the system and the available
OSWPs.
User Level
The command can be accessed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> show software-mngt swp-disk-file (name) file-name <PrintableString-0-32>
file-board-type <PrintableString-0-32>
Command Parameters
Table 52.5-1 "File Status Command" Resource Parameters
Resource Identifier Type Description
(name) <PrintableString-0-32> index to the Swm_Contains_File table
length: x<32
file-name <PrintableString-0-32> index to the Swm_Contains_File table
length: x<32
file-board-type <PrintableString-0-32> index to the Swm_Contains_File table
length: x<32
Command Output
Table 52.5-2 "File Status Command" Display parameters
Specific Information
name Type Description
file-format <SwMngt::fileFormat> Specifies the format of the file.
Possible values are : This element is always shown.
- tar : file format is tar
- lz77 : file format is lz77
- ascii : file format is ascii
- exe : file format is exe
available-status <SwMngt::availableStatus> Specifies whether the file is available on the file
Possible values are : disk or not.
- available : the file is avilable This element is always shown.
- not-available : the file is not avilable
file-priority <SwMngt::filePriority> Specifies whether the file belongs to the minimum
Possible values are : set of the related OSWPs.
- part-min-set : part min set This element is only shown in detail mode.
- no-part-min-set : no part min set
file-size <SwMngt::SwmFileSize> Specifies the size of the file.
Command Description
shows upload download parameters.
User Level
The command can be accessed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> show software-mngt upload-download
Command Output
Table 52.6-2 "Upload/Download Status Command" Display parameters
Specific Information
name Type Description
disk-space <SwMngt::TotalSpaceOnDisk> The total space on the file disk that is reserved for
unit: bytes the storage of files.
This element is always shown.
free-space <SwMngt::FreeSpaceOnDisk> Specifies the space on the file disk that is still
unit: bytes available for the storage of files.
This element is always shown.
download-progress <SwMngt::downloadProgress> Specifies the current status of the database
Possible values are : download process.
- download-ongoing : download ongoing This element is always shown.
- download-success : download finished
and successfull
- download-fail : download finished but
failed
download-error <SwMngt::downloadError> Specifies the reason in case of a database download
Possible values are : failure.
- not-defined : not defined This element is always shown.
- file-not-found : file is not found
- access-violation : access violation
- diskfull-alloc-exced : disk is full
- illegal-tftp-operation : illegal TFTP
operation
- unknown-transfer-id : transfer id is
unknown
- file-exists : file is already existing
- no-such-user : no such user
- corrupted-database :
corrupted/incompleted database
- system-restart : system restart
- no-error : no error in download
Command Description
This node shows the status of software management on the SHub.
User Level
The command can be accessed by operators with sw priviliges, and executed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> show software-mngt shub
Command Output
Table 52.7-2 "SHub Software Management Status Command" Display parameters
Specific Information
name Type Description
db-save-status <Sys::SaveStatus> the status of the database save operation
Possible values are : This element is always shown.
- inprogress : operation in progress
- successful : operation is successful
- failed : operation failed
db-remote-save-status <Sys::RemoteStatus> the status of the remote database save operation
Possible values are : This element is always shown.
- inprogress : operation in progress
- successful : operation is successful
- failed : operation failed
db-save-dest none | flash | remote : <Ip::V4Address> : the specification of the database save operation
<Sys::FileName> This element is only shown in detail mode.
sw-download-status <Sys::DownloadStatus> the status of the software download operation
Possible values are : This element is always shown.
- inprogress : operation in progress
- successful : operation is successful
- failed : operation failed
downloaded-sw <Ip::V4Address> : <Sys::FileName> the specification of the downloaded software
package
This element is only shown in detail mode.
copy-status <SwMngt::CopyOperationStatus> the status of the copy operation
Possible values are : This element is always shown.
- inprogress : copy status in progress
- successful : copy status successful
- failed : copy status failed
current-osp <SwMngt::CurrOSPVersion> the current osp version
Possible values are : This element is always shown.
- config-1 : sets config1 version in BSP
- config-2 : sets config2 version in BSP
Command Description
Show the system related parameter of IGMP.
User Level
The command can be accessed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> show igmp system
Command Output
Table 53.1-2 "IGMP System Status Command" Display parameters
Specific Information
name Type Description
startup-query-intvl <Igmp::SystemQueryInterval> The interval between general membership queries
range: [1...900] unit: sec sent on startup.
This element is always shown.
startup-query-count <Igmp::SystemStartupQueryCount> The number of queries sent out on startup separated
range: [1...10] by the query interval.
This element is always shown.
stats-intvl <Sys::Time> This statistics indicates the network time of when
the system-wide statistics were last reset.
This element is always shown.
src-ipaddr <Ip::V4Address> This object specifies the source IP address which is
contained in every multicast IP datagrams
transmitted on all IGMP control channels.
This element is always shown.
router-present-timeout <SignedInteger> When the system acts as host on 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 <SignedInteger> The interval that must pass before the system
decides there are no more members of a group on a
network.
This element is always shown.
Command Description
show the channel source of IGMP.
User Level
The command can be accessed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> show igmp channel counter (port)
Command Parameters
Table 53.2-1 "IGMP Channel Sources Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port:vpi:vci
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 53.2-2 "IGMP Channel Sources Status Command" Display parameters
Specific Information
name Type Description
noperm-join <Counter> Indicates the number of times that a permission
bitmap failure has occurred.
This element is always shown.
bitrate-fail <Counter> Indicates the number of times that an IGMP join
message failed to trigger a multicast connection
because the resultant bandwidth would exceed the
maximum total bitrate allowed.
This element is always shown.
inval-classd <Counter> Indicates the number of times that the IP address is
not a multicast address, or it is a reserved multicast
address, or it isn't in Multicast Source Table, but its
low-order 23 bits are same as those of a group IP
address in multicast source table
This element is only shown in detail mode.
numsec-ovld-protappl <Counter> Indicates the number of one second intervals for
which overload protection has been applied
because the message rate exceeded the peak
threshold
This element is only shown in detail mode.
Command Description
show the channel source of IGMP.
User Level
The command can be accessed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> show igmp channel miscellaneous (port)
Command Parameters
Table 53.3-1 "IGMP Channel Miscellaneous Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port:vpi:vci
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 53.3-2 "IGMP Channel Miscellaneous Status Command" Display parameters
Specific Information
name Type Description
curr-num-group <Gauge> Indicates the current group number in this port
This element is always shown.
max-msg-rate <Igmp::ChannelMaxMsgRate> Indicates the maximum messages per second that
range: [0...65535] unit: msgs/sec can be received by the IGMP protocol stack.
This element is always shown.
Command Description
Show the multicast related parameters.
User Level
The command can be accessed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> show igmp module-mcast-src (slot) mcast-addr <MulticastAddress>
Command Parameters
Table 53.4-1 "IGMP Multicast Sources Statistics" Resource Parameters
Resource Identifier Type Description
(slot) <Eqpt::Rack> / <Eqpt::Shelf> / identifies an IGMP module by the logical SlotId
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
mcast-addr <MulticastAddress> mcast src address in network-byte
order(big-endian)
Command Output
Table 53.4-2 "IGMP Multicast Sources Statistics" Display parameters
Specific Information
name Type Description
peak-nbr-subs-channels <Counter> The peak number of subscribed IGMP channels
short which have members connected to the source since
name:pk-nr-sub-chan the last statistics reset. It is only for those groups
configured in multicast source table.
This element is always shown.
peak-time <Sys::Time> The network time indicating when the peak number
of 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 <Gauge> Indicates the current number of subscribed IGMP
channels for the source.
This element is only shown in detail mode.
nbr-connect-fail <Counter> Indicates the number of times that an attempt to
short name:nr-con-fail create a multicast connection fails.
Command Description
Displayes the IGMP module counters.
User Level
The command can be accessed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> show igmp module counter (slot-index)
Command Parameters
Table 53.5-1 "IGMP Module Counter Status Commands" Resource Parameters
Resource Identifier Type Description
(slot-index) <Eqpt::Rack> / <Eqpt::Shelf> / identifies an IGMP module by the logical slot id
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
Command Output
Table 53.5-2 "IGMP Module Counter Status Commands" Display parameters
Specific Information
name Type Description
total-msg <Counter> The total number of messages received from users,
including IGMP messages and invalid messages.
This element is always shown.
total-igmp-msg <Counter> The total number of IGMP messages, which
includes join and leave requests from users, (both
successful and unsuccessful).
This element is always shown.
total-req <Counter> The total number of join requests from users, which
includes successful and unsuccessful attempts.
This element is always shown.
success-req <Counter> The total number of successful join requests from
users which includes new joins (which make a new
connection) and re-joins (which already have a
connection).
This element is always shown.
unsuccess-req <Counter> The total number of unsuccessful new join requests
from users. The failures could be due to the
Command Description
This command show the IGMP Module's Time related parameters.
User Level
The command can be accessed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> show igmp module time (slot-index)
Command Parameters
Table 53.6-1 "IGMP Module Time Status Command" Resource Parameters
Resource Identifier Type Description
(slot-index) <Eqpt::Rack> / <Eqpt::Shelf> / identifies an IGMP module by the logical slot id
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
Command Output
Table 53.6-2 "IGMP Module Time Status Command" Display parameters
Specific Information
name Type Description
peak-connects <Sys::Time> This statistic is the network time indicating when
the peak number of connects performed per second
occurred.
This element is always shown.
peak-disconnects <Sys::Time> The network time of when the peak number of
disconnects to users performed per second
occurred.
This element is always shown.
peak-msg <Sys::Time> The network time of when the peak number of
messages received from users per second occurred.
This element is always shown.
stats-intval <Sys::Time> The network time, when the module-wide statistics
were last reset.
This element is only shown in detail mode.
Command Description
Displayes the IGMP module parameters.
User Level
The command can be accessed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> show igmp module miscellaneous (slot-index)
Command Parameters
Table 53.7-1 "IGMP Module Misc Status Command" Resource Parameters
Resource Identifier Type Description
(slot-index) <Eqpt::Rack> / <Eqpt::Shelf> / identifies an IGMP module by the logical slot id
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
Command Output
Table 53.7-2 "IGMP Module Misc Status Command" Display parameters
Specific Information
name Type Description
curr-root-conn <Gauge> The number of the connected groups.
This element is always shown.
con-cfgd <Gauge> The number of the connected groups who are
configured in multicast source table.
This element is always shown.
con-un-cfgd <Gauge> The number of the connected groups who aren't
configured in multicast source table.
This element is always shown.
con-no-memb <Gauge> The number of the connected groups who is in
reserve state(no member).
This element is always shown.
Command Description
Displayes the status of the IGMP VLAN router ports.
User Level
The command can be accessed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> show igmp shub vlan-router-port (vlan-id) network-port <Shub::NetworkPort>
Command Parameters
Table 53.8-1 "SHub IGMP Vlan Router Port Status Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) <Vlan::VlanId> the id of a vlan for which a network port is
range: [1...4093] reachable
network-port <Shub::NetworkPort> the network port that is reachable
range: [1...7]
Command Output
Table 53.8-2 "SHub IGMP Vlan Router Port Status Command" Display parameters
Specific Information
name Type Description
query-timer <Igmp::VlanRouterQueryTimer> time interval to wait for query packet
range: [60...600] This element is always shown.
config-status <Vlan::VlanRouterConfigStatus> status of the router port
Possible values are : This element is always shown.
- static : static group entry
- dynamic : dynamic entry
- static-dynamic : static dynamic entry
Command Description
The Icmp parameters gives a count of how many icmp messages, an entity receives. Errors determine the number of
icmp specific errors in the icmp messages, it gives the numbers of messages which did not reach the destination,
time exceeded messages, 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, 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 transp priviliges.
Command Syntax
The command has the following syntax:
> show transport icmp
Command Output
Table 54.1-2 "ICMP Status Command" Display parameters
Specific Information
name Type Description
rx-total-msgs <Counter> The total number of ICMP messages which the
entity received(includes errors also).
This element is always shown.
rx-err-msgs <Counter> The number of ICMP messages which the entity
received but determined as having ICMP-specific
errors.
This element is always shown.
rx-dest-unreach-msgs <Counter> The number of ICMP destination unreachable
messages received.
This element is always shown.
rx-time-exceed-msgs <Counter> The number of ICMP time exceeded messages
received.
This element is always shown.
rx-param-problem-msgs<Counter> The number of ICMP parameter problem messages
received.
This element is always shown.
rx-src-quench-msgs <Counter> The number of ICMP source quench messages
received.
This element is always shown.
rx-redirect-msgs <Counter> The number of ICMP Redirect messages received.
This element is always shown.
rx-echo-req-msgs <Counter> The number of ICMP echo (request) messages
received.
This element is always shown.
Command Description
The IP-address parameters holds the addressing information for one of this entity's IP addresses.
User Level
The command can be accessed by operators with transp priviliges.
Command Syntax
The command has the following syntax:
> show transport ip-address (address)
Command Parameters
Table 54.2-1 "IP Address Status Command" Resource Parameters
Resource Identifier Type Description
(address) <Ip::V4Address> ip address where addressing information pertains
Command Output
Table 54.2-2 "IP Address Status Command" Display parameters
Specific Information
name Type Description
ifindex <SignedInteger> Uniquely identifies the interface to which this is
applicable.
This element is always shown.
subnet-mask <Ip::V4Address> The subnet mask associated with the IP address.
This element is always shown.
bcast-addr <SignedInteger> The broadcast address used for sending datagrams
on the (logical) interface associated with the IP
address
This element is only shown in detail mode.
reas-max-size <Transport::IpAdEntReasmMaxSize> The size of the largest IP datagram which this
range: [0...65535] entity can re-assemble from incoming IP
fragmented datagrams received on this interface.
This element is only shown in detail mode.
54.3 IP Statistics
Command Description
This node displays the IP statistics.
User Level
The command can be accessed by operators with transp priviliges.
Command Syntax
The command has the following syntax:
> show transport ip-parameters
Command Output
Table 54.3-2 "IP Statistics" Display parameters
Specific Information
name Type Description
rx-total-datagrams <Counter> The total number of input datagrams received from
interfaces, including those received in error.
This element is always shown.
in-hdr-err-data <Counter> The number of input datagrams 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 <Counter> The number of input datagrams 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 <Counter> The number of input datagrams 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 <Counter> The number of locally-addressed datagrams
received successfully but discarded because of an
unknown or unsupported protocol.
This element is always shown.
discard-in-data <Counter> The number of input IP datagrams for which no
problems were encountered to prevent their
continued processing, but which were discarded
(e.g., for lack of buffer space).
This element is always shown.
tot-deliv-in-data <Counter> The total number of input datagrams successfully
delivered to IP user-protocols (including ICMP).
Command Description
This node is displays the IP routing statistics.
User Level
The command can be accessed by operators with transp priviliges.
Command Syntax
The command has the following syntax:
> show transport ip-route (destination)
Command Parameters
Table 54.4-1 "IP Route Status Command" Resource Parameters
Resource Identifier Type Description
(destination) <Ip::V4Address> destination IP address of this route
Command Output
Table 54.4-2 "IP Route Status Command" Display parameters
Specific Information
name Type Description
routing-mechanism <Transport::ipRouteProto> The routing mechanism via which this route was
Possible values are : learned.
- other : entry is created via the BOOTP This element is always shown.
protocol
- local : manually configured
- netmgmt : entry is created via the SNMP
protocol
- icmp : obtained via ICMP
- egp : egp protocol
- ggp : ggp protocol
- hello : hello protocol
- rip : rip protocol
- is-is : is-is protocol
- es-is : es-is protocol
- cisco-igrp : ciscoIgrp protocol
- bbn-spf-igp : bbnSpfIgp protocol
- ospf : ospf protocol
- bgp : bgp protocol
info <SymbolicObject> A reference to MIB definitions specific to the
particular routing protocol which is responsible for
this route.
Command Description
Displays the status of net-to-media.
User Level
The command can be accessed by operators with transp priviliges, and executed by operators with transp
priviliges.
Command Syntax
The command has the following syntax:
> show transport ip-net-to-media (interface-name) network-addr <Ip::V4Address>
Command Parameters
Table 54.5-1 "IP Net-To-Media Status Command" Resource Parameters
Resource Identifier Type Description
(interface-name) <Transport::ifName> name of the interface
network-addr <Ip::V4Address> ip addr corresponding to media-dependent physical
addr
Command Output
Table 54.5-2 "IP Net-To-Media Status Command" Display parameters
Specific Information
name Type Description
phy-addr <Sys::MacAddr> media-dependent physical addr
length: 6 This element is always shown.
type <Transport::ipNetToMediaType> type of mapping
Possible values are : This element is always shown.
- other : none of the following
- invalid : invalidating the corresponding
entry
- dynamic : dynamic mapping
- static : static mapping
Command Description
This node displayes SNMP parameters.
User Level
The command can be accessed by operators with transp priviliges.
Command Syntax
The command has the following syntax:
> show transport snmp
Command Output
Table 54.6-2 "SNMP Status Command" Display parameters
Specific Information
name Type Description
in-pkts <Counter> The total number of messages delivered to the
SNMP entity from the transport service.
This element is always shown.
out-pkts <Counter> The total number of SNMP messages which were
passed from the SNMP protocol entity to the
transport service.
This element is always shown.
bad-version-pkts <Counter> The total number of unsupported SNMP version
messages which were delivered to the SNMP
protocol entity.
This element is always shown.
bad-commun-name-pkts<Counter> The total number of SNMP Messages delivered to
the SNMP protocol entity which used a SNMP
community name that are not known.
This element is always shown.
bad-commun-use-pkts <Counter> The total number of SNMP messages delivered to
the SNMP protocol entity which represented an
SNMP operation which was not allowed by the
SNMP community named in the message.
This element is always shown.
asn-ber-err-pkts <Counter> The total number of ASN.1 or BER errors
encountered by the SNMP protocol entity when
decoding received SNMP messages.
This element is always shown.
deliv-toobig-err-pdus <Counter> The total number of SNMP PDUs which were
delivered to the SNMP protocol entity with `tooBig'
error.
This element is always shown.
deliv-nosuchname-pdus <Counter> The total number of SNMP PDUs which were
Command Description
This node displays the system statistics.
User Level
The command can be accessed by operators with transp priviliges.
Command Syntax
The command has the following syntax:
> show transport system-parameters
Command Output
Table 54.7-2 "System Status Command" Display parameters
Specific Information
name Type Description
description <PrintableString-0-255> A textual description which include's the full name
length: x<255 and version identification of the system's hardware
type, software operating-system, and networking
software.
This element is always shown.
object-id <Object> The vendor's authoritative 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 <TimeTicks> The time since the network management portion of
unit: msec the system was last re-initialized.
This element is always shown.
services <Transport::SysServices> A value which indicates the set of services that this
range: [0...127] unit: milisec entity primarily offers.
This element is always shown.
Command Description
These parameters keep track of number of UDP datagrams delivered to the UDP user, also keeps track of number
of errors occurred. Implementation of the UDP group is mandatory for all systems which implement the UDP.
The total number of UDP datagrams delivered to UDP users is given by 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. 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. total-datagrams gives the total
number of UDP datagrams sent from this entity.
User Level
The command can be accessed by operators with transp priviliges.
Command Syntax
The command has the following syntax:
> show transport udp-parameters
Command Output
Table 54.8-2 "UDP Status Command" Display parameters
Specific Information
name Type Description
tot-deliv-data <Counter> The total number of UDP datagrams delivered to
UDP users.
This element is always shown.
rx-tot-no-port-data <Counter> The total number of received UDP datagrams for
which there was no application at the destination
port.
This element is always shown.
rx-err-datagrams <Counter> The number of received UDP 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 <Counter> The total number of UDP datagrams sent from this
entity.
This element is always shown.
Command Description
The UDP listener table 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 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 transp priviliges.
Command Syntax
The command has the following syntax:
> show transport udp (local-address) local-port <Transport::UdpLocalPort>
Command Parameters
Table 54.9-1 "UDP Listener Status Command" Resource Parameters
Resource Identifier Type Description
(local-address) <Ip::V4Address> local IP address for this UDP listener
local-port <Transport::UdpLocalPort> local port number for this UDP listener
range: [0...65535]
Command Description
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 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 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 ount 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 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 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 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 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 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 autonegotiation, or when autonegotiation is not enabled, the duplex mode
is controlled using Mau default type. When autonegotiation is supported and enabled, duplex mode is controlled
using if MAU auto negation advertised bits. In either case, the mandatoryly operating duplex mode is reflected both
in this object and in ifMauType.
User Level
The command can be accessed by operators with transp priviliges.
Command Syntax
The command has the following syntax:
> show transport ether-dot3 (stats-index)
Command Parameters
Table 54.10-1 "Ethernet Dot3 Status Command" Resource Parameters
Resource Identifier Type Description
(stats-index) <Eqpt::Rack> / <Eqpt::Shelf> / index of the interface to an ethernet-like medium
<Eqpt::NtSlot> : <Itf::EthernetId>
Command Output
Table 54.10-2 "Ethernet Dot3 Status Command" Display parameters
Specific Information
name Type Description
align-err <Counter> 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.
This element is always shown.
fcs-err <Counter> 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.
This element is always shown.
single-coll-frame <Counter> A count of successfully transmitted frames on a
particular interface for which transmission is
inhibited by exactly one collision.
This element is always shown.
multiple-coll-frame <Counter> A count of successfully transmitted frames on a
particular interface for which transmission is
inhibited by more than one collision.
This element is always shown.
deferred-trans <Counter> 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 element is only shown in detail mode.
late-coll <Counter> The number of times that a collision is detected on
a particular interface later than one slot Time into
the transmission of a packet.
This element is only shown in detail mode.
excessive-coll <Counter> A count of frames for which transmission on a
particular interface fails due to excessive collisions.
Command Description
shows the ether mau parameters.
User Level
The command can be accessed by operators with transp priviliges.
Command Syntax
The command has the following syntax:
> show transport ether-ifmau (if-index) index <Transport::Index>
Command Parameters
Table 54.11-1 "Interface MAU Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) <Transport::Index> interface to which the MAU is connected
range: [1...[0-9]+]
index <Transport::Index> identify MAU, among others connected to same
range: [1...[0-9]+] interface
Command Output
Table 54.11-2 "Interface MAU Status Command" Display parameters
Specific Information
name Type Description
type <Ether::MAUType> Specifies the MAU type. If the MAU type is
Possible values are : unknown, then unknown Mac type will be returned.
- 10baset : UTP MAU If the MAU is a link or fiber type then
- 100basetxhd : 2 pair cat. 5 UTP half media-available is equivalent to the link test fail
duplex state/low light function. For an AUI or a coax
- 100basetxfd : 2 pair cat. 5 UTP full (including broadband) MAU this indicates whether
duplex or not loopback is detected on the DI circuit. The
- 100basefxhd : X fiber over PMT half value of this attribute persists between packets for
duplex MAU types AUI, 10BASE5, 10BASE2,
- 100basefxfd : X fiber over PMT full 10BROAD36, and 10BASE-FP.
duplex This element is always shown.
- 1000basexhd : PCS/PMA,unknown
PMD, half duplex
- 1000basexfd : PCS/PMA,unknown
PMD, full duplex
- 1000baselxhd : fiber over
long-wavelength laser half duplex
- 1000baselxfd : fiber over
Command Description
Shows The Related Dot3 Collision Status For SHub.
User Level
The command can be accessed by operators with transp priviliges.
Command Syntax
The command has the following syntax:
> show transport shub dot3-coll (if-index) coll-count <Transport::CollisionCount>
Command Parameters
Table 54.12-1 "SHub Ethernet Dot3 Status Command" Resource Parameters
Resource Identifier Type Description
(if-index) <SignedInteger> index of the collision interface
coll-count <Transport::CollisionCount> count of per-frame media collisions
range: [0...16]
Command Output
Table 54.12-2 "SHub Ethernet Dot3 Status Command" Display parameters
Specific Information
name Type Description
frequencies <Counter> A count of individual MAC 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 shows 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 transp priviliges.
Command Syntax
The command has the following syntax:
> show transport shub dot3-control (stats-index)
Command Parameters
Table 54.13-1 "SHub Dot3 Control Status Command" Resource Parameters
Resource Identifier Type Description
(stats-index) <Shub::NetworkPort> index of the interface to an ethernet-like medium
range: [1...7]
Command Output
Table 54.13-2 "SHub Dot3 Control Status Command" Display parameters
Specific Information
name Type Description
functions-supported <PrintableString> A list of the possible MAC Control functions
implemented for this interface.
This element is always shown.
rx-unknown-opcodes <Counter> A count of MAC Control frames received on this
interface that contain an opcode that is not
supported by this device.
This element is always shown.
Command Description
This command shows the dot3 pause parameters
The stats-index gives a value that uniquely identifies an interface to an ethernet-like medium. The operator-mode
parameter reflects the PAUSE mode mandatoryly 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 parameter in-frames 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 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 transp priviliges.
Command Syntax
The command has the following syntax:
> show transport shub dot3-pause (stats-index)
Command Parameters
Table 54.14-1 "SHub Dot3 Pause Status Command" Resource Parameters
Resource Identifier Type Description
(stats-index) <Shub::NetworkPort> index of the interface to an ethernet-like medium
range: [1...7]
Command Output
Table 54.14-2 "SHub Dot3 Pause Status Command" Display parameters
Specific Information
name Type Description
operator-mode <Ether::Dot3PauseOperatorMode> specifies pause mode in use on this interface
Possible values are : This element is always shown.
- disabled : disabled
- enable-xmit : enabled only in transmit
direction
- enable-rcv : enabled only in receipt
- enable-xmit-rcv : enabled both transmit
and receipt
in-frames <Counter> A count of MAC control frames received on this
interface with an opcode indicating the pause
operation.
Command Description
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 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 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 ount 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 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 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 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 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 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 autonegotiation, or when autonegotiation is not enabled, the duplex mode
is controlled using Mau default type. When autonegotiation is supported and enabled, duplex mode is controlled
using MAU auto negotiation advertised bits. In either case, the mandatoryly operating duplex mode is reflected
User Level
The command can be accessed by operators with transp priviliges.
Command Syntax
The command has the following syntax:
> show transport shub dot3-status (stats-index)
Command Parameters
Table 54.15-1 "SHub Ethernet Dot3 Status Command" Resource Parameters
Resource Identifier Type Description
(stats-index) <Shub::NetworkPort> index of the interface to an ethernet-like medium
range: [1...7]
Command Output
Table 54.15-2 "SHub Ethernet Dot3 Status Command" Display parameters
Specific Information
name Type Description
align-err <Counter> A count of frames received on a 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 <Counter> A count of frames received on a particular interface
that has frame check error status is returned by the
MAC service to the LLC (or other MAC user).
This element is always shown.
single-coll-frame <Counter> A count of successfully transmitted frames on a
particular interface for which transmission is
inhibited by exactly one collision.
Command Description
This node shows the L2 filter information.
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show transport shub mac (index-num)
Command Parameters
Table 54.16-1 "SHub L2 Filter Status Command" Resource Parameters
Resource Identifier Type Description
(index-num) <Sys::Number> L2 Filter rule number
range: [1...65535]
Command Output
Table 54.16-2 "SHub L2 Filter Status Command" Display parameters
Specific Information
name Type Description
protocol-type <Sys::ProtocolType> Specifies the non IP protocol type to be filtered.
range: [0,1536...65535] This element is always shown.
dst-mac-addr <Vlan::MacAddr> Specifies the destination MAC address to be
length: 6 matched with the packet.
This element is always shown.
src-mac-addr <Vlan::MacAddr> Specifies the source MAC address to be matched
length: 6 with the packet.
This element is always shown.
vlan-id <Sys::VlanId> Specifies the vlan id to be filtered.
range: [1...4093] This element is always shown.
in-port-list <Shub::PortList> Specifies the complete set of ports over which if the
length: 3 packet arrives the filter rule will be applicable. If
the incoming port list is '0', the filter rule is
applicable for all the incoming ports.
This element is always shown.
action <Sys::L2Action> Specifies the action to be taken on the packet.
Possible values are : This element is always shown.
- action-allow : the packet will be
forwarded
- action-drop : the packet will be discarded
Command Description
This node shows SHub rate information.
User Level
The command can be accessed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> show transport shub rate (port)
Command Parameters
Table 54.17-1 "SHub Rate Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Shub::NetworkPort> port for which the rate parameters are displayed
range: [1...7]
Command Output
Table 54.17-2 "SHub Rate Status Command" Display parameters
Specific Information
name Type Description
dlf-limit <Sys::DlfStatus> Specifies destination lookup failure packet
Possible values are : transmission control over the interface is enabled or
- lookup-enabled : enable this status not.
- lookup-disabled : disable this status This element is always shown.
bcast-limit <Sys::BcastStatus> Specifies broadcast packet transmission control
Possible values are : over the interface is enabled or not.
- bcast-pkt-enabled : enable this status This element is always shown.
- bcast-pkt-disabled : disable this status
mcast-limit <Sys::McastStatus> Specifies multicast packet transmission control
Possible values are : over the interface is enabled or not.
- mcast-pkt-enabled : enable this status This element is always shown.
- mcast-pkt-disabled : disable this status
max-nbr-pkts <Sys::Number> Specifies the maximum number of packets that can
range: [1...65535] be transmitted over this interface.
This element is always shown.
validity <Sys::RateCtrlStatus> Specifies whether this entry is valid or not.
Possible values are : This element is always shown.
- valid : status is valid
- invalid : status is invalid
Command Description
Allows the operator to view the DHCP relay port counters.
User Level
The command can be accessed by operators with dhcp priviliges.
Command Syntax
The command has the following syntax:
> show dhcp-relay port (port-interface)
Command Parameters
Table 55.1-1 "DHCP Relay Port Statistics" Resource Parameters
Resource Identifier Type Description
(port-interface) <Eqpt::Rack> / <Eqpt::Shelf> / port number associated with bridge port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 55.1-2 "DHCP Relay Port Statistics" Display parameters
Specific Information
name Type Description
receive <Counter> number of upstream dhcp packets
This element is always shown.
transmit <Counter> number of downstream dhcp messages
This element is always shown.
large-msg-drop <Counter> number of discarded upstream dhcp packets
This element is only shown in detail mode.
untrust-agent-drop <Counter> number of discarded upstream dhcp packets
untrusted
This element is only shown in detail mode.
untrust-option-82 <Counter> nbr of discarded dhcp pkts with option 82 untrusted
This element is only shown in detail mode.
long-option-82 <Counter> nbr of discarded upstream dhcp pkts without option
82
This element is only shown in detail mode.
error-summary <Counter> Error summary for a port
This element is always shown.
Command Description
This commands displays the statistics of DHCP relay agent per VRF.
User Level
The command can be accessed by operators with dhcp priviliges.
Command Syntax
The command has the following syntax:
> show dhcp-relay shub vrf-agent-stats (vrf)
Command Parameters
Table 55.2-1 "DHCP Relay SHub Statistics" Resource Parameters
Resource Identifier Type Description
(vrf) <Vrf::ShubVrfID> vrf for which the agent is running
range: [0...127]
Command Output
Table 55.2-2 "DHCP Relay SHub Statistics" Display parameters
Specific Information
name Type Description
fwd-upstream <Counter> number of forwarded upstream dhcp packets
This element is always shown.
fwd-downstream <Counter> number of forwarded downstream dhcp packets
This element is always shown.
rx-upstream <Counter> number of received upstream dhcp packets
This element is always shown.
rx-downstream <Counter> number of received downstream dhcp packets
This element is always shown.
errors <Counter> number of erroneous dhcp packets discarded
This element is always shown.
Command Description
Show the Vlan List for the MAC multicast group.
User Level
The command can be accessed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> show mcast shub igs-vlan-grp (vlan-id) mcast-addr <Vlan::MacAddr>
Command Parameters
Table 56.1-1 "Multicast VLAN FWD Port Status Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) <Vlan::VlanId> vlan id
range: [1...4093]
mcast-addr <Vlan::MacAddr> multicast address
length: 6
Command Output
Table 56.1-2 "Multicast VLAN FWD Port Status Command" Display parameters
Specific Information
name Type Description
fwd-port-list <Shub::PortList> List of ports which are members for the MAC
length: 3 multicast group and the Vlan Id. BIT 1-16 (MSB)
1/1/4 - 1/1/19, BIT 18-24 network:1-7, BIT 17 NT
This element is always shown.
status <Vlan::VlanMcastConfigStatus> The status of the igs-vlan multicast group
Possible values are : This element is always shown.
- static : static group entry
- dynamic : dynamic entry
- static-dynamic : static dynamic entry
Command Description
This node shows the status of all sessions.
User Level
The command can be accessed and executed by an operator with admin privilige.
Command Syntax
The command has the following syntax:
> show session (id)
Command Parameters
Table 57.1-1 "Session Status Command" Resource Parameters
Resource Identifier Type Description
(id) <Sec::SessionId> the session number
range:
[1...(TelnetDaemon::maxTelnetSessions_c+CraftSessionManager::maxNumberOfCraftSessions_c)]
Command Output
Table 57.1-2 "Session Status Command" Display parameters
Specific Information
name Type Description
operator <Sec::OperatorName> the name of the operator that is actually using the
range: [a-z0-9]length: 1<=x<11 session
This element is always shown.
from <Sec::LoginAddress> the ip-address from where the user is logged in
length: x<21 This element is always shown.
type <Sec::TerminalType> the type of connection use. Network means that any
Possible values are : supported connection type over ip is possible.
- craft : craft terminal This element is always shown.
- telnet : telnet terminal
- network : network terminal
- virtual : virtual terminal
status <Sec::SessionStatus> the status of the session. Special values are :
Possible values are : initializing=session is not yet ready to be used,
- init : initialisation ongoing free=session is not used, selected=session is
- free : free reserved, stopping=the user is logging out,
- login : start login procedure invalid=the session is out-of-service
- name : asking the operator name This element is always shown.
- passwd : asking the password
- active : active
Command Description
This command shows the values of area identifier, spf-runs, number of link state advertisements in the link-state
database and the link-state-checksum.
This command also shows the number of border routers in the area, number of the AS border router, number of
OSPF interfaces in the area, total no of interfaces in the area, total no of networks in the area and number if NSSA
translator events in the area.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ospf area (area-id)
Command Parameters
Table 58.1-1 "OSPF Area Status Command" Resource Parameters
Resource Identifier Type Description
(area-id) <Ip::V4Address> ospf area identifier
Command Output
Table 58.1-2 "OSPF Area Status Command" Display parameters
Specific Information
name Type Description
spf-runs <Counter> nbr of times the intra-area route table has been
calculated
This element is always shown.
nbr-lsa <Gauge> nbr of lsa in this area's link-state database
This element is always shown.
lsa-checksum <SignedInteger> checksums contained in this area's link-state
database
This element is always shown.
area-bdr-rtrs <Gauge> nbr of area border routers in this area
This element is only shown in detail mode.
as-bdr-rtrs <Gauge> nbr of autonomous sys border routers in this area
This element is only shown in detail mode.
nbr-interfaces <Gauge> total number of Interfaces in the area
This element is only shown in detail mode.
nbr-area-nw <Gauge> total number of networks in the area
This element is only shown in detail mode.
nssa-events <Counter> nbr of translator state changes since the last boot-up
Command Description
This command shows the general information of OSPF Link State Advertisementsbased on the type of the interface.
User Level
The command can be accessed by operators with ip priviliges.
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 58.2-1 "OSPF LSA Status Command" Resource Parameters
Resource Identifier Type Description
(link-type) <Ospf::LinkType> filter for the ospf database
Possible values are :
- router : router link
- network : network link
- summary : summary link
- asbr-summary : assummary link
- nssa : nssa external link
area-id <Ip::V4Address> ospf area identifier
router-id <Ip::V4Address> originating router identifier
itf-ip-addr <Ip::V4Address> link state identifier
Command Output
Table 58.2-2 "OSPF LSA Status Command" Display parameters
Specific Information
name Type Description
age <Ospf::LsAge> age of the link state advertisement in seconds
range: [0...3600] unit: sec This element is always shown.
sequence <SignedInteger> identifies the old and recent advertisements
This element is only shown in detail mode.
checksum <SignedInteger> checksum of the complete contents of the
advertisement
This element is only shown in detail mode.
advertisement <Ospf::Advtsmnt> entire link state advertisement, including its header
length: 1<=x<65535 This element is only shown in detail mode.
Command Description
This command shows the values of the OSPF process's link state database.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ospf link-state-adv asbr-external (itf-ip-addr) router-id <Ip::V4Address>
Command Parameters
Table 58.3-1 "OSPF External Link State Status Command" Resource Parameters
Resource Identifier Type Description
(itf-ip-addr) <Ip::V4Address> external link state identifier
router-id <Ip::V4Address> originating router identifier, a 32 bit number
Command Output
Table 58.3-2 "OSPF External Link State Status Command" Display parameters
Specific Information
name Type Description
age <Ospf::LsAge> age of the link state advertisement in seconds
range: [0...3600] unit: sec This element is always shown.
sequence <SignedInteger> identifies the old and recent advertisements
This element is only shown in detail mode.
checksum <SignedInteger> checksum of the complete contents of the
advertisement
This element is only shown in detail mode.
advertisement <Ospf::ExtAdvtsmnt> entire link state advertisement, including its header
length: 1<=x<36 This element is only shown in detail mode.
Command Description
This command shows the values of the OSPF interface
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ospf interface (ip-addr)
Command Parameters
Table 58.4-1 "OSPF Interface Status Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) <Ip::V4Address> ip address of the interface
Command Output
Table 58.4-2 "OSPF Interface Status Command" Display parameters
Specific Information
name Type Description
oper-status <Ospf::OperStatus> operational status of the interface
Possible values are : This element is always shown.
- operup : operational status up
- operdown : operational status down
- loopback : operational status loopback
- unloop : operational status unloop
designated-router <Ip::V4Address> ip address of the designated router
This element is always shown.
bkp-designated-router <Ip::V4Address> ip address of the backup designated router
This element is only shown in detail mode.
events <Counter> nbr of times this OSPF interface has changed its
state
This element is only shown in detail mode.
nbr-neighbors <Gauge> total nbr of neighbour's through that Itf
This element is only shown in detail mode.
nbr-adjacencies <Gauge> total nbr of adjacencies through that Itf
This element is only shown in detail mode.
rx-hello <Counter> total nbr of Hello pkts received through that Itf
This element is only shown in detail mode.
tx-hello <Counter> total nbr of hello pkts transmitted through that Itf
This element is only shown in detail mode.
Command Description
This command shows the information of the neighbours.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ospf neighbour (ip-address)
Command Parameters
Table 58.5-1 "OSPF Neighbour Status Command" Resource Parameters
Resource Identifier Type Description
(ip-address) <Ip::V4Address> neighbour ip
Command Output
Table 58.5-2 "OSPF Neighbour Status Command" Display parameters
Specific Information
name Type Description
router-id <Ip::V4Address> a 32-bit integer identifying the neighboring router
This element is always shown.
state <Ospf::NbrState> state of the relationship with this neighbor
Possible values are : This element is always shown.
- down : down
- attempt : attempt
- init : init
- two-way : two-way
- exchange-start : exchange-start
- exchange : exchange
- loading : loading
- full : full
priority <Ospf::NbrPriority> priority of neighbor in designated router election
length: x<255 algorithm
This element is always shown.
retrans-q-len <Gauge> current length of the retransmission queue
This element is only shown in detail mode.
options <SignedInteger> bit mask corresponding to the neighbor
This element is only shown in detail mode.
events <Counter> nbr of times this neighbor has changed state
This element is only shown in detail mode.
Command Description
This command shows the imformation regarding a single route.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ospf routing-table (destination) mask <Ip::V4Address> peer <Ip::V4Address>
Command Parameters
Table 58.6-1 "OSPF Routing Status Command" Resource Parameters
Resource Identifier Type Description
(destination) <Ip::V4Address> ip address of the route
mask <Ip::V4Address> ip address mask of the route
peer <Ip::V4Address> ip next hop of the route
Command Output
Table 58.6-2 "OSPF Routing Status Command" Display parameters
Specific Information
name Type Description
interface <SignedInteger> interface index associated with the route
This element is always shown.
area-id <Ip::V4Address> area id associated with the route
This element is always shown.
metric <Ospf::RouteCost> type 1 metrics expressed in the same units as OSPF
length: x<16777215 itf cost
This element is always shown.
route-type <Ospf::RouteType> type of the route
Possible values are : This element is only shown in detail mode.
- intraarea : intraarea
- interarea : interarea
- type1-external : type1-external
- type2-external : type2-external
type2-metric <Ospf::RouteCost> routing between AS is the major cost of routing a
length: x<16777215 pkt
This element is only shown in detail mode.
Command Description
This command shows various statistic counts and external link-state advertisement counts
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ospf statistics
Command Output
Table 58.7-2 "OSPF Statistic" Display parameters
Specific Information
name Type Description
nbr-ext-lsa <Gauge> nbr of ext link-state advertisements in the link-state
database
This element is always shown.
tx-new-lsas <Counter> nbr of new link-state advertisements that have been
originated
This element is always shown.
rx-new-lsas <Counter> nbr of link-state advertisements received to be new
instantiations
This element is always shown.
tx-pkts <Counter> total no. of packets transmitted
This element is always shown.
rx-pkts <Counter> total no. of packets received
This element is always shown.
discard-pkts <Counter> total no. of packets discarded
This element is always shown.
Command Description
This command shows the OSPF parameter status.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show ospf status
Command Output
Table 58.8-2 "OSPF Parameter Status Command" Display parameters
Specific Information
name Type Description
router-id <Ip::V4Address> a 32-bit integer identifying the router in the
Autonomous Sys
This element is always shown.
version <Ospf::Version> current version number of the OSPF protocol is 2
This element is always shown.
area-bdr-rtr-stat <Ospf::AreaRtrStat> indicates whether the router is an area border router
Possible values are : This element is always shown.
- 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 <Ospf::AsRtrStat> indicates whether the router is an Autonomous Sys
Possible values are : border router
- as-bdr-rtr-stat : set as-bdr-rtr-stat value This element is always shown.
true
- no-as-bdr-rtr-stat : set as-bdr-rtr-stat
value false
ext-lsa-chcksm <SignedInteger> a 32-bit LS checksums of the external link-state
advertisements
This element is always shown.
overflow-state <Ospf::OvflwState> indicates the router overflow state
Possible values are : This element is always shown.
- overflow-state : set overflow-state value
true
- no-overflow-state : set overflow-state
value false
Command Description
This command shows the RIP interface status
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show rip statistics (ip-addr)
Command Parameters
Table 59.1-1 "RIP Statistics" Resource Parameters
Resource Identifier Type Description
(ip-addr) <Ip::V4Address> show statistics of a specific IP interface
Command Output
Table 59.1-2 "RIP Statistics" Display parameters
Specific Information
name Type Description
rx-bad-pkts <Counter> number of RIP response pkts which were discarded
This element is always shown.
rx-bad-routes <Counter> number of routes in valid RIP packets which were
ignored
This element is always shown.
updates-sent <Counter> number of triggered RIP updates sent on this
interface
This element is always shown.
Command Description
This command shows information regarding a single routing peer.
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show rip peer (peer-ip-addr)
Command Parameters
Table 59.2-1 "RIP Peer Status Command" Resource Parameters
Resource Identifier Type Description
(peer-ip-addr) <Ip::V4Address> IP identifying the remote peer
Command Output
Table 59.2-2 "RIP Peer Status Command" Display parameters
Specific Information
name Type Description
peer-version <SignedInteger> version number in the header of the last RIP packet
This element is always shown.
last-updt-rx <TimeTicks> most recent RIP update received from the system
unit: msec This element is always shown.
rx-bad-pkts <Counter> number of RIP response pkts discarded as invalid
This element is always shown.
rx-bad-routes <Counter> number of routes that were ignored
This element is always shown.
Command Description
This command shows list of routes in local routing table
User Level
The command can be accessed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> show rip routing-table
Command Output
Table 59.3-2 "RIP Routing Status Command" Display parameters
Specific Information
name Type Description
destination <Ip::V4Address> IP address of the destination network
This element is always shown.
mask <Ip::V4Address> mask for the destination network
This element is always shown.
peer <Ip::V4Address> nexthop address where datagrams are to be
forwarded
This element is always shown.
interface <SignedInteger> interface through which the route is learnt
This element is always shown.
metric <SignedInteger> reachability cost for the destination
This element is always shown.
gateway <Ip::V4Address> gateway address where datagrams are to be
forwarded
This element is always shown.
change-time <SignedInteger> time when the route is installed
This element is only shown in detail mode.
valid <SignedInteger> row status for particular route entry
This element is only shown in detail mode.
Command Description
This node shows information on operators.
User Level
The command can be accessed by operators with all,forAdmin priviliges, and executed by operators with all
priviliges.
Operators without security read or write permissions, can never see the information on other operators.
Command Syntax
The command has the following syntax:
> show security operator (name)
Command Parameters
Table 60.1-1 "Operator Information Status Command" Resource Parameters
Resource Identifier Type Description
(name) <Sec::OperatorName> the name of the operator
range: [a-z0-9]length: 1<=x<11
Command Output
Table 60.1-2 "Operator Information Status Command" Display parameters
Specific Information
name Type Description
last-login <Sys::Time> the time of the last successfull login
unit: UTC This element is always shown.
last-failed <Sys::Time> the time of the last unsuccessfull login attempt
unit: UTC This element is always shown.
failed-logins <UnsignedInteger> the number of unsuccessfull login attempts since
the last successfull login
This element is always shown.
last-passwd-change <Sys::Time> the time the password was changed for the last
unit: UTC time. It does not matter if the change was made by
this operator itself or by another operator.
This element is always shown.
Command Description
This command shows the domain status.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security aaa domain (name)
Command Parameters
Table 60.2-1 "Domain Status Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::DomainName> name of the domain
length: 6<=x<64
Command Output
Table 60.2-2 "Domain Status Command" Display parameters
Specific Information
name Type Description
active-sessions <Gauge> the number of active sessions
This element is always shown.
Command Description
This command shows the details of the user sessions.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security aaa user-session (index) user <Aaa::DisplayString> domain
<Aaa::DisplayString>
Command Parameters
Table 60.3-1 "User Sessions Status Command" Resource Parameters
Resource Identifier Type Description
(index) <SignedInteger> index to the domain user session table
user <Aaa::DisplayString> user name
length: 6<=x<64
domain <Aaa::DisplayString> domain name
length: 6<=x<64
Command Output
Table 60.3-2 "User Sessions Status Command" Display parameters
Specific Information
name Type Description
interface xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> / the interface on which the session is established.
<Eqpt::LtSlot> / <Eqpt::Port> | slip : This element is only shown in detail mode.
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> | ethernet : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::NtSlot> :
<Itf::EthernetId> | pppoeses :
<Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vci> : <PPPoE::LogicalSesId> |
xdsl-channel : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> | atm-if : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> | atm-pvc : <Eqpt::Rack> /
<Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> : <Atm::vpi> : <Atm::vci> |
bridge-port : <Eqpt::Rack> /
Command Description
This command gives the status of connection profiles.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security aaa conn-profile (name)
Command Parameters
Table 60.4-1 "Connection Profile Status Command" Resource Parameters
Resource Identifier Type Description
(name) <AsamProfileName> name of connection profile
range: [a-zA-Z0-9-_]length: 1<=x<32
Command Output
Table 60.4-2 "Connection Profile Status Command" Display parameters
Specific Information
name Type Description
number-of-users <AsamProfileRefCount> The number of entities using this profile. The
range: [0...65535] profile can only be deleted when this number is 0.
This element is always shown.
index <AsamProfileIndex> connection profile index
range: [1...65535] This element is always shown.
Command Description
This node is used for displaying the status of Local IP Address Pool Management.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security ip-addr-pool (name) vrf-index <Aaa::VrfIndex> ip-pool-status (ip-addr)
Command Parameters
Table 60.5-1 "Local IP Pool Status Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::IpPoolName> name of the IP pool
length: 1<=x<64
vrf-index <Aaa::VrfIndex> vrf associated with this pool
range: [0...255]
(ip-addr) <Ip::V4Address> ip pool address
Command Output
Table 60.5-2 "Local IP Pool Status Command" Display parameters
Specific Information
name Type Description
status <Aaa::IpPoolStatus> Specifies the status of the specified IP address
Possible values are : whether allocated or reserved(locally or remotely).
- allocated : This element is always shown.
- locally-reserved :
- remotely-reserved :
Command Description
This node displays the IP address pool parameters.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security ip-addr-pool (name) vrf-index <Aaa::VrfIndex> number-addr
Command Parameters
Table 60.6-1 "IP Address Status Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::IpPoolName> name of the IP pool
length: 1<=x<64
vrf-index <Aaa::VrfIndex> vrf associated with this pool
range: [0...255]
Command Output
Table 60.6-2 "IP Address Status Command" Display parameters
Specific Information
name Type Description
free <Gauge> The number of IpAddresses that are still free and
can be used for allocation.
This element is always shown.
reserved <Gauge> The number of IpAddresses that are reserved
(either locally or remotely) and cannot be used for
allocation.
This element is always shown.
allocated <Gauge> The number of IpAddresses that 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 priviliges.
Command Syntax
The command has the following syntax:
> show security radius auth-server auth-stats (name) vrf-index <Aaa::VrfIndex>
Command Parameters
Table 60.7-1 "RADIUS Authentication Server Statistics" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::RadAuthServerName> name of RADIUS authentication server
length: 1<=x<64
vrf-index <Aaa::VrfIndex> vrf to which this auth server belongs
range: [0...255]
Command Output
Table 60.7-2 "RADIUS Authentication Server Statistics" Display parameters
Specific Information
name Type Description
rndtrp-time <TimeTicks> The time interval between the 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 <Counter> The number of RADIUS Access-Request packets
sent to this server. This does not include
retransmissions.
This element is always shown.
num-access-retrn <Counter> The number of RADIUS Access-Request packets
retransmitted to this RADIUS authentication
server.
This element is always shown.
num-access-acpts <Counter> The number of RADIUS Access-Accept packets
(valid or invalid) received from this server.
This element is always shown.
num-access-rej <Counter> The number of RADIUS Access-Reject packets
(valid or invalid) received from this server.
Command Description
This command shows the state of the RADIUS authentication server.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security radius auth-server state (name) vrf-index <Aaa::VrfIndex>
Command Parameters
Table 60.8-1 "RADIUS Authenticating Server Status Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::RadAuthServerName> name of RADIUS authentication server
length: 1<=x<64
vrf-index <Aaa::VrfIndex> vrf to which this auth server belongs
range: [0...255]
Command Output
Table 60.8-2 "RADIUS Authenticating Server Status Command" Display parameters
Specific Information
name Type Description
auth-state <Aaa::OperState> The operational state of the authentication server.
Possible values are : This element is always shown.
- up : Operational state up
- down : Operational state down
- unknown : Operational state unknown
Command Description
This command displays the statistics of the RADIUS accounting server.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security radius acc-server acc-stats (name) vrf-index <Aaa::VrfIndex>
Command Parameters
Table 60.9-1 "RADIUS Accounting Server Statistics" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::RadAccServerName> name of the RADIUS accounting server
length: 1<=x<64
vrf-index <Aaa::VrfIndex> vrf to which the RADIUS Acc Server belongs
range: [0...255]
Command Output
Table 60.9-2 "RADIUS Accounting Server Statistics" Display parameters
Specific Information
name Type Description
rndtrip-time <TimeTicks> The time interval between the most recent
unit: msec accounting-response and the accounting-request
that matched it from this RADIUS accounting
server.
This element is always shown.
num-acc-req <Counter> The number of RADIUS accounting-request
packets sent. This does not include retransmissions.
This element is always shown.
num-req-retrans <Counter> The number of RADIUS accounting-request
packets retransmitted to this RADIUS accounting
server. Retransmissions include retries where the
identifier and acct-delay have been updated, as well
as those in which they remain the same.
This element is always shown.
num-resp <Counter> The number of RADIUS packets received on the
accounting port from this server.
This element is always shown.
num-malf-resp <Counter> The number of malformed RADIUS
Command Description
This command shows the state of the RADIUS accounting server.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security radius acc-server acc-server-state (name) vrf-index <Aaa::VrfIndex>
Command Parameters
Table 60.10-1 "RADIUS Accounting Server Status Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::RadAccServerName> name of the RADIUS accounting server
length: 1<=x<64
vrf-index <Aaa::VrfIndex> vrf to which the RADIUS Acc Server belongs
range: [0...255]
Command Output
Table 60.10-2 "RADIUS Accounting Server Status Command" Display parameters
Specific Information
name Type Description
acc-state <Aaa::OperState> Specifies the operational state of the accounting
Possible values are : server.
- up : Operational state up This element is always shown.
- down : Operational state down
- unknown : Operational state unknown
Command Description
This command displays the statistics of the radius dynamic authentication client.
The (conceptual) table listing 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 priviliges.
Command Syntax
The command has the following syntax:
> show security radius dyn-authclient-stats (name) vrf-index <Aaa::VrfIndex>
Command Parameters
Table 60.11-1 "RADIUS Dynamic Authentication Client Status Command" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::RadDynAuthClientName> name of the RADIUS Dynamic Authorization
length: 1<=x<64 client
vrf-index <Aaa::VrfIndex> vrf to which the RADIUS Dyn Auth Client belongs
range: [0...255]
Command Output
Table 60.11-2 "RADIUS Dynamic Authentication Client Status Command" Display parameters
Specific Information
name Type Description
num-disconnect-reqs <Counter> The number of RADIUS Disconnect-Request
packets recieved from this Dynamic Authorization
Client.
This element is always shown.
num-disconnect-acks <Counter> The number of RADIUS Disconnect-ACK packets
sent to this Dynamic Authorization Client.
This element is always shown.
num-access-naks <Counter> The number of RADIUS Disconnect-NAK packets
sent to this Dynamic Authorization Client.
This element is always shown.
num-malf-disconn-req <Counter> The number of malformed RADIUS
Disconnect-Request packets received from this
Dynamic Authorization client. Bad authenticators
Command Description
This command shows the next available index.
Index used to uniquely identify an entry in this table. The next-free-index shows the unique number within a Radius
Policy that can be used for creating a new entry in the radius Server. The value 0 indicates that no unassigned
entries are 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 should modify
the value to the next unassigned index.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security radius next-free-index (name)
Command Parameters
Table 60.12-1 "RADIUS Next Available Index" Resource Parameters
Resource Identifier Type Description
(name) <Aaa::RadPolicyName> name of the RADIUS policy
length: 1<=x<64
Command Output
Table 60.12-2 "RADIUS Next Available Index" Display parameters
Specific Information
name Type Description
next-free-index <Aaa::RadServerSetNextFreeIndex> A unique number within a radius policy that can be
range: [0...2] used for creating a new radus server set.
This element is always shown.
Command Description
This command shows the radius client parameters.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security radius radius-client
Command Output
Table 60.13-2 "RADIUS Client Status Command" Display parameters
Specific Information
name Type Description
auth-invl-server-addr <Counter> The number of RADIUS Access-Response packets
received from unknown addresses.
This element is always shown.
acc-invl-server-addr <Counter> The number of RADIUS Accounting-Response
packets received from unknown addresses.
This element is always shown.
dynauth-ser-inv-addr <Counter> The number of RADIUS Disconnect-Request
packets received from unknown addresses.
This element is always shown.
acc-ser-get-nxt-idx <Aaa::RadAccServerGetNextFreeIndex> The next free index value that can be used for
range: [0...256] creating a new entry in the radius accounting
server.
This element is always shown.
dyn-auth-get-nxt-idx <Aaa::RadDynAuthClentGetNextFreeIndex>The next free index value that can be used for
range: [0...256] creating a new entry in the radius dyn auth client.
This element is always shown.
Command Description
This command shows the details of authentication configuration.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security pae authenticator (port)
Command Parameters
Table 60.14-1 "PAE Authenticator Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / the identification of the bridge port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 60.14-2 "PAE Authenticator Status Command" Display parameters
Specific Information
name Type Description
auth-pae-state <Aaa::AuthPaeState> the current state of the authenticator PAE state
Possible values are : machine
- initialize : This element is always shown.
- disconnected :
- connecting :
- authenticating :
- authenticated :
- aborting :
- held :
- force-auth :
- force-unauth :
auth-backend-state <Aaa::AuthBackendState> the current state of the backend authentication state
Possible values are : machine
- request : This element is always shown.
- response :
- success :
- fail :
- timeout :
- idle :
Command Description
This command shows the eapol statistics.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security pae eapol-stats (port)
Command Parameters
Table 60.15-1 "EAPOL Statistics" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 60.15-2 "EAPOL Statistics" Display parameters
Specific Information
name Type Description
rx-frames <Counter> the number of valid EAPOL frames of any type that
have been received by this Authenticator
This element is always shown.
tx-frames <Counter> the number of EAPOL frames of any type that have
been transmitted by this Authenticator
This element is always shown.
starts <Counter> the number of EAPOL Start frames that have been
received by this Authenticator
This element is always shown.
logoffs <Counter> the number of EAPOL Logoff frames that have
been received by this Authenticator
This element is always shown.
rx-response-ids <Counter> the number of EAP Resp/Id frames that have been
received by this Authenticator
This element is only shown in detail mode.
rx-responses <Counter> number of valid EAP Response frames (other than
Resp/Id frames) that have been received by this
Authenticator
This element is only shown in detail mode.
Command Description
This command shows the diagnostic information.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security pae diagnostics (port)
Command Parameters
Table 60.16-1 "Diagnostic Information Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / the identification of the bridge port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 60.16-2 "Diagnostic Information Status Command" Display parameters
Specific Information
name Type Description
to-connecting-cnt <Counter> the number of times that the state machine
transitions to the CONNECTING state from any
other state
This element is always shown.
log-off-cnt <Counter> the number of times that the state machine
transitions from CONNECTING to
DISCONNECTED as a result of receiving an
EAPOL-Logoff message
This element is always shown.
authenticating-cnt <Counter> the number of times that the state machine
transitions from CONNECTING to
AUTHENTICATING, as a result of an
EAP-Response/Identity message being received
from the Supplicant
This element is only shown in detail mode.
authenticated-cnt <Counter> the number of times that the state machine
transitions from AUTHENTICATING to
AUTHENTICATED, as a result of the Backend
Authentication state machine indicating successful
Command Description
This command shows the statistics for the sessions.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security pae session-stats (port)
Command Parameters
Table 60.17-1 "Session Statistics" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / the identification of the bridge port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 60.17-2 "Session Statistics" Display parameters
Specific Information
name Type Description
rx-octets <Counter> the number of octets transmitted in user data frames
on this port during the session
This element is always shown.
tx-octets <Counter> the number of octets transmitted in user data frames
on this port during the session
This element is always shown.
rx-user-frames <Counter> the number of user data frames received on this
port during the session
This element is always shown.
tx-user-frames <Counter> the number of user data frames transmitted on this
port during the session
This element is always shown.
ses-id <Vlan::AdminString> a unique identifier for the session
length: x<32 This element is only shown in detail mode.
auth-method <Aaa::AuthenticMethod> the authentication method used to establish the
Possible values are : session
- remote-auth-server : This element is only shown in detail mode.
- local-auth-server :
ses-time <TimeTicks> the duration of the session
Command Description
This command shows the PAE-port related system parameters.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security pae port-details (port)
Command Parameters
Table 60.18-1 "PAE Port System Status Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Command Output
Table 60.18-2 "PAE Port System Status Command" Display parameters
Specific Information
name Type Description
prot-ver <SignedInteger> The protocol version associated with this Port.
This element is always shown.
capabilities <Aaa::Capabilities> Indicates the PAE functionality that this Port
Possible values are : supports
- auth-capable : This element is always shown.
- supp-capable :
reauth <Aaa::TruthValue> Specifies currently in use by the Authenticator PAE
Possible values are : state machine.
- true : This element is always shown.
- false :
Command Description
This command shows the eapol data per mac-address.
User Level
The command can be accessed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> show security pae mac-address (last-src-mac)
Command Parameters
Table 60.19-1 "Mac-address Related Eapol Status Command" Resource Parameters
Resource Identifier Type Description
(last-src-mac) <Vlan::MacAddr> the source MAC address carried in the most
length: 6 recently received EAPOL frame
Command Output
Table 60.19-2 "Mac-address Related Eapol Status Command" Display parameters
Specific Information
name Type Description
port <Eqpt::Rack> / <Eqpt::Shelf> / the port identification
<Eqpt::LtSlot> / <Eqpt::Port> : This element is only shown in detail mode.
<Atm::vpi> : <Atm::vci>
user-name <Vlan::AdminString> the name representing the identity of the Supplicant
length: x<32 PAE
This element is only shown in detail mode.
port-status <Aaa::PaeControlledPortStatus> the current port status
Possible values are : This element is always shown.
- authorized :
- unauthorized :
Command Description
This node allows the operator to manage the alarms.
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> admin alarm [(clr-logging) ][(clr-persist-loss) ]
Command Parameters
Table 61.1-2 "Alarm Management Command" Command Parameters
Parameter Type Description
(clr-logging) <Alarm::AlarmReset> optional parameter
clear log table - logging will start from index 1
(clr-persist-loss) <Alarm::ClearLossPersistent> optional parameter
clear the loss of persistent data alarm
Command Description
The operator can make a snap-shot for a particular severity level.
The owner-id can be read by other users to see who has made the snap-shot.
The command will fail if the snap-shot is already in use. The snap-shot is only kept for a limited time and will be
automatically cleared.
The snap-shot can be shown with show alarm shub snapshot.
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> admin alarm snap-shot [(start) ]
Command Parameters
Table 61.2-2 "Snap Shot Management Command" Command Parameters
Parameter Type Description
(start) start | indeterminate | warning | minor | optional parameter
major | critical | <SignedInteger> : start or stop the snap shot
<Alarm::alarmSnapShotOwner> | stop
Command Description
The operator can make a snap-shot for a particular severity level.
The command will fail if the snap-shot is already in use. The snapshot is only kept for a limited time and will be
automatically cleared.
The snap-shot can be shown with show alarm shub snapshot.
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> admin alarm shub snap-shot [(start) ]
Command Parameters
Table 61.3-2 "SHub Snap Shot Management Command" Command Parameters
Parameter Type Description
(start) start | indeterminate | warning | minor | optional parameter
major | critical | <SignedInteger> : start or stop the snap shot
<Alarm::alarmSnapShotOwner> | stop
Command Description
This command allows the operator to manage the alarm delta logs.
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> admin alarm delta-log [(clr-indeterminate) ][(clr-warning) ][(clr-minor)
][(clr-major) ][(clr-critical) ]
Command Parameters
Table 61.4-2 "Alarm Delta Log Management Command" Command Parameters
Parameter Type Description
(clr-indeterminate) <Alarm::IndetrLogAlarmResetType> optional parameter
clear indeterminate delta-log table - set index to 1
(clr-warning) <Alarm::WarnLogAlarmResetType> optional parameter
clear warning delta-log table - set index to 1
(clr-minor) <Alarm::MinorLogAlarmResetType> optional parameter
clear minor delta-log table - set index to 1
(clr-major) <Alarm::MajorLogAlarmResetType> optional parameter
clear major delta-log table - set index to 1
(clr-critical) <Alarm::CriticalLogAlarmResetType> optional parameter
clear critical delta-log table - set index to 1
Command Description
This command allows the operator to manage the logs..
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> admin alarm log [(clr-error-log) ][(clr-set-log-table) ]
Command Parameters
Table 61.5-2 "Log Management Command" Command Parameters
Parameter Type Description
(clr-error-log) <Error::errorResetType> optional parameter
clear the error log : index starts from 1
(clr-set-log-table) <Trans::setLogTableReset> optional parameter
clear the set log table : index starts from 1
Command Description
A f5 loopback end-to-end test can be started by giving the parameter f5-loopback-ete the value start.
The result can be obtained with the info command.
User Level
The command can be accessed by operators with atm priviliges, and executed by operators with atm priviliges.
Command Syntax
The command has the following syntax:
> admin atm port (port) [f5-loopback-ete start | not-started | in-progress |
not-supported | unable-to-run | aborted | failed | round-trip-delay =
<UnsignedInteger> ]
Command Parameters
Table 62.1-1 "ATM Port Management Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / the port under test
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Table 62.1-2 "ATM Port Management Command" Command Parameters
Parameter Type Description
f5-loopback-ete start | not-started | in-progress | optional parameter
not-supported | unable-to-run | aborted | the f5 end-to-end loopback test
failed | round-trip-delay =
<UnsignedInteger>
Command Description
This command allows the operator to manage IGMP.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
Command Syntax
The command has the following syntax:
> admin igmp [(clear-all-stats) ]
Command Parameters
Table 63.1-2 "IGMP Management Command" Command Parameters
Parameter Type Description
(clear-all-stats) <Igmp::igmpClearAllStatus> optional parameter
clears all statistics
Command Description
Manage the IGMP multicast sources.
User Level
The command can be accessed by operators with igmp priviliges, and executed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> admin igmp mcast-src (slot-index) address <MulticastAddress> [(clear-statistics) ]
Command Parameters
Table 63.2-1 "IGMP Multicast Sources Management Command" Resource Parameters
Resource Identifier Type Description
(slot-index) <Eqpt::Rack> / <Eqpt::Shelf> / identify an IGMP module by the logical SlotId
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
address <MulticastAddress> mcast src address in network-byte order
(big-endian)
Table 63.2-2 "IGMP Multicast Sources Management Command" Command Parameters
Parameter Type Description
(clear-statistics) <Igmp::igmpClearStatus> optional parameter
clear the statistics
Command Description
Manage IGMP related to a slot.
User Level
The command can be accessed by operators with igmp priviliges, and executed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> admin igmp module (slot-index) [(clear-statistics) ]
Command Parameters
Table 63.3-1 "IGMP Slot Management Command" Resource Parameters
Resource Identifier Type Description
(slot-index) <Eqpt::Rack> / <Eqpt::Shelf> / identify an IGMP module by the logical slot id
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
Table 63.3-2 "IGMP Slot Management Command" Command Parameters
Parameter Type Description
(clear-statistics) <Igmp::igmpClearStatus> optional parameter
clear the statistics
Command Description
Manage IGMP related to a channel.
User Level
The command can be accessed by operators with igmp priviliges, and executed by operators with igmp priviliges.
Command Syntax
The command has the following syntax:
> admin igmp channel (port) [(clear-statistics) ]
Command Parameters
Table 63.4-1 "IGMP Channel Management Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port:vpi:vci
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Table 63.4-2 "IGMP Channel Management Command" Command Parameters
Parameter Type Description
(clear-statistics) <Igmp::igmpClearStatus> optional parameter
whether the statistics of this table are cleared or to
ignore the request
Command Description
This management command deletes all ports for a specific engine.
User Level
The command can be accessed by operators with ppoe priviliges, and executed by operators with ppoe priviliges.
Command Syntax
The command has the following syntax:
> admin pppox-relay engine (vlan-id) [(remove-all-ports) ]
Command Parameters
Table 64.1-1 "PPPoX Engine Port Management Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) <Vlan::VlanId> vlan identity
range: [1...4093]
Table 64.1-2 "PPPoX Engine Port Management Command" Command Parameters
Parameter Type Description
(remove-all-ports) <PPPoX::RmvAllPorts> optional parameter
remove all ports for a specific engine
Command Description
This node allows the operator do manage an xDSL Line.
User Level
The command can be accessed by operators with xdsl priviliges, and executed by operators with xdsl priviliges.
Command Syntax
The command has the following syntax:
> admin xdsl-line (if-index) [loop-diagnostic <Xdsl::LoopDiagMode> ]
Command Parameters
Table 65.1-1 "xDSL Line Management Command" Resource Parameters
Resource Identifier Type Description
(if-index) <Eqpt::Rack> / <Eqpt::Shelf> / interface index of the port
<Eqpt::LtSlot> / <Eqpt::Port>
Table 65.1-2 "xDSL Line Management Command" Command Parameters
Parameter Type Description
loop-diagnostic <Xdsl::LoopDiagMode> optional parameter
Possible values are : controls the loop diagnostic test
- stop : stop the loop diagnostic test
- start : start the diagnostic test
Command Description
This command allows the operator to manage the software of the system.
User Level
The command can be accessed by operators with sw priviliges, and executed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> admin software-mngt [(clr-db-rollback-alrm) ][(clr-sw-rollback-alrm) ]
Command Parameters
Table 66.1-2 "Software Management Command" Command Parameters
Parameter Type Description
(clr-db-rollback-alrm) <SwMngt::dbRollback> optional parameter
clear the implicit database rollback alarm
(clr-sw-rollback-alrm) <SwMngt::swRollback> optional parameter
clear the implicit software rollback alarm
Command Description
This node allows the operator to manage the software on the SHub.
User Level
The command can be accessed by operators with sw priviliges, and executed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> admin software-mngt shub [select-config <SwMngt::ReqOSPDevice> ]
Command Parameters
Table 66.2-2 "SHub Software Management Command" Command Parameters
Parameter Type Description
select-config <SwMngt::ReqOSPDevice> optional parameter
Possible values are : select the configuration to be used
- config-1 : sets config1 version in BSP
- config-2 : sets config2 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 sw priviliges, and executed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> admin software-mngt shub database [(save) ]
Command Parameters
Table 66.3-2 "SHub Database Management Command" Command Parameters
Parameter Type Description
(save) <Sys::ConfigSaveValue> optional parameter
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 sw priviliges, and executed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> admin software-mngt shub sw-package (package) [(download) ]
Command Parameters
Table 66.4-1 "SHub SWPackage Administration Command" Resource Parameters
Resource Identifier Type Description
(package) <Ip::V4Address> : <Sys::FileName> the identification of the software package
Table 66.4-2 "SHub SWPackage Administration Command" Command Parameters
Parameter Type Description
(download) <Sys::ImageValue> optional parameter
download the package
Command Description
Copy files on the shub.
User Level
The command can be accessed by operators with sw priviliges, and executed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> admin software-mngt shub copy from shub | <Ip::V4Address> : <Sys::FileName> to shub
| <Ip::V4Address> : <Sys::FileName>
Command Parameters
Table 66.5-2 "Copy Command On The SHub" Command Parameters
Parameter Type Description
from shub | <Ip::V4Address> : mandatory parameter
<Sys::FileName> the file to be copied
to shub | <Ip::V4Address> : mandatory parameter
<Sys::FileName> the destination
Command Description
Delete files from the shub.
User Level
The command can be accessed by operators with sw priviliges, and executed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> admin software-mngt shub delete-file (filetodel)
Command Parameters
Table 66.6-2 "Delete Command On The SHub" Command Parameters
Parameter Type Description
(filetodel) <Sys::FileName> mandatory parameter
length: 1<=x<256 the file to be deleted
Command Description
List files from the shub flash
User Level
The command can be accessed by operators with sw priviliges, and executed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> admin software-mngt shub list-file (dir)
Command Parameters
Table 66.7-2 "List files SHub flash" Command Parameters
Parameter Type Description
(dir) <Sys::FileName> mandatory parameter
length: 1<=x<256 the file or directory name used to populate the
file-list table
Command Description
This command allows the operator to manage the LT software.
User Level
The command can be accessed by operators with sw priviliges, and executed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> admin software-mngt lt (index) [(upgrade-sw) ]
Command Parameters
Table 66.8-1 "LT Software Management Command" Resource Parameters
Resource Identifier Type Description
(index) <Eqpt::Rack> / <Eqpt::Shelf> / the physical number of the slot
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
Table 66.8-2 "LT Software Management Command" Command Parameters
Parameter Type Description
(upgrade-sw) <Equipm::BoardSwOverruleStatus> optional parameter
overrules the default software version for this board
Command Description
This command allows the operator to manage the OSWP software packages.
User Level
The command can be accessed by operators with sw priviliges, and executed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> admin software-mngt oswp (index) [download <SwMngt::oswpName> ][activate
<SwMngt::activationType> ][(commit) ][(abort-download) ]
Command Parameters
Table 66.9-1 "OSWP Software Management Command" Resource Parameters
Resource Identifier Type Description
(index) <SwMngt::swmOswpIdx> index to the swm oswp table
range: [1...2]
Table 66.9-2 "OSWP Software Management Command" Command Parameters
Parameter Type Description
download <SwMngt::oswpName> optional parameter
range: [a-zA-Z0-9-_.-/] download a software package
activate <SwMngt::activationType> optional parameter
Possible values are : activate an OSWP package
- with-linked-db : activate OSWP with
linked database
- with-default-db : activate OSWP with
default database
- clear-db : prepare the NT board for
migration
(commit) <SwMngt::commitAction> optional parameter
commit the OSWP
(abort-download) <SwMngt::abortDownload> optional parameter
abort the download of an oswp
Command Description
This command allows to manage the database of the system.
User Level
The command can be accessed by operators with sw priviliges, and executed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> admin software-mngt database [download <Ip::V4Address> : <SwMngt::path> ][upload
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> | not-used : <Ip::V4Address> : <SwMngt::path> ]
Command Parameters
Table 66.10-2 "Database Management Command" Command Parameters
Parameter Type Description
download <Ip::V4Address> : <SwMngt::path> optional parameter
download the database
upload actual-active : <Ip::V4Address> : optional parameter
<SwMngt::path> | preferred-active : upload the database
<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> |
not-used : <Ip::V4Address> :
<SwMngt::path>
Command Description
This command manages Disk Files and Descriptor Files.
A Disk File contains information on the different SW files and descriptor files that are stored on the file disk. It also
contains information like, file name, file size, file type, file available status and file format.
The operator can remove a file from the disk that is no longer used. This can be done by specifying the file name,
which is unique over all board types and over all SWP types for all releases.
User Level
The command can be accessed by operators with sw priviliges, and executed by operators with sw priviliges.
Command Syntax
The command has the following syntax:
> admin software-mngt disk-file (path) [(remove) ]
Command Parameters
Table 66.11-1 "File Management Command" Resource Parameters
Resource Identifier Type Description
(path) <FilePath> an absolute file name
range: [.-z]length: 1<=x<256
Table 66.11-2 "File Management Command" Command Parameters
Parameter Type Description
(remove) <SwMngt::fileRemove> optional parameter
remove the file
Command Description
This command allows the operator to configure a MD5 key for an OSPF interface.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> admin ospf interface (ip-addr) md5-key <Ospf::Md5KeyIndex> [accept-expires
<Ospf::MD5expiryDelay> ]generate-expires <Ospf::MD5expiryDelay>
Command Parameters
Table 67.1-1 "OSPF Interface MD5 Key Management Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) <Ip::V4Address> ip address identifying the interface
md5-key <Ospf::Md5KeyIndex> the number of the md5 key
range: [1...5]
Table 67.1-2 "OSPF Interface MD5 Key Management Command" Command Parameters
Parameter Type Description
accept-expires <Ospf::MD5expiryDelay> optional parameter
Possible values are : set the delay before the key expires for accepting
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire
generate-expires <Ospf::MD5expiryDelay> mandatory parameter
Possible values are : set the delay before the key expires for generating
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire
Command Description
This command allows the operator to manage a MD5 key for an RIP interface.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> admin rip interface (ip-addr) md5-key <Rip::Md5KeyIndex> [expires
<Rip::MD5expiryDelay> ]
Command Parameters
Table 68.1-1 "RIP Interface MD5 Key Management Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) <Ip::V4Address> interface IP address
md5-key <Rip::Md5KeyIndex> the number of the md5 key
range: [1...5]
Table 68.1-2 "RIP Interface MD5 Key Management Command" Command Parameters
Parameter Type Description
expires <Rip::MD5expiryDelay> optional parameter
Possible values are : set the delay before the key expires
- now : the key will expire now
- never : the key will never expire
- <Rip::MD5expiryDelay> : the delay
before the key will expire
Command Description
This command allows the operator to manage the equipment.
User Level
The command can be accessed by operators with equip priviliges, and executed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> admin equipment [(prepare-shutdown) ][(reboot-shub) ][reboot-isam
<Equipm::SystemRestart> ]
Command Parameters
Table 69.1-2 "Equipment Management Command" Command Parameters
Parameter Type Description
(prepare-shutdown) <Sys::SysShutdown> optional parameter
prepare the system for shutdown
(reboot-shub) <Sys::RestartValue> optional parameter
reboot the shub
reboot-isam <Equipm::SystemRestart> optional parameter
Possible values are : reboot the isam (without shub)
- with-self-test : restart with selftest
- without-self-test : restart without selftest
- default-no-persist : restart with persistent
data removed, except management
channel
- default-no-data : restart with all data
removed, including management channel
- hot-restart : restart system without traffic
impact
Command Description
This command allows an operator to manage a slot and the cards in the slot.
User Level
The command can be accessed by operators with equip priviliges, and executed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> admin equipment slot (index) [reboot <Equipm::BoardRestart> ]
Command Parameters
Table 69.2-1 "Slot Management Command" Resource Parameters
Resource Identifier Type Description
(index) <Eqpt::Rack> / <Eqpt::Shelf> / the identification of the slot
<Eqpt::Slot>
<Eqpt::Rack>= range: [1...1]/
<Eqpt::Shelf>= range: [1...1]/
<Eqpt::Slot>= range: [1...21]
Table 69.2-2 "Slot Management Command" Command Parameters
Parameter Type Description
reboot <Equipm::BoardRestart> optional parameter
Possible values are : reboot the card in the slot
- with-selftest : reboot the board with self
test
- without-selftest : reboot the board
without self test
- hot-restart : reboot the board without
traffic impact
Command Description
This command allows the operator to manage SHub ports.
User Level
The command can be accessed by operators with equip priviliges, and executed by operators with equip priviliges.
Command Syntax
The command has the following syntax:
> admin equipment port (port) [copy-to-port <Shub::NetworkPort> ]
Command Parameters
Table 69.3-1 "SHub Port Management Command" Resource Parameters
Resource Identifier Type Description
(port) <Shub::NetworkPort> identification of a port
range: [1...7]
Table 69.3-2 "SHub Port Management Command" Command Parameters
Parameter Type Description
copy-to-port <Shub::NetworkPort> optional parameter
range: [1...7] copy the port to another port
Command Description
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> admin bridge learned-unicast-mac (unicast-mac-address) vlan-id <Vlan::UVlanIndex> |
stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> port <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::vpi> : <Atm::vci> [(delete) ]
Command Parameters
Table 70.1-1 "Learned Unicast Mac Address Management Command" Resource Parameters
Resource Identifier Type Description
(unicast-mac-address) <Vlan::MacAddr> unicast mac address
length: 6
vlan-id <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
port <Eqpt::Rack> / <Eqpt::Shelf> / identification of a port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Table 70.1-2 "Learned Unicast Mac Address Management Command" Command Parameters
Parameter Type Description
(delete) <Vlan::DeleteUnicastMac> optional parameter
delete a learned unicast mac address
Command Description
This command allows 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 address 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 priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> admin bridge vlan-id (id) [(delete-member-ports) ]
Command Parameters
Table 70.2-1 "VLAN Management Command" Resource Parameters
Resource Identifier Type Description
(id) <Vlan::UVlanIndex> | stacked : vlan id
<Vlan::SVlanIndex> :
<Vlan::CVlanIndex>
Table 70.2-2 "VLAN Management Command" Command Parameters
Parameter Type Description
(delete-member-ports) <Vlan::DeletePorts> optional parameter
delete all egress ports
Command Description
This node allows the operator to manage RSTP related to a port.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> admin bridge rstp port (port) [(clear-det-proto) ]
Command Parameters
Table 70.3-1 "Port Related RSTP Management Command" Resource Parameters
Resource Identifier Type Description
(port) <Shub::NetworkPort> the identification of a network port
range: [1...7]
Table 70.3-2 "Port Related RSTP Management Command" Command Parameters
Parameter Type Description
(clear-det-proto) <Shub::PortMigration> optional parameter
clear the list of detected protocols
Command Description
This command allows an operator to manage a trap manager.
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> admin trap manager (address) [(reset-trap-buffer) ]
Command Parameters
Table 71.1-1 "Trap Manager Management Command" Resource Parameters
Resource Identifier Type Description
(address) <Ip::V4Address> : <Trap::Port> the IP address of the manager
<Ip::V4Address>: <Trap::Port>= range:
[1...65535]
Table 71.1-2 "Trap Manager Management Command" Command Parameters
Parameter Type Description
(reset-trap-buffer) <Trap::Reset> optional parameter
reset the trap buffer
Command Description
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
Command Syntax
The command has the following syntax:
> admin ip vrf-media (vrf-slot) ip-address <Ip::V4Address> [(remove) ]
Command Parameters
Table 72.1-1 "Slot Related VRF Management Command" Resource Parameters
Resource Identifier Type Description
(vrf-slot) <Eqpt::Rack> / <Eqpt::Shelf> / equipment slot ID.
<Eqpt::LtSlot> : <Vrf::VrfIndex>
ip-address <Ip::V4Address> ip address
Table 72.1-2 "Slot Related VRF Management Command" Command Parameters
Parameter Type Description
(remove) <Vrf::MediaType> optional parameter
remove the entry
Command Description
This command help to reset VRF interface counters.
User Level
The command can be accessed by operators with ip priviliges, and executed by operators with ip priviliges.
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 72.2-1 "IP VRF Interface Reset Management Command" Resource Parameters
Resource Identifier Type Description
(vrf-id) <Vrf::VrfIndex> the vrf index
range: [1...127]
(port-interface) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port user-port
<Eqpt::LtSlot> / <Eqpt::Port> : identification
<Atm::vpi> : <Atm::vci>
Table 72.2-2 "IP VRF Interface Reset Management Command" Command Parameters
Parameter Type Description
reset <Vrf::AdminCounter> mandatory parameter
reset the vrf interface counter
Command Description
This node allows the operator to manage the DHCP realy user port commands.
User Level
The command can be accessed by operators with dhcp priviliges, and executed by operators with dhcp priviliges.
Command Syntax
The command has the following syntax:
> admin dhcp-relay user-port (user-port) (reset-counters)
Command Parameters
Table 73.1-1 "DHCP Relay User Port Management Command" Resource Parameters
Resource Identifier Type Description
(user-port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port user-port
<Eqpt::LtSlot> / <Eqpt::Port> : identification
<Atm::vpi> : <Atm::vci>
Table 73.1-2 "DHCP Relay User Port Management Command" Command Parameters
Parameter Type Description
(reset-counters) <Dhcp::CounterReset> mandatory parameter
reset the user port counters
Command Description
This is used for deleting the IP address out of the ARP table.
User Level
The command can be accessed by operators with transp priviliges, and executed by operators with transp
priviliges.
Command Syntax
The command has the following syntax:
> admin transport ip-net-to-media (interface-name) network-addr <Ip::V4Address>
phy-addr <Sys::MacAddr> [(delete) ]
Command Parameters
Table 74.1-1 "IP Net to Media Management Command" Resource Parameters
Resource Identifier Type Description
(interface-name) <Transport::ifName> name of the interface
network-addr <Ip::V4Address> ip addr corresponding to media-dependent physical
addr
phy-addr <Sys::MacAddr> media-dependent physical addr
length: 6
Table 74.1-2 "IP Net to Media Management Command" Command Parameters
Parameter Type Description
(delete) <IP::DeleteNetToMedia> optional parameter
delete a ip-net-to-media
Command Description
This node allows the operator to manage SNTP.
User Level
The command can be accessed by operators with vlan priviliges, and executed by operators with vlan priviliges.
Command Syntax
The command has the following syntax:
> admin sntp [system-time <Sys::Time> ][shub-time <Sys::Time> ]
Command Parameters
Table 75.1-2 "SNTP Management Command" Command Parameters
Parameter Type Description
system-time <Sys::Time> optional parameter
set the system time
shub-time <Sys::Time> optional parameter
set the system time for the shub
Command Description
This command allows to manage transactions.
User Level
The command can be accessed by operators with alarm priviliges, and executed by operators with alarm priviliges.
Command Syntax
The command has the following syntax:
> admin transaction [configure-lock <Trans::ownerIpAddr> ]
Command Parameters
Table 76.1-2 "Manage Transaction Configuration Status" Command Parameters
Parameter Type Description
configure-lock <Trans::ownerIpAddr> optional parameter
Possible values are : changes the status of the configuration lock
- acquire : prevents other managers from
configuring
- release : allow other managers to
configure
Command Description
User Level
The command can be accessed by operators with aaa priviliges, and executed by operators with aaa priviliges.
Command Syntax
The command has the following syntax:
> admin security ext-authenticator (port) [(clear-statistics) ]
Command Parameters
Table 77.1-1 "Security 802.1x Port Authentication Management Command" Resource Parameters
Resource Identifier Type Description
(port) <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::vpi> : <Atm::vci>
Table 77.1-2 "Security 802.1x Port Authentication Management Command" Command Parameters
Parameter Type Description
(clear-statistics) <Aaa::PortClearStatistics> optional parameter
clear non-accounting statistics
Command Description
This command allows the operator to ping another host.
User Level
The command can be accessed by operators with all priviliges, and executed by operators with all priviliges.
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 78.1-1 "Ping Command" Resource Parameters
Resource Identifier Type Description
(ip-addr) <Ip::V4Address> the ip-address of the node to be pinged
Table 78.1-2 "Ping Command" Command Parameters
Parameter Type Description
timeout <Ip::PingTimeout> optional parameter with default value: 1L
range: [1...100] unit: sec the maximum time to wait for a response
tries <Ip::PingTries> optional parameter with default value: 5L
range: [1...100] the number of times the node must be pinged
mtu-size <Ip::PingMtu> optional parameter with default value: 500L
range: [0...2080] unit: bytes the size of the data portion of the ping PDU
Command Output
Table 78.1-3 "Ping Command" Display parameters
Specific Information
name Type Description
received <Counter> total number of packets sent to the destination
This element is always shown.
sent <UnsignedInteger> total number of packets sent to the destination
This element is always shown.
loss <UnsignedInteger> percentage of lost packets
This element is always shown.
mean-delay <Ip::PingDelay> the average round trip delay
unit: sec This element is always shown.
max-delay <Ip::PingDelay> the maximum round trip delay
unit: sec This element is always shown.
min-delay <Ip::PingDelay> the minimum round trip delay
unit: sec This element is always shown.
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:
> count [ no lines | lines ][ no words | words ][ no characters | characters ][ no
summary | summary ]
Command Parameters
Table 79.1-2 "Count Filter" Command Parameters
Parameter Type Description
[ no ] lines <Option::Lines> optional parameter with default value: "no-lines"
[ no ] words <Option::Words> optional parameter with default value: "no-words"
[ no ] characters <Option::Characters> optional parameter with default value:
"no-characters"
[ no ] summary <Option::Summary> optional parameter with default value:
"no-summary"
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:
> match (pattern) [ no case-insensitive | case-insensitive ][ no (skip) ]
Command Parameters
Table 79.2-2 "Match Filter" Command Parameters
Parameter Type Description
(pattern) exact : <PrintableString> mandatory parameter
describes what we are looking for
(exact:|pattern:)<PrintableString>)
[ no ] case-insensitive <Option::CaseSensitivity> optional parameter with default value:
"case-sensitive"
pattern recognition is case-insensitive
[ no ] (skip) <Option::MatchAction> optional parameter with default value: "match"
Possible values are : matched lines are skipped
- 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:
> tee (file) [ no append | append ]
Command Parameters
Table 79.3-2 "Tee Filter" Command Parameters
Parameter Type Description
(file) <FileName> mandatory parameter
range: [.-z]length: 1<=x<256 the name of the file
[ no ] append <Option::Append> optional parameter with default value: "overwrite"
append if the file exists
80.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
80.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
80.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
auth-type 252
A autofetch
availability
151
587
aaa 121
aal5-encap-type 69 B
abr-type 260
accept-expires 749 back 27
accept-frame-type 192 bcast-vlan 255
accept-starts 264 board 550
acc-interval 140 bridge 191
acc-server 137 bridge-port 420
acc-server-state 703 bridge-port-fdb 428
acc-stats 701 burst-size 241
ack 99
action 31 C
activate 745
actor-key 213 cac 231
actor-port-prio 213 cache-pending 182
actor-sys-prio 213 cache-refresh 182
address 729 cache-retry-time 182
admin-p2p 217 cache-timeout 182
admin-status 75 cac-profile 235
adsl2-plus 59 capacity 171
adsl-adsl2 55 carrier-data-mode 64
ageing-time 191 carrier-mask-down 53
agent 255 carrier-mask-up 53
agent-ip-addr 258 cc-max-age 245
aggregate-list 463 cfg-res-time 171
aggregator-info 460 channel 161
aggregator-port 213 class 85
alarm 37 client-port 248
alarm-changes 375 codepoint 223
applique 81 coll-count 656
area 261 commands 14
area-id 677 committed-burst-size 228
arp 182 committed-info-rate 228
arp-policy 185 community 124
as-border-router 260 community-string 48
asbr-external 678 config-control 595
as-number 181 configure 30
associated-ports 555 configure-lock 772
atm 121 connection 562
atm-overhead-fact 219 conn-policy 131
atm-peak-bit-rate 172 conn-profile 130
atm-sus-bit-rate 172 conn-profile-name 131
authentication 262 contact 113
authenticator 126 contact-person 89
auth-server 135 context-lifetime 258
auth-stats 698
general 170
generate-expires 749 K
generate-starts 264
global 419 keep-alive-intvl 252
global-session 245 key 264
H L
handshake-period 146 la 212
hello-interval 263 lacp-mode 213
hello-time 216 last-max-resp-tim 163
help 24 last-memb-cnt 163
history 16 layer2-terminated 424
hops-threshold 258 layer3-itf 177
host-ip-address 91 learned-unicast-mac 757
host-purge-intv 165 leave-rsp-timer 166
host-report-intv 163 license 604
line 64
I link-type 677
list-file 601
icmp 95 local-port 650
id 89 location 89
if-table 563 log 724
igmp 121 log-entry 608
igs-system 165 log-full-action 37
igs-vlan-grp 670 logical-flow-type 232
in 29 login-banner 118
indet-log-full-action 42 logout 15
index 654 log-sev-level 37
info 25 loop-diagnostic 735
in-port 97 lower 582
interface 262 lt 744
interval-no 529
interval-num 482 M
interval-number 440
intvl-number 405 mac 426
ip 112 mac-address 573
ip-addr 125 mac-filter 157
ip-address 135 major-log-full-action 42
ip-addr-pool 132 management 91
ip-cfg-mode 112 manager 46
ip-net-to-media 644 marker 475
ipox 373 mask 683
ip-parameters 640 match 780
ip-pool 128 max-age 216
ip-pool-status 696 max-agpowlev-down 55
ip-route 642 max-agpowlev-up 55
ip-statistics 496 max-bitrate 170
isam 83 max-bitrate-down 51
itf-ip-addr 677 max-bitrate-up 51
itf-type 262 max-cc 248
max-delay-down 51
J max-delay-up 51
max-dst-port 99
junk-collection 284 max-ingress-rate 241
max-mcast-bandwidth 231
max-nbr-pkts 159
Q S
qos 121 save-dest 154
qos-policy 126 scheduler 230
qos-profile 192 scheduler-profile 235
query-interval 163 second-dns 126
query-timer 167 second-file-server-id 151
queue 229 second-nbns 126
queue0-weight 238 secret 135
queue1-weight 238 secs-threshold 258
queue-config 238 security 118
queue-profile 236 select-config 738
quiet-period 144 self-ip-addr 165
self-ip-addr-mode 165
R send
server-ip-addr
283
93
rack 84 server-name 251
radius 134 server-port 93
servers 142
upload 746
upload-download 620
up-marker 232
up-policer 232
user 72
user-port 766
user-session 693
V
value 225
vdsl 61
vdsl-band-plan 61
version 51
vlan 115
vlan-bind 177
vlan-day-stats 450
vlan-filter 168
vlan-id 75
vlan-router-port 167
vrf 174
vrf-agent-stats 668
vrf-id 189
vrf-index 126
vrf-index-acc 142
vrf-index-auth 142
vrf-interface 499
vrf-mapping 504
vrf-media 503
vrf-next-index 505
vrf-route 502
vrf-statistics 495
W
warn-log-full-action 42
welcome-banner 118
wfq-q1-weight 230
window-size 46
write 23
X
xdsl 121
xdsl-int 512
xdsl-line 735