You are on page 1of 483

ATOS User Guide

ATOS - 1 / 483

ATOS
Aethra Telecommunication Operating System

User Guide

ATOS User Guide


Index - 2 / 483

ATOS
USER GUIDE

Technical Reference Manual


Upgrade to ATOS 4.2.1

Rev. 14
DATE: November 2008

Rights

Copyright 2004 Aethra SpA


All rights reserved
Printed in Italy

Trademarks

AETHRA is a registered trademark of Aethra SpA. Ethernet is a


registered trademark of Xerox Corporation. Microsoft and
Windows are registered trademarks of Microsoft Corporation.

ATOS User Guide


Index - 3 / 483

ALPHABETIC INDEX

ALPHABETIC INDEX..........................................................................................................................................3
ATOS documentation...........................................................................................................................................14
Editing criteria....................................................................................................................................................14
Where to find the documentation .......................................................................................................................15
CD-ROM, World Wide Web ........................................................................................................................15
How to use ATOS (Aethra Telecommunications Operating System)..............................................................16
How to understand the ATOS structure using CLI commands..........................................................................16
Configuration and Management ...................................................................................................................16
How to start a CLI session............................................................................................................................16
How to use the help or (?) commands ..........................................................................................................17
The CLI syntax .............................................................................................................................................18
Configuration parameters...................................................................................................................................18
General commands .......................................................................................................................................18
Prompt ..........................................................................................................................................................21
The command structure ................................................................................................................................22
How to show the system configuration.........................................................................................................23
Step-by-step configuration............................................................................................................................24
How to save the configuration ......................................................................................................................24
How to restore the default values .................................................................................................................25
How to upload a file to a PC.........................................................................................................................25
How to download a file from pc ...................................................................................................................25
Event visualization (log) ....................................................................................................................................26
Authentication, Authorization, Accounting. ......................................................................................................28
Authentication by RADIUS protocol.................................................................................................................28

ATOS User Guide


Index - 4 / 483

Authentication by RAC......................................................................................................................................29
Authentication profiles.......................................................................................................................................29
AAA - Commands.............................................................................................................................................30
AAA - Nodes.....................................................................................................................................................31
AAAPROFILEname Commands...............................................................................................................31
AAAPROFILEname Nodes.......................................................................................................................31
Access lists .............................................................................................................................................................34
Creation and management of access lists ...........................................................................................................34
How to create an access list and a new rule..................................................................................................35
How to delete an access list ..........................................................................................................................39
Examples: how to block e-mail ....................................................................................................................39
How to check an access list ..........................................................................................................................40
How to block Internet access ........................................................................................................................41
How to block ATOS management................................................................................................................41
Auxiliary................................................................................................................................................................43
Autoswitch .........................................................................................................................................................43
UPS ....................................................................................................................................................................43
Bridges ...................................................................................................................................................................45
Bridges Nodes .................................................................................................................................................45
Bridge1/4 Commands ................................................................................................................................46
Spanning Tree Protocol Commands ..........................................................................................................47
Configuration via Telnet......................................................................................................................................49
Configuration via WEB .......................................................................................................................................50
Home page .........................................................................................................................................................50
Detailed configuration via Web .........................................................................................................................51
System ..........................................................................................................................................................51

ATOS User Guide


Index - 5 / 483

File-Download ..............................................................................................................................................52
File-Upload ...................................................................................................................................................52
The LAN interface ........................................................................................................................................53
The WAN interface.......................................................................................................................................54
DHCP parameters .........................................................................................................................................58
DNS parameters............................................................................................................................................59
NAPT parameters (LAN and WAN) ............................................................................................................60
IP parameters (LAN and WAN) ...................................................................................................................61
DHCP.....................................................................................................................................................................62
DHCP Server Commands................................................................................................................................62
DHCP Server - Nodes ........................................................................................................................................63
Lan0_pool Commands...............................................................................................................................63
Pool-manual-binding Commands ..............................................................................................................68
Lan0_pool Nodes.......................................................................................................................................70
DHCP Client - Commands.................................................................................................................................71
DNS ........................................................................................................................................................................72
DNS Commands..............................................................................................................................................72
DNS Nodes......................................................................................................................................................75
Host...............................................................................................................................................................75
Frame Service WAN Interfaces...........................................................................................................................76
HDLC encapsulation ....................................................................................................................................76
Frame Relay encapsulation...........................................................................................................................76
Wan-Frame-Service ......................................................................................................................................76
FRAME SERVICE WAN configuration ...........................................................................................................77
SERIAL-IFC commands ....................................................................................................................................77
FRAME-SERVICE commands..........................................................................................................................79
HDLC-IFC-x node ....................................................................................................................................80

ATOS User Guide


Index - 6 / 483

FR-IFC-x nodes ............................................................................................................................................80


TRAFF-CLASS-x node ................................................................................................................................83
Creating a new WAN-FRAME-SERVICE ........................................................................................................84
WAN-FRAME-SERV commands................................................................................................................84
WAN-FRAME-SERVICE - Nodes....................................................................................................................85
Service Commands ....................................................................................................................................86
Service - Nodes.............................................................................................................................................87
PPP Commands .........................................................................................................................................88
PPP Nodes .................................................................................................................................................89
CCP Nodes.................................................................................................................................................91
IP Commands.............................................................................................................................................92
IP Nodes.....................................................................................................................................................93
BridgePar Commands ................................................................................................................................94
Intrusion Detection System..................................................................................................................................95
IDS - Commands................................................................................................................................................95
IDS - Nodes........................................................................................................................................................95
IDSname - Commands..................................................................................................................................95
IDSname Nodes .........................................................................................................................................97
Alarm logs........................................................................................................................................................102
Intservices............................................................................................................................................................108
Intservices Commands ..................................................................................................................................108
IP ..........................................................................................................................................................................109
IP - Commands.................................................................................................................................................109
IP Nodes ........................................................................................................................................................110
Network groups Commands ....................................................................................................................110
Route Commands.....................................................................................................................................112
ROUTEMNG - Commands ........................................................................................................................114

ATOS User Guide


Index - 7 / 483

RIP Commands........................................................................................................................................117
BGP Commands ......................................................................................................................................120
OSPF Commands.....................................................................................................................................125
ISDN WAN Interfaces........................................................................................................................................133
Creating a WAN-ISDNx ..................................................................................................................................133
WAN-ISDNx Commands ................................................................................................................................133
Connect and Disconnect .............................................................................................................................135
WAN-ISDNx - Nodes ......................................................................................................................................135
PPP Commands .......................................................................................................................................135
PPP Nodes ...............................................................................................................................................136
IP Commands...........................................................................................................................................139
IP Nodes...................................................................................................................................................140
ISDNBUNDLE Commands......................................................................................................................141
ISDNBUNDLE\ISDNLINEx node...........................................................................................................142
LAN interfaces ....................................................................................................................................................144
LANx Commands .........................................................................................................................................144
LANx Nodes .................................................................................................................................................145
IP - Commands ...........................................................................................................................................145
BridgePar Commands ..............................................................................................................................146
LogicLANname - Commands.....................................................................................................................147
LANx L3_LogicLAN - Commands.........................................................................................................148
LANx L2_LogicLAN - Commands.........................................................................................................149
Phy - Commads...........................................................................................................................................150
L2switch Commads .................................................................................................................................150
LANx IP Nodes ....................................................................................................................................152
Loopback interfaces ...........................................................................................................................................155
Loopback Commands....................................................................................................................................155

ATOS User Guide


Index - 8 / 483

Monitor................................................................................................................................................................158
How to show the status of Aethra devices .......................................................................................................158
How to show statistics......................................................................................................................................158
ADSL statistics ...........................................................................................................................................159
How to show ATM statistics ......................................................................................................................160
How to show PPP statistics.........................................................................................................................161
How to show PPPoE statistics ....................................................................................................................162
How to show DHCP statistics.....................................................................................................................163
How to show IP statistics............................................................................................................................164
How to show statistics on voice interfaces .................................................................................................165
Multicast..............................................................................................................................................................167
Multicast Commands ....................................................................................................................................167
Multicast Nodes ............................................................................................................................................168
IGMP commands .....................................................................................................................................168
NAPT ...................................................................................................................................................................170
NAPT Commands .........................................................................................................................................170
NAPT Nodes .................................................................................................................................................172
Proxy...........................................................................................................................................................172
Alias............................................................................................................................................................173
Map .............................................................................................................................................................175
POTS and ISDN interfaces ................................................................................................................................177
Les Commands..............................................................................................................................................177
Les Nodes......................................................................................................................................................178
Cpiwfn - Commands...................................................................................................................................179
Cpiwfn Nodes ..........................................................................................................................................182
Potslinen / Isdnlinen Nodes .....................................................................................................................184
Voip Commands............................................................................................................................................187

ATOS User Guide


Index - 9 / 483

Voip Nodes....................................................................................................................................................193
Potsparameters Show configuration .......................................................................................................193
Rings Show configuration ......................................................................................................................195
Tones Show configuration ......................................................................................................................195
Timers Show configuration ....................................................................................................................196
Fax - Commands.........................................................................................................................................196
Sip - Commands .........................................................................................................................................198
Potslinen Commands ...............................................................................................................................200
Potslinen Nodes .......................................................................................................................................203
Isdnlinen Commands ...............................................................................................................................205
Isdnlinen Nodes .......................................................................................................................................209
DDIBundle Commands ...........................................................................................................................210
Quality of Service ...............................................................................................................................................215
An Overview ....................................................................................................................................................215
ATOS and QoS ................................................................................................................................................216
The DiffServ Model .........................................................................................................................................216
Classification ..............................................................................................................................................217
Marking.......................................................................................................................................................217
Metering......................................................................................................................................................217
Active Queue Management ........................................................................................................................218
Scheduling ..................................................................................................................................................219
Level 3 QoS.....................................................................................................................................................219
Level 2 QoS.....................................................................................................................................................220
ATM CLP Marking..........................................................................................................................................220
Configuring QoS ..............................................................................................................................................221
DiffServ Nodes ........................................................................................................................................221
DiffServ - Commands.................................................................................................................................222

ATOS User Guide


Index - 10 / 483

Level 3 Classifier Commands..................................................................................................................223


Level 2 Classifier Commands..................................................................................................................223
Level 3 Policy Commands.......................................................................................................................224
Level 2 Policy Commands.......................................................................................................................226
Level 3 / Level 2 Association - Commands................................................................................................227
A DiffServ level 3 configuration example..................................................................................................227
A DiffServ level 2 configuration example..................................................................................................231
Configuring ATMCLP .....................................................................................................................................233
ATMCLP Node .......................................................................................................................................233
ATMCLP policy Commands ...................................................................................................................234
An ATMCLP configuration example .........................................................................................................235
RAC .....................................................................................................................................................................238
RAC Nodes ...................................................................................................................................................238
Account - Commands .................................................................................................................................238
Address Commands .................................................................................................................................239
SDSL ....................................................................................................................................................................240
SDSL Commands..........................................................................................................................................240
SDSL Diagnostic Commands........................................................................................................................241
Security................................................................................................................................................................242
Introduction ......................................................................................................................................................242
IPSec operating modes ...............................................................................................................................243
Security protocols: AH and ESP.................................................................................................................244
Security Associations..................................................................................................................................244
Security Policy............................................................................................................................................245
IKE protocol.....................................................................................................................................................245
IKE Operation.............................................................................................................................................245
Phase 1 Main Mode with Preshared Keys ...............................................................................................246

ATOS User Guide


Index - 11 / 483

Phase 2 Aggressive Mode........................................................................................................................247


Phase 3 Quick Mode................................................................................................................................247
IKE-based Connection Maintenance................................................................................................................247
Security - Nodes...............................................................................................................................................248
Ike - Commands..........................................................................................................................................248
IPSec - Commands .....................................................................................................................................252
Crypto Commands ...................................................................................................................................253
Example ...........................................................................................................................................................255
SNMP...................................................................................................................................................................257
SNMP Commands.........................................................................................................................................257
Syslog ...................................................................................................................................................................259
Syslog Commands.........................................................................................................................................260
PTM0 interface ...................................................................................................................................................262
PTM0 Commands .........................................................................................................................................262
PTM0 Nodes .................................................................................................................................................263
IP - Commands ...........................................................................................................................................263
BridgePar Commands ..............................................................................................................................264
LogicLANname - Commands.....................................................................................................................265
LANx L3_LogicLAN - Commands.........................................................................................................266
PTM0 L2_LogicLAN - Commands.........................................................................................................267
PTM0 IP Nodes ....................................................................................................................................268
System..................................................................................................................................................................271
System Commands........................................................................................................................................271
System Nodes................................................................................................................................................273
Password - Commands ...............................................................................................................................273
Timesync - Commands ...............................................................................................................................273

ATOS User Guide


Index - 12 / 483

Virtual Private Network ....................................................................................................................................276


Operating mode................................................................................................................................................276
VPN Commands............................................................................................................................................276
VPN Nodes (PPTP protocol).........................................................................................................................279
VPNname Server Commands ...............................................................................................................280
VPNname PPP Commands...................................................................................................................280
VPNname PPP Nodes...........................................................................................................................281
Virtual Router Redundancy Protocol...............................................................................................................285
Overview ..........................................................................................................................................................285
VRRP - Commands..........................................................................................................................................285
VRRP - Nodes..................................................................................................................................................286
VRRPname - Commands............................................................................................................................286
VRRPname Nodes ...................................................................................................................................288
WAN Interfaces ..................................................................................................................................................289
WANx Commands ........................................................................................................................................289
Connect and Disconnect .............................................................................................................................290
WANx - Nodes.................................................................................................................................................290
Service Commands ..................................................................................................................................291
Service - Nodes...........................................................................................................................................292
PPP Commands .......................................................................................................................................293
PPP Nodes ...............................................................................................................................................294
CCP Nodes...............................................................................................................................................296
IP Commands...........................................................................................................................................297
IP Nodes...................................................................................................................................................298
ATM (AAL5) Commands .......................................................................................................................299
VC bundling................................................................................................................................................301
BridgePar Commands ..............................................................................................................................304

ATOS User Guide


Index - 13 / 483

Wireless LAN ......................................................................................................................................................305


Wireless Commands......................................................................................................................................305
Wireless Nodes..............................................................................................................................................307
AP - Commands..........................................................................................................................................307
AP - Nodes..................................................................................................................................................309
Security - Commands .................................................................................................................................309
Security Nodes.........................................................................................................................................310
XDSL VDSL2, ADSL2+..................................................................................................................................315
XDSL0 Commands .......................................................................................................................................315
How to check the xDSL status....................................................................................................................316
How to check the xDSL statistics ...............................................................................................................317
Appendix A : private MIB .................................................................................................................................319

ATOS User Guide


ATOS documentation - 14 / 483

ATOS documentation
Editing criteria
The following editing criteria are used in this manual:

terminal text: courier

users text: courier bold

characters entered by pressing CTRL and an alphanumeric key at the same time
(letter M in example) are shown as CTRL-M o ^M

the symbol indicates the ENTER or RETURN key

text next to symbol

indicates a note

text next to symbol

indicates an example

The following syntax is used in this manual:

optional commands are shown in square brackets ([ ])

alternative options are separated by |

ATOS User Guide


ATOS documentation - 15 / 483

Where to find the documentation


CD-ROM, World Wide Web
The CD-ROM supplied in the package contains the Aethra device manuals and other useful tools.
In http://www.aethra.com you can find:
Users Manual;
FAQs;
technical specifications;
a form used to contact Aethra and ask for additional information.

ATOS User Guide


How to use ATOS - 16 / 483

How to use ATOS (Aethra Telecommunications Operating System)


How to understand the ATOS structure using CLI commands
Configuration and Management
Local configuration and management are possible via the console port with Command Line
Interface (CLI) commands. The console port is connected to a TTY asynchronous terminal
(typically a Personal Computer with terminal emulation software1).
Procedures with CLI commands are used to:
B access diagnostics and command functions;
C monitor internal events;
D configure the device;
E

update the operating system.


The configuration structure is of hierarchical type. To access a parameter, you must reach the
corresponding node and enter the command.

How to start a CLI session


This section describes CLI commands. Additional configuration and control modes are illustrated
in the device Installation Manual.
Before accessing ATOS from CLI, you must:
F connect the PC to the device with the console cable supplied (MiniDin 8 pinout to
DB-9);
G start the terminal emulation software, such as Windows HyperTerminal, and configure the serial port with
the following parameters:
H

bits per second = 9600;

data bits = 8;

parity = none;

stop bits = 1;

flow control = none.

Now you can switch on the device and start the configuration procedure. To access the CLI enter
the username (1 character at least) and leave the password field empty. Once you have accessed the
CLI, you can change the password as desired.
Table 1 explains how to access the CLI and navigate through the nodes.

like Windows HyperTerminal

ATOS User Guide


How to use ATOS - 17 / 483

Table 1: CLI navigation


Prompt

How to enter

User name:

Enter any character.

Password:

The password field is empty by


default; you can configure different
passwords to differentiate User level
from Administrator level.

ATOS>

You have logged in as User. You can


only view the configuration and make
diagnostics tests (ping, atmping,
etc). You cannot change the
configuration parameters.

Enter quit to go back to User


name:.

ATOS>>

You have logged in as Administrator.


You have total control on the device.

Enter quit to go back to User


name:.

ATOS>>lan0

Enter the interface name (Lan0, Wanx)


to access the configuration mode.
Multiple commands are available for
each node.

Enter top to go back to


ATOS>> from any node. Enter
quit from any node to exit
the system. The next prompt is
User name: .

You can access all nodes in cascade


mode by entering the name of the most
internal node from the most external
node.

Enter up to go to the higher


node, without going back to
ATOS>>.

ATOS\lan0>>
ATOS>>wan1
ATOS\wan1>>quit
ATOS\lan0>>ip
ATOS\lan0\ip>>up
ATOS\lan0>>

How to exit

How to use the help or (?) commands


When yon need help on commands or options you can use the help command or the? command.
Table 2: help and ?
Prompt

Description

ATOS>>help

The help or ? command shows the commands and subnodes that


are available in the current node.

ATOS>>?
ATOS\lan0>>help
ATOS\lan0>>?
ATOS>>help lan0
ATOS\lan0>>set ?
ATOS\ip\route>>add ?

You can limit your search to a specific node. To do this, you can
access the desired node and enter help (or ?) or you can add the
node name to help.
The meaning changes if you enter the question mark after the set
or add commands. In this case the syntax and configurable
options are shown.

The <Tab> key can be used as editing accelerator to complete key words, that is to say
commands, nodes or values.

ATOS User Guide


How to use ATOS - 18 / 483

The CLI syntax


The following syntax is used in the CLI:
M < > identify a parameter;
N <value> indicates a numeric parameter;
O <string> indicates a string alphanumeric parameter;
P

<ip add> indicates an ip address parameter with format aaa.bbb.ccc.ddd (for example 10.0.0.1);

Q <ip name> indicate an ip host name parameter, for example with format www.xxx.ddd.com, (for example
www.aethra.com);
R the symbol | indicates an alternative parameter. For example, <value | TCP | UDP> indicates that the
parameter can be a number, TCP or UDP key word.

Configuration parameters
There are two types of configuration commands:
S

node-related commands:
these commands can be used only if you are in the correct node. For example, the download
command can only be used in the root node and is not accepted in any other node;

general commands:
these commands can be used in any node.

General commands
Tracert

Trace the list (address and name, if known) of routers for packet transmission.

tracert <ip add|ip name> [-h <max hops>] [-w <timeout>] [source <ip
add|ifc>] [-d]

Table 3: tracert
Syntax

Description

ip add|ip name

IP address or name of the destination host.

-w <timeout>

Wait/answer timeout in milliseconds for every attempt (default:


2000).

-h <max hops>

Maximum number of hops through routers to reach the destination


(default: 30).

Source <ip add|ifc>

Define the source ip address or the interface to use for the probes.

ATOS User Guide


How to use ATOS - 19 / 483

-d

Displays the address list.

Ping

Check if the host can be reached. The device sends a special packet (ICMP
Echo Request) to the destination host. The destination host acknowledges
receipt with an ICMP Echo Reply packet.

ping <ip add|ip name> [-l <size packets>][-n <number tries>][-i <ttl>]
[-w <timeout>] [-f] [source <ip add|ifc>] [-t]

Table 4: ping
Syntax

Description

ip add|ip name

Ip address or name of the destination host.

-l <size packets>

Packet length (default: 32).

-n <number tries>

Number of echo requests (default: 3).

-i <ttl>

"Time-to-live" (ttl) parameter (default: 64).

-w <timeout>

Wait/answer timeout in milliseconds for every attempt (default:


2000 msec.).

-f

Set the Do Not Fragment flag at 1 (default: 0).

Source <ip add|ifc>

Define the source ip address or the interface to use for the probes.

-t

Wait/answer timeout in milliseconds for every attempt (default:


2000 msec). The operation ends when you press Ctrl-C.

Arp

Resolve the MAC address of the IP address you have entered. The ARP cache
is displayed if you enter the arp command with no address.

arp <ip add>

Table 5: arp
Syntax

Description

ip add

Ip address of the host whose MAC address you want to resolve.

Atmping

Check the connection integrity over the ATM network. The device sends a
special loopback cell over the VP and VC. Once it has reached the destination,
the cell is re-transmitted by the receiver.

ATOS User Guide


How to use ATOS - 20 / 483

The VPI and VCI values for ATM connections are permanently assigned by the network
administrator. For information on values contact the network administrator.

atmping <vpi><vci>[-n <number tries>][-e][-s][-t]

Table 6: atmping
Syntax

Description

vpi

VPI value (Virtual Path Identifier).

vci

VCI value (Virtual Channel Identifier).

-n <number tries>

Number of echo requests (default: 5).

-e

Generate a loopback cell of end-to-end type (default).

-s

Segment-to-segment ping.

-t

Number of echo requests to infinity, alternatively to option -n. The


operation ends when you press Ctrl-C.

Resolve

Resolve an IP address in a host name or a host name in an IP address. The <ip


add|ip name> parameter can be the IP address or the name of the host to
resolve.

resolve <ip add|ip name>

Table 7: resolve
Syntax

Description

ip add |ip name

Ip address or name of the host to resolve.

Save

Save the current configuration. Changes are saved in the device and
implemented when the working conditions of the device allow for it.

Tree

Show the available nodes starting from the current one. When executed from
the main node (root), it displays the entire node tree to identify the parameter
you want to change.

ATOS User Guide


How to use ATOS - 21 / 483

Help

Show the available nodes starting from the current one, together with the
commands that can be given for the current node.

Show Conf

Show the configuration parameters of the current node and subnodes. The
parameter values are not shown if the node is an ON/OFF configurable node
and it is OFF.

Show Work

Show the working parameters of the current node and subnodes. If the node is
configurable as ON/OFF and is OFF, the node parameter values are not
shown.

Up

Return to the higher node.

Top

Return to the main node (root).

Quit or ^R

Close the CLI session (logout).

Step

This command is used for step-by-step configuration. The system allows you
to set the parameters of the current node and subnodes. Once you have set the
last configuration parameter, the system asks you to confirm the
modifications made (yes/no). You can exit the configuration mode by
entering ^U. You can enter ^X to skip the current node.
All parameters are offered in a sequence by giving the STEP command from
the main node (root).

Prompt
The prompt (>>) preceded by the device name and the node path is always shown when you use
the CLI for the configuration. The prompt is only preceded by the device name if you are in the
main node.
For example, the following prompt is shown if you have assigned the name AETHRA to the
device:
AETHRA>>
The prompt indicates that commands can be entered.

ATOS User Guide


How to use ATOS - 22 / 483

The command structure


The tree structure of the device is made up of the main node (root) and multiple subnodes. To reach
the desired node, you can enter the subnode path or go from node to node until you reach the
desired node.
To show the complete tree structure, you must enter the tree command from the main node. Next,
an example:
ATOS>>tree
top

system
napt
accesslist
wan1

password
timesync
proxy
alias
ppp

ip

lcp
authentication
ipcp
ccp
server
rip
nat

echorequest

mppe

atm
service
pppoe
bridgepar
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
wan16
ppp
lcp
echorequest
authentication
ipcp
ccp
mppe
server
ip
rip
nat
atm
service
pppoe
bridgepar
ip
route
rip
lan0
ip
rip
nat
bridgepar
phy2
l2switch3
port1
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
portx4
5
ip
rip
L2_LogicLAN

Node in devices where LANx interface is mapped onto a single physical Ethernet port.

Node in devices where LANx interface is mapped to an embedded MAC switch with multiple physical ports (e.g. 4 or 8
ports).
4

4 or 8 ports, depending on device model.

Dynamic node.

ATOS User Guide


How to use ATOS - 23 / 483

nat
bridgepar
vlan
L3_LogicLANErrore. ip
lan16

ip

rip
nat

rip
nat
bridgepar
phy

dhcp
dhcpclient
dns
host
adsl7
intservice
snmp
bridges
bridge1
spanningtreeprotocol
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
bridge4
spanningtreeprotocol
multicast
loopback
vpn
backup
qos
diffserv
level2
rac
account
address

Once you have identified the path to the subnode, you can enter the path directly:
ATOS>>system password
Confirm with <Enter> to go to the subnode:
ATOS\system\password>>
Now you can enter the set admin or set user command according to the password to change.

How to show the system configuration


You can show the system configuration with the show conf command.
You can show the working parameters with the show work command.
ATOS>>show conf
6

Node in devices with 2 different LAN interfaces.

ADSL, SDSL or VDSL, depending on devices.

ATOS User Guide


How to use ATOS - 24 / 483

show conf shows the parameter configuration of the current node and active subnodes.
ATOS>>show work
show work show the working parameters of the current node and active subnodes.
You can see the differences between configuration parameters and working parameters by
comparing show conf and show work.
ATOS>>full-conf
Show full configuration in CLI command format
ATOS>>conf
Show the configuration in CLI command format, without default system setting parameters

Step-by-step configuration
You can carry out the step-by-step configuration with the step command. The system shows the
sequence of parameters in the current node with subnodes. After the last parameter, the system asks
you to confirm the modifications made (yes/no).
You can exit the configuration mode by entering ^U. You can enter ^X to skip the current node.
ATOS>>step

How to save the configuration


The modifications made are implemented immediately only for some of the configuration
parameters. For the other parameters you need to restart the device.
The save command is used to save modifications in a configuration file contained in a nonvolatile memory. The file is loaded as working configuration after restart.

ATOS User Guide


How to use ATOS - 25 / 483

How to restore the default values


You can restore the factory configuration with the delete conf command given from any node.
This command deletes the configuration file you have created or updated with the save command.
Upon reboot, the device does not find the configuration file and restores the default configuration
values.
ATOS>>delete conf

The default passwords are not restored.


The device must be restarted (restart) to implement the command completely.
If you have deleted the configuration file by mistake, you can restore the current configuration
with the save command.

How to upload a file to a PC


ATOS allows to upload a configuration file or a log file to a PC. This is possible using the CLI (or
telnet), or the Web Browser with a TFTP server running on the pc or through the StarManager
application provided with the CD.
Via console, the command is:
ATOS>>upload ?
upload command parameters:
<file name string><server ip add>[-L]

Table 8: upload
Prompt

Description

file name string

Name of the file to save.

server ip add

IP address of the host with the TFTP server.

-L

This option must be used uploading a log file.

How to download a file from pc


Upgrading the operating system and the boot software is possible via CLI (or telnet) or the Web
Browser, using a server TFTP on PC, another way to do it is through the StarManager application,
provided with CD.
The command is:
ATOS>>download ?

ATOS User Guide


How to use ATOS - 26 / 483

download command parameters:


<file name string><server ip add>[-C|-B]

Table 9: download
Prompt

Description

file name string

Name of the file to load.

server ip add

IP address of the host with the TFTP server.

-C

This option must be used downloading the code file.

-B

This option must be used downloading the boot file.

Event visualization (log)


ATOS can memorize information to solve problems that can originate, for example, from the
incorrect operation of the line due to the erroneous configuration of the ATM connection
parameters or protocol used by the remote access server. The log level is configured for every
single node. The list of events is saved in an internal file and can be shown on the console port or
by connecting to the Telnet internal server.
The following commands are available in any position of the different menus, with the exception of
the set loglevel command that can only be given in enabled subnodes:
Table 10: log commands
Prompt

Description

log file

Save the log events in an internal file.

log console

Show the log events on the console port. The visualization can be
interrupted by pressing any key and restarted with the log
console command.

Log start

Show the log events on the console port. The visualization is not
interrupted by pressing any key but only press log stop command.

log file console

Acquire the log events in an internal file and shows them on the
console port. You can interrupt the visualization by pressing any
key. You cannot interrupt the acquisition on file.

log stop

Stop the acquisition of log events on file. The file remains available
until it is not overwritten with other acquisitions.

log view

Show the last acquisition made and saved on file. The device
returns: Nothing to show if the file contains no element.

ATOS User Guide


How to use ATOS - 27 / 483

set loglevel <0-5> [-s]

Configure the detail level used by ATOS to record the events:


0 no type of anomalous event is saved;
1 errors (i.e. protocol errors);
2 errors and first level warnings;
3 errors and second level warnings;
4 errors, first and second level warnings, first level signaling;
5 errors, first and second level warnings, first and second level
signaling;
-s when you select this option from a node, ATOS configures the
same log level on the current node and subnodes. This command
cannot be executed from the main node.

ATOS User Guide


Authentication, Authorization, Accounting - 28 / 483

Authentication, Authorization, Accounting.


AAA is a framework that allows the configuration of three independent security modes:
authentication, authorization, accounting.
Authentication provides a way of identifying each user by login and password, challenge and
response, messaging support and, depending on the security protocol selected, encryption.
Authorization checks and verifies the operations that the user is allowed to carry out in the network.
Accounting provides the possibility to trace the services users are accessing and how much of the
networks resources they are using.
In order to manage the security functions, Triple-A is generally based on RADIUS, TACACS + and
Kerberos protocols.
ATOS implements the AAA authentication function using the RADIUS (Remote Authentication
Dial In User) protocol. Moreover, ATOS also allows authentication via RAC (Remote Access
Configuration) of an internal user database.

Authentication by RADIUS protocol


RADIUS protocol, based on a client/server model, is used to transfer authentication information
between a NAS1 and an authentication server.
Transactions between the RADIUS client and server are authenticated using a shared private key.
The RADIUS client implemented in ATOS can support various authentication modes such as:
login, PAP2, CHAP3, MS-CHAP v1, MS-CHAP v2.
Authentication information can be provided to the RADIUS client:
by the login prompt, when connecting to the device via serial or telnet;
by a link framing protocol such as PPP, for a VPN PPTP connection.
Once the client has obtained the information, it sends the server an Access-Request packet
containing attributes such as username, password, ID client and port used.
If the password exists, it is encrypted using the MD5 alghoritm. If the client doesnt receive a reply
from the server in a defined time period, the authentication request is sent a further three times. On
failing to receive a reply from the first server, the client may send the request to other configured
RADIUS servers. When authentication fails, the RADIUS server sends an Access-Reject packet
that invalidates the user request. If the authentication conditions are satisfied, the RADIUS server
sends an Access-Accept packet containing the information needed to supply the service requested.
In PPP mode, for example, this information may include the keys for traffic encryption, wheras for
the login it shows the device access level (user or admin).

Network Access Server, client RADIUS.

Password Authentication Protocol.

Challenge Handshake Authentication Protocol.

ATOS User Guide


Authentication, Authorization, Accounting - 29 / 483

For "administrator" authentication use the following attributes:


Mandatory attribute "Service-Type" with Administrative value

attribute name = "Service-Type"

attribute number=6

attribute format=Enumerator

attribute value= Administrative user (6)

Optional attribute "Reply-Message"

attribute name = "Reply-Message"

attribute number=18

attribute format=String

For "user" authentication use the following attributes


Mandatory attribute "Service-Type" with Administrative value

attribute number=6

attribute format=Enumerator

attribute value= NAS Prompt (7)

Optional attribute "Reply-Message"

attribute name = "Reply-Message"

attribute number=18

attribute format=String

Authentication by RAC
RAC allows the creation of an authentication mechanism based on a local database containing a
group of users. Group membership, password and access level (user, administrator, superadministrator) are specified for each database user. Data stored in the RAC database is used by
NAS to validate the authentication request received from the user. For example, the username and
password sent by the user for a login or a PPP authentication by PAP, are compared with the ones
found in the RAC database.

Authentication profiles
An authentication profile must be created in order to perform AAA authentication. Each profile can
define up to two authentication modes, RADIUS and RAC, and in which order to perform them.
ATOS uses the second authentication mode only if the first does not reply. If the first authentication
mode is successful or fails, the process is blocked.

ATOS User Guide


Authentication, Authorization, Accounting - 30 / 483

AAA - Commands
ATOS\aaa>>set ?
Nodes not available.
Set command parameters:
local-ipaddress <ip addr>
loglevel
<value>
Table 11: set
Syntax
local-ipaddress

Description
<ip addr>

Set the RADIUS client IP address.

ATOS\aaa>>add[del] ?
add[del] command parameters:
<profile name string>

Table 12: add/del


Syntax

Description

profile name string

Name of the profile to create/remove.

ATOS User Guide


Authentication, Authorization, Accounting - 31 / 483

AAA - Nodes
AAAPROFILEname Commands
ATOS\aaa>>add AAAPROFILEname
Command executed
ATOS\aaa>>AAAPROFILEname
ATOS\aaa\AAAPROFILEname >>add[del] ?
Add[del] command parameters:
<rac|radius>
Table 13: add/del
Syntax

Description

rac|radius

Associate/disassociate the authentication profile to RAC or


RADIUS.

AAAPROFILEname Nodes
RAC - Commands
ATOS\aaa\AAAPROFILEname>>add rac
Command executed
ATOS\aaa\AAAPROFILEname>>rac
ATOS\aaa\AAAPROFILEname\rac>>set ?
Nodes not available.
Set command parameters:
account-group <string>
Table 14: set
Syntax

Description

account-group <string>

Define the user group name (max 64 characters) already configured


in ATOS\rac\account>>.

ATOS User Guide


Authentication, Authorization, Accounting - 32 / 483

RADIUS - Commands
ATOS\aaa\AAAPROFILEname>>add radius
Command executed
ATOS\aaa\AAAPROFILEname>>radius
ATOS\aaa\AAAPROFILEname\radius>>add ?
add command parameters:
<name|server ip addr><key string>[<authentication port>]
Table 15: add
Syntax

Description

<name|server ip addr>
<key string >
[<authentication port>]

Add a RADIUS server using its name or its IP address and


configure a public key shared with the server. The optional
parameter indicates the port used for the authentication.

ATOS\aaa\AAAPROFILEname\radius>>del ?
del command parameters:
<name|server ip addr>
ATOS\aaa\AAAPROFILEname\radius>>add 151.151.151.1 ciao
command executed
ATOS\aaa\AAAPROFILEname\radius>>add 161.161.161.1 hello
command executed
ATOS\aaa\AAAPROFILEname\radius>>add globe bye 2000
command executed
ATOS\aaa\AAAPROFILEname\radius>>show conf
Show of ATOS aaa AAAPROFILEname radius
server radius list
Show of ATOS radius server 1:
name|server IP address: 151.151.151.1
key string:
ciao
authentication port:
1812
Show of ATOS radius server 2:
name|server IP address: 161.161.161.1
key string:
hello
authentication port:
1812
Show of ATOS radius server 2:
name|server IP address: globe
key string:
bye
authentication port:
2000
command executed

ATOS User Guide


Access lists - 33 / 483

To enable the AAA profile select the system node and type:
ATOS\system>>set aaa-profile AAAPlofilename

ATOS User Guide


Access list - 34 / 483

Access lists
ATOS provides a powerful, flexible mechanism to protect the internal network from intrusions and
attacks and manage the access rights of individual hosts to external services.
For example, you can decide which stations can use e-mail, navigate on the Internet, access
programming, etc.

Especially if using the CLI, the configuration of the firewall functions requests the specific
knowledge of network protocols and is reserved to expert users.

The mechanism is based on the formulation of rules used to filter incoming and outgoing traffic.
The rules are contained in one or more lists, defined as access lists.
Each access list can be assigned to one or more interfaces (LANx, WANx). Multiple access lists can
be associated with each interface.
By assigning an interface to the access list, every incoming packet from the interface is checked
based on the rules of the list. .
Each rule contains a permission (permit) or negation (deny) clause. Three situations are
possible:
the packet does not meet the conditions of the rule: the packet is subjected to the next rule in the
access list;
the packet meets the conditions of the rule and the rule is a deny rule: the packet is discarded
immediately;
the packet meets the conditions of the rule and the rule is a permit rule: the packet is transmitted
to the routing function that routes the packet to the destination interface, without additional
checks.
If it does not meet any rule in the list, the packet is discarded.

It is recommended to consider all hosts in the LAN when you create access lists.

Creation and management of access lists


The configuration process of the access lists includes two steps:
you create one or more access lists with a sequence of rule for every access list;
you associate the access lists to one (or more) interfaces (LAN,WAN, virtual interfaces).
You can define up to 40 lists, with an indefinite number of rules for every list.

ATOS User Guide


Access list - 35 / 483

To create an access list you must access the accesslist node and use the add command. The
same command can be used to add rules to an existing access list.
The order used to include the rules in the list is important because the rules are used in the same
order they are created.

To implement the creation or modification of an access list, you have only to save
modifications without restarting the device. Moreover, you cannot use add/del
commands on an access list if it is already associated to an interface.

How to create an access list and a new rule


The add command is used to create a new rule. It can have the following formats:
for packets with TCP payload
add <name> [rule number] <permit|deny> <tcp|6> <src-address> <destaddress> [<ip-option>] <src-port> <dest-port> [<tcp-flag>] [src-ifc]
[ifc-opt]

for packets with UDP payload


add <name> [rule number] <permit|deny> <udp|17> <src-address> <destaddress> [<ip-option>] <src-port> <dest-port> [src-ifc] [ifc-opt]

for packets with ICMP payload


add <name> [rule number] <permit|deny> <icmp|1> <src-address> <destaddress> [<ip-option>] [icmp-type] [src-ifc] [ifc-opt]

for packets with a different protocol


add <name> [rule number] <permit|deny> <anyprot|0-255> <src-address>
<dest-address> [<ip-option>] [src-ifc] [ifc-opt]

Table 16: add


Syntax

Description

name

Name of the list (max. 32 characters) you want to create or add an


entry. A new list is created if you enter the add command with the
name of a non-existing list. It is recommended to use names that

ATOS User Guide


Access list - 36 / 483

easily identify the type of filter you want to create.


rule number

Number that identifies an entry (or a rule) of the list; leaving out
this parameter each entry added will have a progressive number.

permit|deny

If permit and the packet meets the rules, the packet is accepted
with no additional checks and sent to the routing function. If deny,
the packet is discarded immediately.

src-address

Value used to check the source address of the packet. The possible
values are shown in Table 17.

dest-address

Values used to check the destination address of the packet. The


possible values are shown in Table 17.

src-port

Value used to check the source port number of the TCP or UDP
packet.

dest-port

Value used to check the destination port number of the TCP or UDP
packet.

icmp-type

Value used to check the icmp-type field of the ICMP packet.

ip-option

Value used to check the IP option field of the packet.

Src_ifc

Source interface name, that can be chose from the list of the
interfaces (static or dynamic). In this mode, the filter is applied only
to the selected interface.

Ifc -opt

Option for the selected interface. If Src_ifc is Virtual Lan type


this parameter indicates the priority.
(ifc-opt = <0-7> priority value if <src-ifc> is Vlan type)

Adding a new entry (or a new rule) in a position already used cause the slipping of the
next pre-existent rules.

<src-address> and <dest-address>


indicate the values used to compare the source or destination address fields contained in the IP
header, respectively. They have the following syntax:
Table 17: values of <src-address> and <dest-address> fields
Syntax

Description

<ip address> <ip wildmask>

Address field obtained by combining ip-address with


ip-wildmask. It indicates the ip-address bits to include in
the comparison (value 1 in ip-wildmask position indicates that
the corresponding bit in ip-address must not be checked). Ipaddress and ip-wildmask are expressed in decimal dotted
notation (es. 192.168.110.231).

host ip address

Local host identified with a specific IP address.

host string

Local host identified with any of the names assigned by the DHCP
service of the router.

any

No check is carried out.

ATOS User Guide


Access list - 37 / 483

router

IP address of the device in the interface (LAN or WAN) to which


the list with this rule is assigned.

<src-port> and <dest-port>


are used for TCP and UDP packets. They indicate the value of the source or destination port field in
the header of the TCP or UDP packet. The syntax is:
Table 18: <src-port> and <dest-port> values
Syntax

Description

equ port

Port with port numeric value from 0 to 65535 or port from the ports
listed in Table 19.

range min-p max-p

Values from min-p to max-p (065535).

anyport

Any port.

The mnemonic values used with EQU are:


Table 19: EQU mnemonic values
Syntax

Description

dns

Domain Name Service (53).

ftp

File Transfer Protocol (21).

ftp-data

FTP data connections ( 20).

pop2

Post Office Protocol v2 (109).

pop3

Post Office Protocol v3 (110).

smtp

Simple Mail Transport Protocol (25).

snmptrap

SNMP Traps (162).

telnet

Telnet (23).

http

World Wide Web (http, 80).

tftp

Trivial File Transfer Protocol (69).

tcp-flag
is an optional parameter. If present, it indicates the values of the flag field of the TCP header.The
syntax is:
flag-value flag-wildmask

ATOS User Guide


Access list - 38 / 483

Table 20: campi flag


Syntax

Description

flag-value 0-65535

Value of the flag field.

flag-wildmask 0-65535

Indicate the lag-value bits to be included in the comparison


(digit 1 in any position indicates that the corresponding bit in
flag-value is not checked).

The flag weight for the two fields is:

URG 32

RST 4

ACK 16

SYN 2

PSH 8

FIN 1

icmp-type
is an optional parameter. If present, it indicates the values of the type field in the ICMP header.
The syntax is:
Table 21: icmp-type
Syntax

Description

O-255

Numeric value from 0 to 255.

echo-request

Echo request ICMP packet (icmp-type = 08).

echo-reply

Echo reply packet (icmp-type = 00).

<ip-option>
if present, indicates the values in the datagram option field of the IP header. The following
values can represent multiple simultaneous options:
Table 22: <ip-option> values
Syntax

Description

any option

Indicate the presence of any option.

security

Security option (02).

looserouting

Loose Source Routing option (03).

timestamp

Internet Timestamp option (40).

recordroute

Record Route option (07).

streamid

Stream ID option (08).

strictrouting

Strict Source Routing option (09).

sourcerouting

Loose and Strict Source Routing option (03 and 09).

ATOS User Guide


Access list - 39 / 483

How to delete an access list


The following command is used to delete an entry of the Access List or the whole Access List:
del <name> [rule number]

Table 23: del


Syntax

Description

<name>

Access list name.

[rule number]

Allow to delete only an entry of the access list, identified by its


position number. Leaving out this parameter the access list is
removed with all its entries.

Examples: how to block e-mail


To prevent host 192.168.118.70 from using e-mail, both incoming and outgoing, you can create an
Access List with the following rules:
ATOS\accesslist>>add nomail deny tcp host 192.168.118.70 any anyport
equ smtp
Command executed
ATOS\accesslist>>add nomail deny tcp host 192.168.118.70 any anyport
equ pop3
Command executed
ATOS\accesslist>>add nomail permit anyprot any any
Command executed

The first command creates the nomail Access List and defines the following rule:
discard (deny) packets that:
use the tcp protocol;
have 192.168.118.70 as source address;
have any value as destination address;
have any value as source port;
have the port reserved to the SMTP service as destination port.
The second command adds a second rule to the nomail list:
discard (deny) packets that:

ATOS User Guide


Access list - 40 / 483

use the tcp protocol;


have 192.168.118.70 as source address;
have any value as destination address;
have any value as source port;
have the port reserved to the POP3 service as destination port.
The last rule permits the transmission of packets that:
use any protocol;
have any value as source address;
have any value as destination address.

The last rule is essential for the correct routing of packets that are not used for e-mail.
The packets are discarded if this rule is not present.

Infact, the rule:

ATOS\accesslist>>add list-name permit anyprot any any

added in the last position of the list permits the transmission of all packets that do not correspond to
any of the rules above.

How to check an access list


Once you have created the nomail Access List you can check it with the show conf command:
ATOS\accesslist>>show conf
access list NOMAIL rule n.1
access right and protocol ..
source/dest address ........
ip option ..................
source/dest port ...........
tcp flag (value/wildmask) ..
access list NOMAIL rule n.2
access right and protocol ..
source/dest address ........
ip option ..................
source/dest port ...........
tcp flag (value/wildmask) ..
access list NOMAIL rule n.3

deny tcp
<host 192.168.118.70><any>
none
<anyport><equ smtp>
none
deny tcp
<host 192.168.118.70><any>
none
<anyport><equ pop3>
none

ATOS User Guide


Access list - 41 / 483

Access right and protocol .. permit anyprot


Source/dest address ........ <any><any>
IP option .................. none

After restart go to the CLI LAN0 node to associate the NOMAIL Access List with the LAN using
the following command:

Stargate\lan0>>set accesslistname NOMAIL


Command executed

How to block Internet access


To prevent hosts 192.168.118.70 and 192.168.118.71 from using the Internet, you can create an
Access List with the following commands:
ATOS\accesslist>>add NOINTERNET deny tcp 192.168.118.70 0.0.0.1 any
anyport equ http
Command executed
ATOS\accesslist>>add NOINTERNET permit anyprot 192.168.118.70 0.0.0.1
any
Command executed

You can show the configuration with the show conf command:
access list NOINTERNET rule n.1
access right and protocol .. deny tcp
source/dest address ........ <192.168.118.70 0.0.0.1><any>
ip option .................. none
source/dest port ........... <anyport><equ http>
tcp flag (value/wildmask) .. none
access list NOINTERNET rule n.2
access right and protocol .. permit anyprot
source/dest address ........ <192.168.118.70 0.0.0.1><any>
ip option .................. none

How to block ATOS management


To prevent management from LAN (Web and Telnet configuration) of host PC_1 you can create
an Access List with the following commands:

ATOS User Guide


Access list - 42 / 483

ATOS\accesslist>>add NOMANAGEMENT deny tcp host pc_1 router anyport equ


http
Command executed
ATOS\accesslist>>add NOMANAGEMENT deny tcp host pc_1 router anyport equ
telnet
Command executed

You can show the configuration with the show conf command:
access list NOMANAGEMENT rule n.1
access right and protocol .. deny tcp
source/dest address ........ <host pc_1><router>
ip option .................. none
source/dest port ........... <anyport><equ http>
tcp flag (value/wildmask) .. none
access list NOMANAGEMENT rule n.2
access right and protocol .. deny tcp
source/dest address ........ <host pc_1><router>
ip option .................. none
source/dest port ........... <anyport><equ telnet>
tcp flag (value/wildmask) .. none
access list NOMANAGEMENT rule n.3
access right and protocol .. permit anyprot
source/dest address ........ <any><any>
ip option .................. none

ATOS User Guide


Automatic CES 43 / 483

Auxiliary
This node allows managing optional devices for equipments that have a voice interface. At
present those devices are:
UPS (Unit Power Supplies);
UPS is an intelligent and recharging power supply backup unit; moreover it gives information
about life status and power charge of the internal battery through CLI. Messages sent deal with:
status of primary power supply;
charging level of the internal battery;
status of living time left for the battery;
status of battery failure.
Autoswitch;
it includes a splitter that let the device to be permanently connected to the PSTN, even before its
activation.

ATOS\auxiliary>>set ?
Nodes available:

ups
autoswitch

Set command parameters:


loglevel <value>

Autoswitch
ATOS\auxiliary\autoswitch>>set ?
Nodes not available.
Set command parameters:
auto-switch-enab <off|on>

Table 24: autoswitch

UPS

Syntax

Description

auto-switch-enab <off|on>

Disable/enable autoswitch management from Aethra device.

ATOS User Guide


Automatic CES - 44 / 483

ATOS\auxiliary\ups>>set ?
Nodes not available.
Set command parameters:
loglevel
<value>
emerg-type
<no-emergency|emergency-limited|emergency-nolimited>
power-trap-enab
<off|on>
batt-low-trap-enab <off|on>
batt-deg-trap-enab <off|on>
batt-fail-trap-enab <off|on>

Table 25: UPS


Syntax

Description

emerg-type

Working mode without primary power supply:


normal power supply;
power supply limited to 50mA and inverted alimentation for the
ISDN interfaces;
power supply not limited but inverted alimentation for the ISDN
interfaces.

<no-emergency|
emergency-limited|

emergency-no-limited>
power-trap-enab <off|on>

Disable/enable trap messages about primary power supply lack.

batt-low-trap-enab <off|on>

Disable/enable trap messages about flat internal battery.

batt-deg-trap-enab <off|on>

Disable/enable trap messages about degraded internal battery.

batt-fail-trap-enab <off|on>

Disable/enable trap messages about out of use internal battery.

Typing show status through CLI it will be displayed:


ATOS\auxiliary\ups>>show status
Power supply status: main power on
Battery status: battery charging
Battery charge: 105
Battery degrade: 00
Battery voltage: 19,94

Battery charge and Battery degrade values are expressed in percentage.

ATOS User Guide


Bridges - 45 / 483

Bridges
The bridge function is used to connect two or more interfaces using a transmission device. A
selective action is carried out on traffic.
The bridge has two different functions:
to send packets from the input port to one or more output ports (forwarding process);
to learn the hosts connected to the interfaces (learning process).
To execute the learning process, the bridge analyses the header of every Ethernet frame received
over the interfaces and saves the MAC source address and identifier of the transmitting interface,
adding an entry in the forwarding table (filtering database).
The information is used to determine the output port/s of the frame during the forwarding process:
The filtering database contains dynamic entries and static entries:
static entries are managed by the management level and permanently saved in the database;
dynamic entries are managed by the learning process: they can be added, updated or deleted from the database.
Another functionality of the bridge is the spanning tree process. This process periodically converts
networks with closed loops into a tree to eliminate circular paths where the bridge does not operate
correctly. Broadcast or multicast frames transmitted over networks with loop would be indefinitely
transmitted over the network by the bridges.
ATOS can act as bridge and router at the same time through the selection of incoming traffic over
the interfaces. Incoming packets havig destination MAC address as device MAC address (LAN
interface) will be routed.
From version 2.7 ATOS allows to choose politics of forwarding for broadcast and multicast traffic.
Using default configuration (full-service-mode off)broadcast and multicast packets are
sent to all bridged interfaces except the souce interface. Enablig the full-service-mode
parameter,
broadcast traffic that comes from WAN interface is discarded;
broadcast traffic that doesnt come from WAN interface is forwarded to bridged interfaces;
multicast traffic that comes from LAN interface is forwarded to router;
multicast traffic that doesnt come from LAN interface is forwarded to LAN interface.

The connection is immediately cleared if you access the internal WEB server over the
LAN and the LAN is only enabled to bridging. The connection with the WEB server can be
restored only through the locale console with the activation of the routing function over
the LAN.

Bridges Nodes
The bridging functionality can be configured in the following nodes of the CLI tree:
the bridges node with four subnodes (bridge1, bridge2, bridge3, bridge4). Every node includes the
spanningtreeprotocol subnode;
the set bridging <on|off> command for every WAN or LAN node.

ATOS User Guide


Bridges - 46 / 483

ATOS allows you to define up to four bridge typologies (classes). Every LAN or WAN interface is
enabled to bridging by associating it with one bridge class.
You can configure the system to act as bridge between the LAN and one ore more WAN interfaces.

Bridge1/4 Commands
ATOS\bridges\bridge1>>set ?
Nodes available:
spanningtreeprotocol
Set command parameters:
<on|off>
maxentry
ageingtime
spanningtree
ethernettypeprotocol
interwanforwarding
full-service-mode
loglevel

<1024|2048|4096|8192>
<value>
<on|off>
<permit|deny>
<on|off>
<on|off>
<value>

Table 26: set


Syntax

Description

on|off

Activate/deactivate the bridge class (default: off).

maxentry
<1024|2048|4096|8192>

Maximum number of static and dynamic entries memorized by the


bridge in the filtering database (default: 1024).

ageintime <value>

Time in seconds after which the dynamic entry is deleted from the
database. Range: 10~100 000, default: 300 seconds.

spanningtree <on|off>

Activate/deactivate the bridge to spanning tree protocol management.


Default: off.

ethernettypeprotocol
<permit|deny>

Permit or deny the transmission in bridging mode of packets from


protocols included in Ethernet protocol list created with the add
command. Default: deny.
Empty list and deny: all packets are transmitted in bridging mode;
list with entries and deny: all packets are transmitted in bridging
mode except for packets related to protocols in the list; list with
entries and permit: only packets related from protocols in the list
are transmitted in bridging mode.

interwanforwarding <on|off>

Enable/disabile bridged traffic forwarding between WAN interfaces.


Default: off, it means that packets from WAN are not forwarded to
other WAN interfaces of the same bridging class.

full-service-mode <on|off>

Enable/disable full-service mode, allowing an advanced


bridged traffic control.

Loglevel <value>

It sets the detail level used by ATOS to record the bridge events of
the BRIDGEx node.

ATOS User Guide


Bridges - 47 / 483

ATOS\bridges\bridge1>>add ?
add command parameters:
add <mac-address aa-bb-cc-dd-ee-ff><device-name string> for add to
bridge list
add <ethernet type protocol|hex value> for add to type list

ATOS\bridges\bridge1>>del ?
del command parameters:
del <mac-address aa-bb-cc-dd-ee-ff><device-name string> for del
from bridge list
del <ethernet type protocol|hex value|all> for del from type list

Table 27: add - del


Syntax

Description

<mac-address aa-bb-cc-ddee-ff>

Add/remove static entries of the filtering database to rigidly


associate the MAC address to the interface (LAN0 or ATM_VCx).
You can add up to 256 static entries.

<device-name string>
ethernet type protocol|hex
value

Add/remove the entry to the Ethernet protocol list used to permit or


deny the bridge between the interfaces. You can enter the protocol
name or hexadecimal value.

ATOS\bridges\bridge1>>add 00-d0-d6-00-01-07 atm_vc0


Command executed
ATOS\bridges\bridge1>>
ATOS\bridges\bridge1>>del 00-d0-d6-00-01-07 atm_vc0
Command executed

Spanning Tree Protocol Commands


ATOS\bridges\bridge1\spanningtreeprotocol>>set ?
Nodes not available.
Set command parameters:
bridgepriority
<value>
hellotime
<value>
forwarddelaytime <value>
maxage
<value>

ATOS User Guide


Bridges - 48 / 483

Table28: set
Syntax

Description

bridgepriority <value>

Priority assigned to bridge.


Range: 0~65535, default: 32768.

hellotime <value>

Periodical time in seconds for generation of Configuration BPDU


packets. Range: 1~10, default: 2 seconds.

forwarddelaytime <value>

Time in seconds used to delay changes in the port status


(listeninglearning, learningforwarding) or force aging time of
static entries of the filtering database to a lower value when
topology changes are detected. Range: 4~30, default: 15 seconds.

maxage <value>

Time in seconds since the reception of the last BPDU after which
the BDDU is considered invalid. Range: 6~40, default: 20.

ATOS User Guide


Configuration via Telnet- 49 / 483

Configuration via Telnet


The configurations described in the sections above can also be executed with a PC connected over
the LAN of the Aethra device in a Telnet session.
Unlike configuration via serial port, you must know the local IP address assigned to the device
(default: 10.0.0.1).
To access the configuration via Telnet:
start Telnet;

from Connect select Remote System and enter the IP address assigned to the device in the
Host name field. Confirm with Connect;

now you can enter the username and password. Configuration modes are the same as the ones used
by the CLI console.

ATOS User Guide


Configuration via WEB - 50 / 483

Configuration via WEB


Aethra devices incorporate a Web server to make parameter configuration and management easier
for less expert users.
From a PC connected in the LAN you can access the configuration pages with a browser (i.e.
Microsoft Explorer or Netscape) by entering the local IP address of the device (default: 10.0.0.1) or
the device name shown on the left side of the prompt in case of access via CLI. If the device
address is not compatible with the local network, you can change it using the CLI.
If you are creating a new LAN you can connect the PCs to obtain all TCP/IP parameters from
ATOS. The DHCP server functionality is enabled by default.
The factory configuration doesnt require a password, but the administrator can configure it on
System node.

Home page
The home page is displayed after the authentication procedure.
The home page depends on the device.

For quick configuration select Quick Start.


Enter the information received from the ISP to
configure the Internet access.
For detailed configuration select Advanced
Setup.

ATOS User Guide


Configuration via WEB - 51 / 483

Detailed configuration via Web

This page is displayed after select the


Advanced Setup link;
to access the parameter page select the desired
link on the left;
to save the modifications made click Save.
Some parameters require the Restart to be on
the working configuration.

System

To change the device name, enter the new name


in the corresponding field;
to configure a TFTP Server, insert its IP address
instead of 0.0.0.0;
to authenticate using a AAA profile, select a
profile previously configured;
to update the device internal date and time,
enter the new values in the corresponding fields
and confirm;
to cancel the modifications made without
saving, select Reset;
to change the password, select the
corresponding link;
to get information on the device firmware,
select the corresponding link.

ATOS User Guide


Configuration via WEB - 52 / 483

File-Download
TFTP Download:
download ATOS from a TFTP Server;
download boot from a TFTP Server;
download an existing configuration from a
TFTP Server.
HTTP Download:
download an existing configuration from an
host;
download ATOS from an host.

File-Upload
TFTP Upload:
upload the current configuration to a TFTP
Server;
upload the log file to a TFTP Server.
HTTP Upload:
upload an existing configuration to an host;
upload an log file to an host.

ATOS User Guide


Configuration via WEB - 53 / 483

The LAN interface


You can configure the TCP/IP parameters of the local network connected to the device with
LAN0:

Select LAN0;

enter the local IP address of the device and


netmask;
select the desired options according to your
requirements;

confirm your selections.

ATOS User Guide


Configuration via WEB - 54 / 483

The WAN interface


Aethra devices can use up to 10 WAN interfaces. To configure a specific WAN interface, select the
corresponding option and change the parameters. Some of the parameters must be obtained from
the telephone provider. For example, if you select WAN1 you can access the WAN service
parameters directly.
Enable the WAN. In the pull-down menu select
the WAN connection mode from IP (RFC
1483), PPP over AAL5 (RFC 2364) and PPP
over Ethernet (RFC 2516). The selection
depends on the mode offered by the service
provider;
enable/disable the device remote management
over the WAN;

select the encapsulation type (LLC/SNAP or


VC-mux) according to the server mode.

Complete the configuration according to the connection mode.

ATOS User Guide


Configuration via WEB - 55 / 483

PPP mode over AAL5 (RFC 2364)


The following page appears if you select PPP (on top).

The default parameters are suitable for all types


of connections, except for special requirements.

Enter User Name and Password given by


the Provider. These values are also valid for
PPP over Ethernet (PPPoE);
select the permitted type of authentication. The
default configuration is normally
recommended;

confirm the selections made and save them.

ATOS User Guide


Configuration via WEB - 56 / 483

PPP mode over Ethernet (RFC 2516)


If the Provider uses the PPPoE (RFC 2516) encapsulation mode select the corresponding option for
parameter configuration.

The default parameters are suitable for all types


of connection, except for special requirements.

ATOS User Guide


Configuration via WEB - 57 / 483

IP mode (RFC 1483)


This mode is generally used in LAN to LAN connections or when the Provider makes a static IP
address available.

Select the IP option:


enter the public IP address of the device (this
value is informed by the Provider or network
administrator in case of LAN to LAN
connection)1 and Net Mask;
enter the IP address used to reach the remote
network;
activate/deactivate the NAPT functionality
(configured in the NAPT page);
activate and select the RIP mode used in the
WAN.
enter the IP address for the NAPT as an
alternative to the public address (if available);
enter the Alias of the list you have created in
the NAPT page.

ATM parameters
To configure the ATM parameters select the ATM link corresponding to the WAN used (WAN1,
WAN2, ). You must configure the correct VPI and VCI values given by the ADSL or SHDSL
service provider too.

In the other cases (PPPoA and PPPoE), the assigned address is negotiated with the server during the configuration of the
PPP session when the address can be dynamically assigned by the PPP server. If the IP address is modified by the access
server during the PPP configuration phase, the subnet mask is changed into the subnet mask of the class of the assigned
address

ATOS User Guide


Configuration via WEB - 58 / 483

Select ATM;
enter the VPI and VCI values received from the
ADSL or SHDSL service provider;
do not change the ATM speed (Upstream),
except for special requirements;
confirm the selections made.

DHCP parameters
The DHCP server is enabled by default in Aethra devices. The DHCP server allows the devices
connected to the Ethernet ports to obtain the TCP/IP configuration upon when they log on. This
functionality provides easy network management since the same configuration can be used for all
connected devices, without having to assign the TCP/IP parameters manually to every PC.

If present, select the option "lan0_pool";


otherwise create a pool inserting a name and the
interface to which associating those pool.

ATOS User Guide


Configuration via WEB - 59 / 483

Enter the first and last IP address assigned to


the hosts by the DHPC server;
configure the default router, if necessary;

enter the host name base used to assign names


to the hosts (the host name of the first PC to
logon is PC_1 in the example);
enter the domain name assigned to the
connected hosts.

DNS parameters
ATOS delivers the DNS server/forwarder functionality to make PC configuration and installation
over the LAN easier. When the DNS server/forwarder functionality is active, the queries of a host
name can be resolved by the device directly.

Select DNS on top left;


activate/deactivate the local DNS.

ATOS User Guide


Configuration via WEB - 60 / 483

Do not change the parameters above, except for special requirements.

Select DNS Server List to access the


configuration page of additional DNS servers to
delete any DNS you have added, or to add a
DNS from a WAN interface, or to add a DNS
by knowing the IP addresses.

NAPT parameters (LAN and WAN)


Aethra devices support the NAT (Network Address Translation) and PAT (Port Address
Translation) functionality. To access the configuration via web:

Select NAPT;
activate/deactivate the NAPT mode;
do not change the parameters, except for special
requirements;
enter the IP address of the LAN internal server
that answers to incoming connection requests
from the WAN;
activate only if you use special applications (i.e.
H323 protocol);
add specific server proxies according to service
and service port.

ATOS User Guide


Configuration via WEB - 61 / 483

IP parameters (LAN and WAN)


ATOS can receive and transmit information on routing tables (RIP) to other routers connected over
the LAN and WAN. For parameter configuration select IP in the left frame.

Select IP;

add static routes to reach destinations from the


ones known by routers directly connected over
the WAN.

Do not delete the local route from the list to avoid malfunctioning over the LAN.

ATOS User Guide


DHCP - 62 / 483

DHCP
The default configuration in ATOS use the DHCP server with lan0_pool node parameters. In
this way devices connected to Ethernet ports obtain the TCP/IP configuration when they are started.
Besides lan0_pool, that can be modified or deleted, other dynamic subnodes can be created.
This functionality provides easy network management for administrators, because the same
configuration can be used for all devices, without having to assign the TCP/IP parameters to every
PC manually.

DHCP Server Commands


In the default configuration file the DHCP server is enabled and uses lan0_pool associated to
ATM_VC0 interface (WAN1).
ATOS\dhcp>>set ?
Nodes available:
lan0_pool
Set command parameters:
<on|off>
server-timeout
<value>
loglevel
<value>
Table 29: set
Syntax

Description

on|off

Activate/deactivate the DHCP server [default: off].

server-timeout <value>

Configure, in milliseconds, the time after that the device reply to a


DHCP request if no other DHCP server has already replied to. The
default value is 1000ms., the configurable range is 0-30000.

loglevel <value>

Set the detail level used by ATOS to record the events of the DHCP
server operations. [default: 1]

ATOS\dhcp>>add ?
add command parameters:
<pool name string><ifc name string>[MANUAL-BINDING]
LIST OF AVAILABLE INTERFACES
LAN0
ATM_VC0
.......
.......
ATM_VC7

ATOS User Guide


DHCP - 63 / 483

Table 30: add


Syntax

Description

pool name string

An alphanumeric string identifies pool, 32 characters max. Up to 32


pool can be created.

ifc name string

String that identifies the interface (LANx, ATM_VCx, vlan, ).

manual-binding

If MANUAL-BINDING option is specified, the created pool will


be manual binding type where it is possible to release for a specific
client (the pool is built only for one client), a specific IP Address.
The association is identified through the client Id or HW Address
(such as the client MAC ADDRESS).
In addition, all other DHCP parameters are offered in the Offered
DHCP phase.

ATOS\dhcp>>del ?
del command parameters:
<pool name string>

Table 31: del


Syntax

Description

pool name string

An alphanumeric string identifies pool, 32 characters max.

DHCP Server - Nodes


Lan0_pool Commands
ATOS\dhcp\lan0_pool>>set ?
Nodes available:
relay
Set command parameters:
more...[y][n]?
learning
learning-wan
startaddress
endaddress
netmask
defaultrouter
dns1
dns2
wins1
wins2

<on|off>
<wan1|wan2|wan3|wan4|wan5|wan6|wan7|wan8>
<ip addr>
<ip addr>
<ip addr>
<ip addr>
<ip addr>
<ip addr>
<ip addr>
<ip addr>

ATOS User Guide


DHCP - 64 / 483

leasetime
hostname
domainname
server-name
boot-file-name
boot-file
next-server

<value>
<string>
<string>
<string>
<string>
<string>
<ip addr>

Table 32: set


Syntax

Description

learning <on|off>

Activate/deactivate the DHCP learning mode. This mode allows the


device to accept a pool of IP addresses for the DHCP released by
the remote PPP server.

learning-wan
<wan1|wan2||wan16>

Associate the DHCP learning mode to the WAN.

startaddress <ip addr>

Indicate the first address that the DHCP server can use for
assignment to hosts in the LAN (default: 10.0.0.2, i.e. the IP address
after the default address assigned to the device over LAN).

endaddress <ip add>

Indicate the last address that the DHCP server can use for
assignment to hosts in the LAN (default: 10.0.0.50, i.e. a pool of 49
addresses.

defaultrouter <ip addr>

Default router address. The information is included in the


configuration assigned by the DHCP server to the hosts in the LAN
(default: address assigned to the device in the LAN).

dns1 <ip addr>

Primary DNS address (default: address assigned to the device in the


LAN0). The information is included in the configuration assigned
by the DHCP server to the hosts in the LAN0.

dns2 <ip addr>

Secondary DNS address (default: 0.0.0.0). The information is


included in the configuration assigned by the DHCP server to the
hosts in the LAN.

wins1 <ip addr>

WINS address (default: 0.0.0.0). The information is included in the


configuration assigned by the DHCP server to the hosts in the LAN.

wins2 <ip addr>

Secondary WINS address (default: 0.0.0.0). The information is


included in the configuration assigned by the DHCP server to the
hosts in the LAN.

leasetime <value>

Time in seconds during which the use of the assigned address is


guaranteed to the host. Range: 0-32767 ,0=disable, default: 2000.

hostname <string>

Basic name assigned to the hosts (0-20 characters, default: PC_ ).


Hosts are assigned a name made up of the basic name followed by
two decimals (i.e. PC_01, PC_02).

domainname <string>

Domain name assigned to the hosts with 0-23 characters, default:


DomName.

server-name <string>

Set the TFTP server name (option 66). The information is included
in the configuration assigned by the DHCP server to the hosts in the
LAN. [max 32 char]

boot-file-name <string>

Set the Boot file name name (option 67). The information is
included in the configuration assigned by the DHCP server to the
hosts in the LAN. [max 32 char]

boot-file

Set a Boot file string. It is refered to the file field header of the
DHCP ACK packet (RFC2131)

ATOS User Guide


DHCP - 65 / 483

next-server

Specifies the TFTP server IP address usually used by IP Phone to


download the boot file

You can activate the DHCP learning when you operate with PPP encapsulation. During the initial
negotiation the remote PPP server releases a pool of addresses (one IP address and one subnet
mask defining the number of usable addresses). The PPP client dynamically overwrites the DHCP
fields with the new values that remain valid until the connection is active. The DHCP distributes
these values to the hosts in the local network that request them. This mode allows the network
administrator to configure both WAN and LAN address dynamically from remote.

The addresses of the pool used by the DHCP server must be compatible with the address assigned
to the device over the LAN.

Dynamic lan0_pool node allows to define:


a static association between the host mac address and the IP address that a DHCP server releases to
that host;
a list of hosts, each identified by its mac address, that cannot accept an IP address released by a
DHCP server .
ATOS\dhcp\lan0-pool>>add ?
add command parameters:
STATIC-ASSOCIATION <ip addr><mac addr>
EXCLUDED-HOST
<mac addr>
EXCLUDED-ADDRESS
<start ip addr>[<end ip addr]
OPTION <option-code> HEX <hex value> <hex value> <hex value> ...
OPTION <option-code> ASCII <string>
OPTION <option-code> IP <ip addr> <ip addr> ...

ATOS\dhcp\lan0-pool>>del ?
del command parameters:
STATIC-ASSOCIATION <ip addr>
EXCLUDED-HOST
<mac addr>
EXCLUDED-ADDRESS
<start ip addr>
OPTION <option-code>
Table 33: add/del
Syntax

Description

static-association
<ip addr><mac addr>

Associates a device mac address to an IP address released by a


DHCP server. Up to 128 entries can be added.

excluded-host <mac addr>

Indicates, by the mac address, the host that cannot have an IP

ATOS User Guide


DHCP - 66 / 483

address from a DHCP server. Up to 128 entries can be added.


EXCLUDED-ADDRESS

Allows to exclude an IP address contained in a DHCP pool


addresses. If end-address is specified a whole range can be
excluded..
If the DHCP pool is active, every changed is performed
immediately.
If the DHCP is not active, that means no restart is done after
creating the new pool, every add/del entry will be active after a
restart.
Up to 128 excluded host range can be defined.
The following warning or error can be show when a wrong
command is typed:
"End address must be greater than start address
- if start address is greater than end address,
"Excluded addresses must be inside pool
- if it is defined a range out of the pool ,
"Excluded addresses already defined "
- if an excluded range is already defined,
"List of excluded address full
- if 128 excluded ranges are just defined
"Warning some excluded ip address are already in use
- if one or more IP address are excluded, and those IP are just in
use, it is recommended to perform a restart to right manage the
DHCP client request.

OPTION <option-code>

Specifies the DHCP option code (from 1 to 255)


HEX indicates that the option value is expressed by a sequence of
bytes in hexadecimal annotation, separated by space.
Each number can express up to 4 bytes, depending of the
hexadecimal digits written:
1 or 2 hexadecimal digits express 1 byte
3 or 4 hexadecimal digits express 2 bytes
5 or 6 hexadecimal digits express 4 bytes
7 or 8 hexadecimal digits express 4 bytes.
ASCII indicates that the option value is referred to ASCII string.
It cannot be separated by space
IP indicates that the option value is expressed as a punctual dotted
IP address.
To define several IP address space must be used from an IP
address value and the other.
Up to 16 option-code for each type of expression used can be
created. The maximum value length is 32 bytes.

ATOS User Guide


DHCP - 67 / 483

Examples:
Add option 128 hex 0F
indicates that the option 128 has 1 byte, the decimal value is 15 and
it will be coded in DHCP packet 0x80 0x01 0x0F
Add option 128 hex 000F
indicates that the option 128 has 2 bytes, the decimal value are 0
and 15 and it will be coded in DHCP packet 0x80 0x02 0x 00 0x0F
Add option 128 hex 0B0AF1
indicates that the option 128 has 3 bytes, the decimal value are 11,
10 and 241 and it will be coded in DHCP packet 0x80 0x03 0x0B
0x0A 0xF1
Add option 128 ip 192.168.0.1
indicates that the option 128 has as value an IP address 192.168.0.1
and it will be coded in DHCP packet 0x80 0x04 0xC0 0xA8 0x00
0x01
Add option 128 ip 192.168.0.1 192.168.0.2
indicates that the option 128 has 2 ip address value: 192.168.0.1 and
192.168.0.2. It will be coded in DHCP packet 0x80 0x08 0xC0
0xA8 0x00 0x01 0xC0 0xA8 0x00 0x02
Add option 128 ascii abcde
indicates that the option 128 has abcdee as string value and it will
be coded in DHCP packet 0x80 0x05 0x61 0x62 0x63 0x64 0x65

ATOS\dhcp\lan0-pool>>show conf
Show of ATOS dhcp lan0-pool
dhcp learning
: off
wan for learning
: wan1
first address of pool
: 192.168.110.100
last address of pool
: 192.168.110.200
netmask
: 255.255.255.0
address default router : 192.168.110.1
address primary dns
: 192.168.110.1
address secondary dns
: 0.0.0.0
address primary wins
: 0.0.0.0
address secondary wins : 0.0.0.0
lease time
: 7200
host name
: pc_0
domain name
: localdomain
interface
: lan0
static association list
ip address
mac address
192.168.110.110
01-01-01-01-01-10
192.168.110.109
01-01-01-01-01-09

ATOS User Guide


DHCP - 68 / 483

192.168.110.108
192.168.110.107
192.168.110.106
192.168.110.105
192.168.110.104
192.168.110.103
192.168.110.102
192.168.110.101
192.168.110.100

01-01-01-01-01-08
01-01-01-01-01-07
01-01-01-01-01-06
01-01-01-01-01-05
01-01-01-01-01-04
01-01-01-01-01-03
01-01-01-01-01-02
01-01-01-01-01-01
01-01-01-01-01-00

excluded host list


mac address
01-01-01-01-02-10
01-01-01-01-02-09
01-01-01-01-02-08
01-01-01-01-02-07
01-01-01-01-02-06
01-01-01-01-02-05
01-01-01-01-02-04
01-01-01-01-02-03
01-01-01-01-02-02
01-01-01-01-02-01
01-01-01-01-02-00
show of ATOS dhcp lan0-pool relay
dhcp relay enable : on
list of dhcp server
1.2.3.4
Command executed

Pool-manual-binding Commands
When the MANUAL-BINDING option is selected a manual binding DHCP pool will be created,
where for a certain client (pool for a unique client), identify by a client id or a HW address, it is
possible to release a specific IP address and other DHCP parameters.
ATOS\DHCP>>ADD <pool name string><ifc name string> MANUAL-BINDING
In the pool-manual-binding node, all DHCP parameters contemplate by ATOS can be configured.
Moreover, in this case, two additional settings can be done:
ATOS\DHCP\pool-manual-binding-xxx>>set ?
Set client-id <string hex value>
Set hw-address <string mac address>
Set address < ip addr >

ATOS User Guide


DHCP - 69 / 483

Table 34: set


Syntax

Description

Set client-id
<string hex value>

Individuates the client-id parameter to assign the unique IP address


released by the DHCP server pool.
The string value must be in dotted hexadecimal notation format (eg.
00.1.03.A.0B.CC.DD.EE.FF.41.01).
If client-id string is configured, no hw-address string mac address must
be present.

Set hw-address
<string mac address>

Individuates the HW address parameter (typically the MAC


ADDRESS) to assign the unique IP address released by the DHCP
server pool.
The string value must be in dotted hexadecimal notation format (eg.
01.02.0A.0B.0C.0D)
If hw-address mac address string is configured, no client-id string must
be present.

Set address
<ip addr>

Configures the unique ip address released by DHCP server for this


pool.
The address selected must not be present in any other pool

Summary of the set parameters for this kind of pool is the following:
ATOS\Dhcp\pool-manual-binding-xxx>>set ?
Nodes not available.
Set command parameters:
client-id
<string>
hw-address
<string>
address
<ip addr>
netmask
<ip addr>
defaultrouter <ip addr>
dns1
<ip addr>
dns2
<ip addr>
wins1
<ip addr>
wins2
<ip addr>
leasetime
<value>
hostname
<string>
domainname
<string>
server-name
<string>
boot-file-name <string>
boot-file
<string>
next-server
<ip addr>

As in the normal pool, in the Manual binding pool it is possible to specify DHCP option code
(from 1 to 255), using the following command:

ATOS User Guide


DHCP - 70 / 483

ATOS\dhcp\pool-manual-binding-xxx>>add ?
add command parameters:
OPTION <option-code> HEX <hex value> <hex value> <hex value> ...
OPTION <option-code> ASCII <string>
OPTION <option-code> IP <ip addr> <ip addr> ...

ATOS\dhcp\pool-manual-binding-xxx>>del ?
del command parameters:
OPTION <option-code>

Lan0_pool Nodes
Relay Commands
ATOS\dhcp\lan0_pool\relay>>add ?
add command parameters:
dhcp-server <ip addr server dhcp>
ATOS\dhcp\lan0-pool\relay>>del ?
del command parameters:
dhcp-server <ip addr server dhcp>

Table 35: add/del


Syntax

Description

dhcp-server
<ip addr server DHCP>

Indicate, with DHCP relay mode enabled, a DHCP server in the net
for DHCP request forwarding.

ATOS\dhcp\lan0_pool\relay>>set ?
Nodes not available.
Set command parameters:
<on|off>
Table 36: set
Syntax

Description

on|off

Enable/disable a DHCP request forwarding to a DHCP server in the


net already configured with add command.

ATOS User Guide


DHCP - 71 / 483

DHCP Client - Commands


The dhcpclient node allows to configure the loglevel only.
It is possible to associate the DHPC client functionality to any interface that requires an IP address.
ATOS\dhcpclient>>set ?
Nodes not available.
Set command parameters:
loglevel
<value>
In the following example the device will require an IP address for its interface to the network (LAN
side). If the request fails, the device uses the IP address 10.0.0.1 for that interface.
ATOS>>lan0
ATOS\lan0>>ip
ATOS\lan0\ip>>set ?
Nodes available:

rip

Set command parameters:


address
<ip add>
netmask
<ip add>
dhcp-client <on|off>
ATOS\lan0\ip>>set dhcp-client on
Command executed

ATOS User Guide


Intservices - 72 / 483

DNS
ATOS delivers the DNS server and forwarder functionality to make PC configuration and
installation over the LAN easier. When the DNS server/forwarder functionality is active, the queries
of a host name can be addressed directly to ATOS.
To avoid using one or more external DNS servers, you only need to configure the IP address of the
Aethra device over the LAN as DNS primary server.
Queries for local host name are resolved by ATOS. Queries for remote host name are returned by
ATOS to one or more external DNS, whose addresses are configured in a list of servers. ATOS
supports recursive queries.
Once the final answer has been obtained, the answer is transmitted to the PC over the local network
that has released the query and is saved on a local cache, in order to be used to resolve the next
queries with the same name locally.

The DNS cache is contained in a volatile memory. The information contained in the DNS
cache is lost when the device is switched off.

DNS Commands
ATOS\dns>>set ?
Nodes available:
host
Set command parameters:
<on|off>
maxretries <value>
defaulthost <on|off>
timeout
<value>
loglevel
<value> [-s]
Table 37: set
Syntax

Description

on|off

Activate/deactivate the DNS server/forwarder functionality.


Default: on.

maxretries <value>

Set the maximum number of attempts to the same server. Range: 0255, default: 3.

defaulthost <on|off>

Activate/deactivate the system name resolution (configurable in the


ATOS\System>> node of the device in the LAN. If enabled, the
ATOS internal services can be recalled (Telnet, WEB server) from
a PC in the LAN, by simply referring to the name assigned to the
device. Default: on.

timeout <value>

Set the maximum wait time of the answer to a query. Range: 065535, default: 20 sec/10.

loglevel <value> [-s]

Set the detail level used by ATOS to record events in the DNS
node. Range: 0-5, default: 1.

ATOS User Guide


Intservices - 73 / 483

You can create a list of external DNS servers used by ATOS to address queries on unknown host
names, with the following commands/options:
ATOS\dns>>add ?
add command parameters:
<domain name string><primary ip add>
<domain name string><primary ip add><secondary ip add>
<domain name string><ifc name>
<primary ip add>
<primary ip add><secondary ip add>
<ifc name>
List of ifc name
LAN0
ATM_VC0
ATM_VC1
ATM_VC2
ATM_VC3
ATM_VC4
ATM_VC5
ATM_VC6
ATM_VC7
........
Table 38: add
Syntax

Description

<domain name string>


<primary ip add>

Indicate the address of one DNS server for the domain.

<domain name string>


<primary ip add> <secondary
ip add>

Indicate the addresses of two DNS servers for the domain.

<domain name string>


<interface name>

Indicate that one DNS server (primary and possibly secondary)


must be searched on the WANx interface (<ifc name>) configured
with PPP or PPPoE encapsulation. The DNS server is advised by
the access server (with <string domain name> domain) during the
IPCP negotiation. The same address is deleted at the end of the PPP
or PPPoE session.

primary ip add

Indicate the address of one DNS server for all domains (ANY).
If the domain name is not indicated, the DSN server is interrogated
regardless of the domain of the host name. This server is the last
server in the list of interrogated servers.

<primary ip add> <secondary


ip add>

Indicate the addresses of two DNS servers for all domains (ANY).
If the domain name is not indicated, the DSN server is interrogated
regardless of the domain of the host name. This server is the last
server in the list of interrogated servers.

interface name

Indicate the interface where one DNS server for all domains can be
found (ANY).
If the domain name is not indicated, the DSN server is interrogated
regardless of the domain of the host name. This server is the last
server in the list of interrogated servers.

ATOS User Guide


Intservices - 74 / 483

Only one DNS server can be included with <any>.

Example: configuration of one primary and secondary DNS from the default configuration. Before
adding the entry with the two DNS, you must delete the <any> domain that points to the DNS
servers capable of resolving any DNS query.
ATOS\dns>>show conf
Show of ATOS dns
dns
:
max retries
:
timeout retries (sec/10):
defaults host
:
level of log
:
List of dns service
domain name
<any>

on
3
20
on
1
primary address secondary address ifc
1

ATOS\dns>>
ATOS\dns>>delete <any>
Command executed
ATOS\dns>>add 200.200.200.10 150.150.150.10
Command executed
ATOS\dns>>show conf
Show of ATOS dns
dns
: on
max retries
: 3
timeout retries (sec/10): 20
defaults host
: on
level of log
: 1
List of dns service
domain name
primary address secondary address ifc
<any>
200.200.200.10 150.150.150.10

ATOS\dns>>del <domain name string>


Table 39: del
Syntax

Description

domain name string

Delete the entry from the list of DNS servers with <domain
name string> name. If the domain name is not indicated, the
entry with <any> as Domain Name is deleted.

ATOS User Guide


Intservices - 75 / 483

DNS Nodes
Host
The DNS node contains a subnode that is used to add the resolutions of specific hosts.
ATOS\dns\host>>add <host name string> <ip add>
Table 40: add
Syntax

Description

<host name string> <ip add>

Adds the resolution of the <host name string> host name


with <ip add> IP address.

ATOS\dns>>del <host name string>

Table 41: del


Syntax

Description

host name string

Deletes the resolution with <host name string> host name.

ATOS User Guide


Intservices - 76 / 483

Frame Service WAN Interfaces


ATOS allows the use of Frame Service interface as WAN. Frame Service interface can be
configured either as Frame Relay or HDLC service, depending of the Serial-Ifc encapsulation
setting.
The WAN FRAME SERVICE configuration parameters are the same of WANs ATM (e.g. Wan1,
Wan2, etc.). The transport configuration parameters are available on the Frame-service node.
Routed and/or bridging traffic packets from/to LAN interface, can be transported either by the
Serial VX interface, using HDLC protcol encapsulation (High-Level Data Link Control - Bitoriented synchronous data link layer protocol), or through the Frame Relay network

HDLC encapsulation
The using of HDLC encapsulation allows to convert ETHERNET frame into HDLC frame and
viceversa.
The Preamble, Destination, Source Address and L/T fields of an ETHERNET frames are substituted
by initial FLAG, ADDR and CONTR. The Payload field can be either transparent transmitted or
using PPP encapslation. FSC field can be either set to 16-bit or 32-bit depending of the
configuration. ADDR and CONTR fields assume the hexadecimal value FF 03.

.
Frame Relay encapsulation
FRAME-RELAY encapsulation transports the IP traffic and/or transparent bridging from/to LAN
interface.
FRAME-RELAY service can be configured to support the following Local Management Interface
(LMI):
The ANSI-adapted Frame Relay signal specification, T1.617 Annex D
The ITU-T-adapted Frame Relay signal specification, Q.933 Annex A
Symmetric and asymmetric mode can be select.

Wan-Frame-Service
Depending of the Serial-ifc interface configuration (encapsulation setting), in the Frame-service
node can be configured the following connections:

one HDLC type,


one FRAME_RELAY type in which we can configured up tp 16 DLCI.
After FRAME-SERVICE configuration, up to 6 WAN-FRAME-SERVICE can be added. For each
of them a Frame-Service connection can be associated.

ATOS User Guide


Intservices - 77 / 483

FRAME SERVICE WAN configuration


The step flow to configure a Frame Service WAN is the following:
Step 1: configure SERIAL-IFC node;
Step 2: configure FRAME-SERVICE node;
Step 3: add WAN-FR-SERV.

SERIAL-IFC commands
The VX interface can act either as DTE or DCE (V.35, X.21/V.11, RS449/V.36), depending of the
connected adapter cable.
From SERIAL-ifc node its possible to set the following parameters:
ATOS\Serial-Ifc>>set ?
Nodes not available.
Set command parameters:
loglevel
<value>
encapsulation <HDLC|FrameRelay>
speed
<64|128|192|256|384|512|768|1024|1536|2048>
txclk-source
<int|ext>
dte-clk-invert <on|off>
dce-clk-invert <on|off>
Table 42: set

Syntax

Description

loglevel <value>

Detail level for the information generated by ATOS on the serial-ifc


interface [default: 1]

encapsulation
<HDLC|FrameRelay>

Select Encapsulation mode. [default: HDLC]

speed <value>

Set the serial connection rate in Kbit/sec (default 2048)

<64|128|192|256|384|512|
768|1024|1536|2048>
txclk-source

Set the source clock use from the serial interface. [default: ext]

<int|ext>
DTE clock invert
<on|off>

Enable/disable the transmission clock polarity invertion on DTE


(for example on V.35 interface: C113). [default: off]

DCE clock invert


<on|off>

Enable/disable the receiving clock polarity invertion on DCE (for


example on V.35 interface: C115). [default: off]

DCE Tx clk-invert
<on|off>

Enable/disable the transmission clock polarity invertion on DCE


(for example on V.35 interface: C114). This command is available
only in DCE mode. [default: off]

Possible configuration if the Serial-ifc is DTE:


Serial-Ifc>>show conf

ATOS User Guide


Intservices - 78 / 483

Show of ATOS Serial-Ifc


Level of log
:
Encapsulation
:
Speed (Kbit/sec)
:
Tx clock source
:
Tx data inverting
:
Rx data inverting
:
DTE clock inverting
:
DCE clock inverting
:
DCE Rx clock inverting:

1
HDLC
2048
ext
off
off
off
off
off

Possible configuration if the Serial-ifc is DCE:Serial-Ifc:


Serial-Ifc>>show conf
Show of ATO Serial-Ifc
Level of log
: 1
Encapsulation
: HDLC
Speed (Kbit/sec)
: 2048
Tx clock source
: ext
Tx data inverting
: off
Rx data inverting
: off
DTE clock inverting
: off
DCE clock inverting
: off

The encapsulation configuration modify is possible only if no service is using the serial-ifc
interface. The following warning will be give in the above situation:
ATOS\Serial>>set encapsulation HDLC
Service FR-IFC is present, delete it and then change.
Command not executed
Depending of the connected adapter cable, the following status and statistics are shown:
ATOS\Serial-Ifc>>show statistics
Interface Mode: DTE
Interface Type: v11
In case of no adapter cable is connected to V/X interface, the following information are given:
ATOS\Serial-Ifc>>show statistics
No cable. Following parameters are setting as default.
Interface Mode: DTE
Interface Type: v35
In case of the adapter cable has been disconnected to VX interface, the following information are
given:
ATOS\Serial-Ifc>>show statistics
No cable.
Interface Mode: DCE
Interface Type: v35

ATOS User Guide


Intservices - 79 / 483

FRAME-SERVICE commands
FRAME-SERVICE node is the container to configure the parameters related to HDLC/FRAMERELAY service selected in SERIAL-ifc node.
The following configuration can be done in FRAME-SERVICE node:
ATOS\FRAME-SERVICE>>?
Commands available:
add
Add a new HDLC,frame relay service or traffic-class list
del
Remove HDLC,frame relay service or traffic-class list
set
Set FRAME-SERVICE option
ATOS\FRAME-SERVICE>>add ?
add command parameters:
<HDLC-IFC|FR-IFC|TRAFF-CLASS><name string>
ATOS\Frame-Service>>del ?
del command parameters:
LIST OF SERVICE
hdlc-ifc-1
Table 43: add

Syntax

Description

HDLC-IFC <name>

It creates the HDLC-IFC subnode

FR-IFC <name>

It creates the FRAME RELAY IFC subnode

TRAFF-CLASS
<name>

It creates the TRAFFIC CLASS subnodes. Up to 10 traffic-class can be


created.

add HDLC-IFC command is available only if the SERIAL-IFC encapsulation is


HDLC
add FR-IFC and add TRAFF-CLASS command are available only if the SERIALIFC encapsulation is FRAME-RELAY.
Del command: can be used only if the FR-IFC or HDLC-IFC are not associated to any WANFR-SERVICE
Del TRAFFIC-CLASS-name can be used only if this class is not used by any configured DLCI

ATOS User Guide


Intservices - 80 / 483

HDLC-IFC-x node
In the FRAME-SERVICE/HDLC-IFC-x node it is possible to configure the following parameters:
ATOS\FRAME-SERVICE\HDLC-IFC-1>>set ?
Nodes not available:
Set command parameters:
Set command parameters:
loglevel <value>
crc
<CRC-16|CRC-32>
flag
<IDLE|FLAG>
Table 44: set

Syntax

Description

loglevel <value>

Detail level for the information generated by ATOS on the HDLCIFC-x node. Range: 1-5. [default: 1]

crc < CRC-16|CRC-32>

Set Frame Control Sequence as 16 bit-CRC or 32 bit-CRC.


[default: CRC-32]

flag < IDLE|FLAG >

Set for sending hdlc flag or mark characters between packets.


[default: FLAG]

FR-IFC-x nodes
In the FRAME-SERVICE/FR-IFC-x node it is possible to configure the following parameters:
add/delete DLCI-BUNDLE functionality;
configure several common parameters for Frame Relay mode, used by all DLCIs;
display statistics of the configured DLCI;
display status of the configured DLCI;

ATOS\FRAME-SERIAL\FR-IFC-1>>show conf
Show of ATOS serial FrameRelay
Level of log
: 1
Header size
: 2
ATOS\FRAME-SERIAL\FR-IFC-1>>Add ?
add command parameters:
<DLCI-BUNDLE><name string>
Table 45: add - del

Syntax

Description

DLCI-BUNDLE <name>

add/delete a new FrameRelay connection (from 1 to MAXBUNDLE_DLCI). On the created node, one or more DLCI
can be added.

ATOS User Guide


Intservices - 81 / 483

ATOS\FRAME-SERIAL\FR-IFC-1>>set ?
Nodes available:
lmi
Set command parameters:
loglevel
<value>
headersize <value>
port
<serial>
Table 46: set

Syntax

Description

loglevel <value>

Detail level for the information generated by ATOS on the FR-IFC-x node. Range:
1-5, default: 1.

headersize
<value>

Set how many octets use in the header field of frame-relay to identify the DLCI value
(2,3,4). Default value: 2.

DLCI-BUNDLE-x node
In the FRAME-SERVICE/FR-IFC-x/DLCI-BUNDLE-x it is possible to configure the following
parameters:
ATOS\FRAME-SERIAL\FRAME-RELAY\DLCI_BUNDLE-1>>?
Nodes no available
Commands available:
add
Add a new DLCI
del
Delete a DLCI
ATOS\FRAME-SERIAL\FRAME-RELAY\DLCI_BUNDLE-1>>add ?
add command parameters:
<DLCI><DLCI value>[<traffic-class>]
Table 1: add - del dlci
Syntax

Description

<dlci value>

Set the DLCI value for the remote device.

<traffic-class>

Associate a class of traffic to the DLCI: this association indicates the policy for the
upstream frame-relay data received on that DLCI

ATOS\FRAME-SERIAL\FRAME-RELAY\DLCI_BUNDLE-1>>show conf
Show of ATOS FRAME-SERIAL FRAME-RELAY DLCI_BUNDLE-1
Level of log
: 1
SHOW OF DLCI LIST
N
DLCI
TRAFFIC CLASS
1
18
1

ATOS User Guide


Intservices - 82 / 483

LMI node
In the FRAME-SERVICE/FR-IFC-x/LMI it is possible to configure the following parameters:
ATOS\Frame-Service\fr-ifc-1\lmi>>set ?
Nodes not available.
Set command parameters:
type
<OFF|ITU|ANSI>
mode
<USER|SYMMETRICAL>
n391
<value>
n392
<value>
n393
<value>
t391
<value>
t392
<value>
loglevel <value>
Table 47: set

Syntax

Description

Type <off|itu|ansi >

Disable the LMI protocol or select an LMI protocol type. [default: off]

Mode
<user|symmetrical>

Set the work mode for frame-relay interface. When Serial mode is setting as
DTE may be USER or SYMMETRICAL, when set as DCE NETWORK or
SYMMETRICAL [default: user]

n391 <value>

Define, in user and symmetrical mode, the STATUS ENQUIRE


number after which to ask for logic single frame-relay connection status
(FULL STATUS ENQUIRE trasmission). [default: 6]

n392 <value>

Define the number of event errors (checked in a n393 event window) after
which the frame-relay connection is stated as DOWN. [default: 3]

n393 <value>

Define the window for monitor events. [default: 4]

t391 <value>

Define, in user and symmetrical mode, the number of seconds after


which to check the frame-relay connection integrity (STATUS ENQUIRE
trasmission). [default: 10]

t392 <value>

Define, in symmetrical mode, the number of seconds to wait for a


STATUS ENQUIRE before noticing an event error. [default: 15]

ATOS User Guide


Intservices - 83 / 483

TRAFF-CLASS-x node
In order to create a traffic shaping procedure, in the TRAFF-CLASS node, it is possible to
configure the parameters related to the traffic class to use in each DLCI.
ATOS\Frame-Service\traff-class-1>>set ?
Nodes not available.
Set command parameters:
<on|off>
cir
<value>
bc
<value>
be
<value>
over-bc
<SEND|MARK>
over-be
<SEND|MARK|DISCARD>
Table 48: set

Syntax

Description

<on|off>

Enable/disable the traffic class. [default: off]

cir <value>

Set, in bit per second, the guaranteed frame-relay data transmission


rate. [default: 64000]

bc2 <value>

Set, in bytes, the guaranteed frame-relay data transmission peak in Tc


time (Tc = BC*8/CIR). [default: 4800]

be3 <value>

An opportune value for this parameter allows to calculate the PIR4 =


CIR*(1+BE/BC). [default: 9600]

over-bc <send|mark>

Set the policy for upstream data-traffic exceeding CIR.


sendthe DE5 parameter value for exceeding frames will not change
markthe DE parameter value on that frames will be forced to 1.
[default: mark]

over-be
<send|mark|discard>

Set the policy for upstream data-traffic exceeding PIR.


send the DE parameter value for exceeding frames will not change,
mark the DE parameter value for that frames will be forced to 1
discard the exceeding frames will be discarded.
[default: discard]

Committed Information Rate.

Bust Committed (Committed Burst Size).

Bust Excess (Excess Burst Size).

Peak Information Rate.

Discard Eligibility.

ATOS User Guide


Intservices - 84 / 483

Creating a new WAN-FRAME-SERVICE


Starting from the root node, up to 6 WAN-FRAME-SERVICE can be created:
ATOS>>add ?
add command parameters:
<WAN-ISDN | WAN-FR-SERV>
Table 49: add
Syntax

Description

WAN-ISDN

Creates a new Wan-isdnx where x start from 1 (the first ISDN Wan
created) to 6, depending of the HW equipment

WAN-FR-SERV

Creates a new Frame relay Wan. Up to 6 Wan-Fr-Servx can be built


where x start from 1 (the first WAN-FR-SERV created) to 6.

WAN-FRAME-SERV commands
In the WAN-FR-SERVx node it is possible to configure the following parameters:
ATOS\wan-fr-serv1>>set
Nodes available:

ppp
ip
service
bridgepar

Set command parameters:


<on|off>
bridging
<on|off>
remoteadmin
<on|off>
loglevel
<value>
acl-in
<None>
acl-out
<None>
multicast
<on|off>
open-mode
<always-on|on-traffic|on-command>
interface
<None|dlci-bundle-1>

Table 50: set


Syntax

Description

on|off

Activate/deactivate the WAN-FR-SERVx interface. [default: off]

bridging <on|off>

Activate/deactivate the bridging mode over the WAN-FR-SERVx


interface. [default: off]

ATOS User Guide


Intservices - 85 / 483

remoteadmin <on|off>

Enable/disable the WAN-FR-SERVx interface to remote


management of the device. [default: off]

loglevel <value>

Set the detail level used by ATOS to log the events of the WANFR-SERVx. [default: 1]

Acl-in

Name of the Access List created in the accesslist node for


incoming WAN-FRAME-SERVICE packets.

Acl-out

<string>
<string>

Name of the Access List created in the accesslist node for


outgoing WAN-FRAME-SERVICE packets.

multicast <on|off>

Enable/disable the WAN-FR-SERVx interface to multicast.


[default: off]

open-mode

Configure WAN-FRAME-SERVx session mode:

<always-on| on-traffic|

the session is always open;

on-command>

the session is opened in case of traffic over the interface;


the session is opened and closed with the connect and
disconnect commands.
[default: on-traffic]

Interface
<None|dlci-bundle-1|dlcibundle-n>

Select the dlci-bundle name as interface for the WAN-FRAMESERVICE.


Default none

ATOS\wan-fr-serv1>>connect
ATOS\wan-fr-serv1>>disconnect
Table 51: connect - disconnect
Syntax

Description

connect

Open the session for the enabled WAN-FRAME-SERV interface.

disconnect

Close the session for the enabled WAN-FRAME-SERV interface.

WAN-FRAME-SERVICE - Nodes
The structure of the WAN-FR-SERVx node can be display using the tree command:
wan-fr-serv1

ppp6

ip
service

lcp
echorequest
authentication
ipcp
ccp
mppe
server
rip
nat
pppoe7

Node available only if encapsulation is ether PPPoA or PPPoE

ATOS User Guide


Intservices - 86 / 483

bridgepar8

Service Commands
In the WAN-FR-SERVx\service node it is possible to configure the following parameters:
ATOS\wan-fr-serv1\service>>set encapsulation ?
< RFC1490Routed|RFC1490Bridged|pppoa|pppoe>

Table 52: set encapsulation


Syntax

Description

RFC1490Routed

Set RFC1490Routed as encapsulation in the selected WAN


FRAME SERVICE. [default]

RFC1490Bridged

Set RFC1490bridged as encapsulation in the selected WAN


FRAME SERVICE.

pppoa

Set the Point-to-Point over ATM encapsulation mode. The public


address is not static and is negotiated every time you establish the
connection with the ISP.

pppoe

Set the Point-to-Point over Ethernet encapsulation mode. The public


address is not static and is negotiated every time you establish the
connection with the ISP.

LLC SNAP
You can include a header indicating the encapsulation mode of the payload when you transmit data
packets. The parameter value must be selected according to the operating mode of the server
connected to the device.
ATOS\wan-fr-serv1\service>>set llcsnap <on|off>

Table 53: set llcsnap


Syntax

Description

on|off

The default value is on. If you change to on, the encapsulation


mode is added to the payload.

Node available only if encapsulation is PPPoE

Node available only if bridging setting is ON in that WAN

ATOS User Guide


Intservices - 87 / 483

Once you have selected the encapsulation mode, three subnodes are available for parameter
configuration.

Service - Nodes
PPPoE
Some ISPs use the PPP over Ethernet protocol for client access. This protocol makes account
management and traffic monitoring easier. The technique provides for the transmission of PPP
packets inside Ethernet frames.
To configure the PPP over Ethernet parameters you can use the PPPoE subnode:
ATOS\wan-fr-serv1\service\pppoe>>set ?
Nodes not available.
Set command parameters:
fcspreserved <on|off>
restarttimer <value>
maxretry
<value>
servicename
<string>
acname
<string>
loglevel
<value> [-s]

Table 54: set


Syntax

Description

fcspreserved <on|off>

Activate/deactivate the "Preserved CRC" option. This option


maintains the error detection code (CRC-32) of the Ethernet frames
in incoming and outgoing packets. [default: off]

restarttimer <value>

Initial value of the timer used in the Discovery phase when ATOS is
trying to reach the PPPoE server. The timer is used for the first retransmission of the PADI and "PADR" packets in case of no
reply. The value doubles at every re-transmission.
Range: 1-65535 msec., default: 200 msec..

maxretry <value>

Maximum number of re-transmission attempts of PADI and


PADR packets. Range: 1-255, default: 5.

servicename <string>

Name of the service requested to listening servers. Maximum 32


characters (default: empty). ATOS accepts the first one proposed by
the Access Concentrator.

acname <string>

Name of the Access Concentrator with the requested service.


Maximum 32 characters (default: empty). ATOS accepts the first
one.

loglevel <value>

Log level generated by ATOS for errors in the services offered by


the PPPoE subnode. Default: 1.

ATOS User Guide


Intservices - 88 / 483

You can leave the fields empty if you have no information on the Access Concentrators or services
offered by the remote system. ATOS includes the first Access Concentrator and the first service in
the negotiation messages of the PPPoE session. You can use the query command to get
information on the parameters offered by the remote service:
ATOS\WAN-FR-SERVx\service\pppoe>>query

PPP Commands
The PPP subnode is used to configure the PPP protocol.
ATOS\wan-fr-serv1\ppp>>set ?
Nodes available:
lcp
authentication
ipcp
ccp
server
Set command parameters:
type
<ppp-client|ppp-server>
maxconfigure
<value>
maxterminate
<value>
maxfailure
<value>
restarttimer
<value>
inactivitytime <value>
loglevel
<value>
Table 55: set
Syntax

Description

maxconfigure <value>

Maximum number of requests to establish the PPP session over


WAN (CFG REQUEST) in order to consider the attempt as failure.
Range: 1- 20, default: 10.

maxterminate <value>

Maximum number of requests to clear the PPP connection


(TERMINATE REQUEST) in order to clear the connection.
Range: 1- 20, default: 2.

maxfailure <value>

Maximum number of negative acknowledgements during the


negotiation phase of the PPP session parameters (CFG NAK) before
sending the acknowledge message (CFG ACK). Range: 1- 20,
default: 5.

restarttimer <value>

Set the timeout between two attempts for the parameters above.
Range: 1- 30 secondi, default: 3 sec..

inactivitytime <value>

Indicate the time after which the PPP session is cleared in case of
no data packet transmission. The timer is not active if the value is 0.
This means that the connection is always-on , i.e. it is active as
long as the physical level is active. If the value is not 0, the
connection is on-demand , i.e. it activates with data traffic and

ATOS User Guide


Intservices - 89 / 483

remains active until the set timer expires. Range: 0- 65535 seconds,
default: 0.
loglevel <value> [-s]

Set the detail level for the information generated by ATOS


following to errors on the services offered by the PPP subnode
(default: 1). The command is extended to the subnodes by selecting
the [s] option. [default: 1]

PPP Nodes
The PPP node contains the lcp (Link Control Protocol), authentication (configuration of
authentication parameters), ipcp (configuration of compression type), ccp (use of the
Compression Control Protocol) and server subnodes.

LCP Commands
ATOS\wan-fr-serv1\ppp\lcp>>set ?
Nodes available:
echorequest
Set command parameters:
mru <value>
pfc <on|off>
acfc <on|off>
echo <on|off>
Table 56: set
Syntax

Description

mru <value>

Value of the MRU parameter (Max Receive Unit) in bytes. Range:


256-1500, default: 1500.

pfc <on|off>

Activate/deactivate the compression of the PID field (default: off).

acfc <on|off>

Activate/deactivate the compression of the Address and Control


field (default: off).

echo <on|off>

Activate/deactivate the sending of PPP ECHO REQUEST packets


to check the status of the PPP link (default: on).

LCP - Nodes
ATOS\wan-fr-serv1\ppp\lcp\echorequest>>set ?
Nodes not available.
Set command parameters:
maxretries <value>

ATOS User Guide


Intservices - 90 / 483

timeout

<value>

Table 57: set


Syntax

Description

maxretries <value>

Maximum number of ECHO requests in order to terminate the PPP


link in case of no reply from the server .Range: 1-255, default: 5.

timeout <value>

Time between two ECHO requests. Range: 1-255 seconds, default:


30 sec..

Authentication Commands
The commands for the configuration of the authentication parameters are contained in the
authentication node:
ATOS\wan-fr-serv1\ppp\authentication>>set ?
Nodes not available.
Set command parameters:
username <string>
password <string>
pap
<on|off>
chapmd5
<on|off>
ms-chapv1 <on|off>
ms-chapv2 <on|off>
Table 58: set
Syntax

Description

username <string>

pap <on|off>

Username (typically provided by the ISP) for authentication with the


remote server.
Field with 0-25 characters, default: empty.
Password (typically provided by the ISP) for authentication with the
remote server.
Field with 0-15 characters, default: empty.
Activate/deactivate the PAP authentication mode (default: on).

chapmd5 <on|off>

Activate/deactivate the CHAPMD5 authentication mode (default: on).

ms-chapv1 <on|off>

Activate/deactivate the MS-CHAPv1 authentication mode (default: off).

ms-chapv2 <on|off>

Activate/deactivate the MS-CHAPv2 authentication mode (default: off).

password <string>

ATOS supports the PAP and CHAP MD5 authentication modes. If ATOS does not supports the
requested protocol during the negotiation phase of the authentication protocol, ATOS replies with
the safest enabled protocol. The authentication phase ends when client and server agree on the
protocol to use.

ATOS User Guide


Intservices - 91 / 483

IPCP Commands
ATOS\wan-fr-serv1\ppp\ipcp>>set vjcomp <on|off>
Table 59: set vjcomp
Syntax

Description

on|off

Activate/deactivate the reception of packets compressed with the Van


Jacobson technique. Default: on.

CCP Commands
From the ATOS\WAN-FR-SERVx\ppp\ccp>> node you can activate the CCP protocol,
configure up to 3 session keys and select the synchronization mode of the MPPE protocol.

ATOS\wan-fr-serv1\ppp\ccp>>set ?
Nodes available:

mppe

Set command parameters:


<on|off>

Table 60: set


Syntax

Description

on|off

Activate/deactivate the CCP protocol in the VPN. Default: off.

CCP Nodes
The ATOS\vpn\VPNname\ppp\ccp\mppe>> subnode is used to define the 3 session keys and
select the synchronization mode of the MPPE protocol.

ATOS\wan-fr-serv1\ppp\ccp\mppe>>set ?
Nodes not available.
Set command parameters:
key40
<on|off>
key56
<on|off>
key128
<on|off>
sync-mode <stateless|stateful>

ATOS User Guide


Intservices - 92 / 483

Table 61: set


Syntax

Description

key40 <on|off>

Activate/deactivate the 40 bits MPPE session key. Default: off.

key56 <on|off>

Activate/deactivate the 56 bits MPPE session key. Default: off.

key128 <on|off>

Activate/deactivate the 128 bits MPPE session key. Default: off.

sync-mode
<stateless|stateful>

Select the MPPE synchronization mode.


Default: stateless.

IP Commands
This node is used to configure the IP protocol parameters over the WAN-FR-SERVx. The device
offers six WAN-FR-SERVx ports to establish multiple connections with multiple remote networks
(by subscribing the service with the telecom provider).

ATOS\wan-fr-serv1\ip>>set ?
Nodes available:

rip
nat

Set command parameters:


address
<ip addr>[/value]
netmask
<ip addr>
remoteaddress
<ip addr>
addressvalidation <on|off>
napt
<on|off>
mtu
<value>
loglevel
<value>

Table 62: set


Syntax

Description

address <ip add>

IP address of the WAN-FR-SERVx port9 (default: 0.0.0.0).

netmask <ip add>

WAN-FR-SERVx subnet mask (default: 0.0.0.0, i.e. the implicit


subnet mask of the IP address class is assigned).

remoteaddress <ip add>

IP address of the system connected to the remote side of the WANFR-SERVx 10 (default: 0.0.0.0).

The value must correspond to the public IP address assigned to the port in case of IpoA encapsulation. In case of PPPoA
and PPPoE encapsulation, the address is negotiated with the server during the configuration phase of the PPP session.,
when the address can be dynamically assigned by the PPP server. If the IP address is modified by the access server in the
PPP configuration phase, the subnet mask is changed into the subnet mask of the class of the assigned address.
10

In case of connection over the PPP, the address is informed during the session configuration phase.

ATOS User Guide


Intservices - 93 / 483

addressvalidation <on|off>

Activate/deactivate the function used to check if the source IP address


contained in every packet received from the WAN-FR-SERVx port is
included in the routing tables as address that can be reached from the
WAN-FR-SERVx port. The packet is accepted if the address is
present, otherwise it is rejected. Default: off.

napt <on|off>

Activate/deactivate the NAPT function (configured in the NAPT


node) in the WAN-FR-SERVx. Default: on.

mtu <value>

MTU (Maximum Transmission Unit) parameter. Range: 576-2048,


default: 1500.

loglevel <value> [-s]

Detail level for the information generated by ATOS on the services


offered by the IP subnode (default: 1).The command is extended to
the subnodes by selecting the [s] option. [default: 1]

IP Nodes
RIP
The configurable parameters for the Routing Information Protocol (RIP) over the WAN-FR-SERVx
interface are the same as the parameters for the LAN interface. The only difference between the two
interfaces for the RIP refers to the default value: OFF for LANx and BOTH for WAN-FR-SERVx.
ATOS\WAN-FR-SERVx\ip\rip>>set ?
Nodes not available.
Set command parameters:
<off|both|receive>
version <v1|v2|v1compatible>

NAT
The following commands are available for NAT configuration over WAN-FR-SERVx:
ATOS\WAN-FR-SERVx\ip\nat>>set ?
Nodes not available.
Set command parameters:
address <ip addr>
alias
<string>
Table 63: set
Syntax

Description

address <ip add>

IP address for the NAT, as alternative to the public IP address assigned to the WANFR-SERVx. If the parameter is configured, the source address of the outgoing packets
from the WAN-FR-SERVx interface is the parameter value.

alias <string>

Alias name used in the WAN-FR-SERVx created in the NAPT\ALIAS node.

ATOS User Guide


Intservices - 94 / 483

ATOS\WAN-FR-SERVx\ip\nat>>add <ip add>


Table 64: add
Syntax

Description

ip add

Create a list of IP addresses that are ignored by the NAT operations. Incoming and
outgoing packets having one of the IP addresses contained in the list in the
destination and source field, respectively, are ignored by the NAT operations.

ATOS\WAN-FR-SERVx\ip\nat>>del <ip address>


Table65: del
Syntax

Description

<ip address>

Delete one entry from the list of IP addresses that are ignored by the NAT operations.

BridgePar Commands
The bridging parameters for the WAN-FR-SERVx interface are the same as the parameters
illustrated for the LANx interface.
ATOS\WAN-FR-SERVx\bridgepar>>set ?
Nodes not available.
Set command parameters:
<bridge1|bridge2|bridge3|bridge4>
priority
<value>
cost
<value>

ATOS User Guide


IDS - 95 / 483

Intrusion Detection System


Intrusion Detection System is a system that heads off and analyzes data traffic.
ATOS, from 2.8 version, implements a system that points out many attacks (described in detail later
on) and a stateful packet filtering' on ICMP, FTP, TCP, TFTP, UDP protocols.
Differently from a firewall, protection that prevents the access of undesired traffic on the internal
network, the IDS is a system that surveys intrusions. It notifies an attack to the net and the attack
mode by means of the management of a database of attacks that are compared with analyzed traffic.

IDS - Commands
The ids node allows creating different dynamic ids profiles each associated to an interface.
ATOS\ids>>add ?
add command parameters:
<ids name><ifc name>

ATOS\ids>>add IDSname atm_vc0


Command executed

IDS - Nodes
IDSname - Commands
ATOS\ids\IDSname>>set ?
Nodes available:

dos-in
dos-out
spf-out
spf-in

Set command parameters:


interface-name <string>
trace-on-alarm <on|off>
acl-outgoing
<string>
acl-ingoing
<string>
loglevel
<value>

ATOS User Guide


IDS - 96 / 483

Table 66: set


Syntax

Description

interface-name <string>

Name of the interface for the ids profile association (max 32


characters).

trace-on-alarm <on|off>

Enable /disable, in case of attack, the trace IP display for packets


independently from the log level configred. This parameter is
disabled as default.

acl-outgoing <string>

Associate an access list previously created from


ATOS\accesslist>> node to the selected interface in outgoing
direction.

acl-ingoing <string>

Associate an access list previously created from


ATOS\accesslist>> node to the selected interface in incoming
direction.

loglevel <value>

Set the detail level used by ATOS to log the events of the
IDSname node; the default value is 2.

ATOS\ids>>show conf
Show of ATOS ids IDSname
interface
log level
trace on alarm
acl outgoing
acl ingoing

: atm_vc0
: 2
: off
:
:

show of atos ids idsname dos-in


enable
fragmentation
detect ping of death
fragment minimum length
(byte)
fragment time out
(sec)
source routing option
detect spoofing attack
detect smurf attack
detect fraggle attack
detect land attack
inspection protocol
detect tcp flood
tcp flood max rate (packet/min)
detect udp flood
udp flood max rate (packet/min)
detect icmp flood
icmp flood max rate (packet/min)
icmp block time
(sec)
detect sequence number error
detect scan by tcp flags
tcp idle time
(sec)
udp idle time
(sec)
icmp idle time
(sec)
tcp final wait time
(sec)
minimun packet length
(byte)

:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:

off
permitted
on
20
10
denied
on
on
on
on
off
on
20
on
20
on
20
0
off
on
120
30
5
5
20

ATOS User Guide


IDS - 97 / 483

show of atos ids idsname dos-out


enable
fragmentation
detect ping of death
fragment minimum length
(byte)
fragment time out
(sec)
source routing option
detect spoofing attack
detect smurf attack
detect fraggle attack
detect land attack
inspection protocol
detect tcp flood
tcp flood max rate (packet/min)
detect udp flood
udp flood max rate (packet/min)
detect icmp flood
icmp flood max rate (packet/min)
icmp block time
(sec)
detect sequence number error
detect scan by tcp flags
tcp idle time
(sec)
udp idle time
(sec)
icmp idle time
(sec)
tcp final wait time
(sec)
minimun packet length
(byte)

:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:

off
permitted
on
20
10
denied
on
on
on
on
off
on
20
on
20
on
20
0
off
on
120
30
5
5
20

show of atos ids idsname spf-out


no protocol defined
show of atos ids idsname spf-in
no protocol defined
Command executed

Besides the set commands, the dynamic IDSname node includes suspend and resume
commands too; the first one disables the IDS inspection until resume command.

ATOS\ids\IDSname>>suspend
ATOS\ids\IDSname>>resume

IDSname Nodes
Dos-in / dos-out Commands
IDSname node allows to enable an inspection to prevent DOS attacks coming from external
network towards the internal one (dos-in) and to prevent the same coming from internal network
and directed towards the external one (dos-out). In the latter mode it is accepted that malicious
packets pass through or are processed by the equipment.

ATOS User Guide


IDS - 98 / 483

ATOS\ids\IDSname\dos-in[dos-out]>>set ?
Nodes not available.
Set command parameters:
<on|off>
fragmentation
detect-ping-of-death
fragment-min-len
fragment-timeout
source-routing-option
detect-spoofing-attack
detect-smurf-attack
detect-fraggle-attack
detect-land-attack
inspection-protocol
detect-tcp-flood
tcp-flood-max-rate
detect-udp-flood
udp-flood-max-rate
detect-icmp-flood
icmp-flood-max-rate
icmp-block-time
detect-sequence-number-error
detect-scan-tcp-flag
tcp-idle-time
udp-idle-time
icmp-idle-time
tcp-fin-wait-time
min-len

<permitted|denied>
<on|off>
<value>
<value>
<permitted|denied>
<on|off>
<on|off>
<on|off>
<on|off>
<on|off>
<on|off>
<value>
<on|off>
<value>
<on|off>
<value>
<value>
<on|off>
<on|off>
<value>
<value>
<value>
<value>
<value>

Table 67: set


Syntax

Description

<on|off>

Enable/disable the inspection for DOS attacks prevention.

fragmentation
<permitted|denied>

Permit/deny the fragmented packet access. The default value is


default permitted. Setting the denied value, fragmented
packets are dropped.

detect-ping-of-death
<on|off>

Enable/disable a control for packet fragmentation, so this parameter


is meaningless if the fragmentation parameter is denied.
Eanbling the detect-ping-of-death, the system discards an
IP packet and the following ones with the same IP ID1 if
it is the first packet with a specific ID received and it is not the first
fragment;
it overlaps an already received fragment;
it is out of sequence;
a fragment exceeds of 65536 byte the IP packet total length;

IP Identification.

ATOS User Guide


IDS - 99 / 483

a fragment, different from the last packet fragment, is shorter than


the value configured set fragment-min-len <value>;
between fragments the time exceeds fragment-timeout
seconds.
This control prevent ping of death, tear drop attack and other
attacks. The default value is on.
fragment-min-len <value>

Enabling the detect-ping-of-death , this parameter sets, i n


bytes, the minimum length of fragmented IP packet excepted of the
last fragment. The default value is 20 bytes, the available range is 01500.

fragment-timeout <value>

Enabling the detect-ping-of-death , this parameter sets, i n


seconds, the maximum time between a fragment and another. Once
the time exceeds, fragments that arrive are dropped. The same
timeout is used by the list of fragments denied: if forbidden
fragments dont come from the same IP packet then this timeout is
removed from the list. The default value is 10 sec., the range
available is 1-100.

source-routing-option
<permitted|denied>

Permit/deny the transit of packets with loose source routing or


strict source routing option in the IP header . The default value is
denied.

detect-spoofing-attack
<on|off>

Enable/disable the control


of the packet source address when it is different from zero,
verifying if a route entry has the destination network as the
packet source network and the configured interface is the one
the packet comes from;
of the packet source address that must be different from the
interface address.
The default value is on.

detect-smurf-attack
<on|off>

Enable/disable the control for an ICMP REQUEST or a TIME


STAMP REQUEST packet that cannot have a destination
broadcast/ local broadcast address. The default value is on.

detect-fraggle-attack
<on|off>

Enable/disable the control for an ECHO REQUEST UDP packet


that cannot have a broadcast destination address and cannot have a
source port as the ECHO REQUEST UDP one and a source address
as the destination one. The default value is on.

detect-land-attack <on|off>

Enable/disable the control for TCP/UDP packet address/port source


that must be different from address/port destination, while in all the
other protocols the source address only must be different from the
destination one. This attack is typically performed on TCP packets
with SYN=1, but it can be extended to all IP packets. The default
value is on.

inspection-protocol
<on|off>

Enable/disable the control for the PROTOCOL field value that


must be equal to one of the values configured by the add
permitted-protcol command. The default value is off.

detect-tcp-flood <on|off>

Enable/disable the control for TCP half-open sessions number


(configured using tcp-flood-max-rate <value>
command) allowed in a minute. The default value is on.

ATOS User Guide


IDS - 100 / 483

tcp-flood-max-rate <value>

Define the maximum rate, in a munute, for incomplete TCP session


increasing. Once the configured value is exceeded, packets that
begin a new TCP session are discarded until the number of starting
session per minute doesnt descrease to the configured value. The
default value is 20 sessions/minute, the available range is 1- 10000.

detect-udp-flood <on|off>

Enable/disable the control for UDP half-open sessions number


(configured using udp-flood-max-rate <value>
command) allowed in a minute. The default value is on.

udp-flood-max-rate <value>

Define the maximum rate, in a munute, for incomplete UDP session


increasing. Once the configured value is exceeded, packets that
begin a new UDP session are discarded until the number of starting
session per minute doesnt descrease to the configured value. The
default value is 20 packets/minut, the available range is 1- 10000.

detect-icmp-flood <on|off>

Enable/disable the control for ICMP messages number admitted per


minute. The default value is on.

icmp-flood-max-rate <value>

Set the maximum number of ICMP ECHO REQUEST or


TIMESTAMP REQUEST in a minute after that packets are
descarded for the remaining time in the minute or for icmpblock-time minuts if it is different from zero. The default value
is 20 sessions/minute, the available range is 1- 10000.

icmp-block-time <value>

Configure, in seconds, the time for ICMP ECHO REQUEST and


TIMESTAMP REQUEST packets discarding once the ICMPFLOOD-MAX-RATE parameter exceeded. The default value is 0,
and it means that the command is disabled; The available range is 1
a 10000 sec..

detect-sequence-numbererror <on|off>

Enable/disable the control for TCP sequence number that must be


included in the trasmission window. The default value is off.

detect-scan-tcp-flag
<on|off>

Enable/disable the control for TCP flag field so that:


on packet beginning the session is acepted active only;
in all the other session statuses flag = 0, with all flags at ON or
FIN, URG and PUSH at ON are not acepted.
Enabling this option TCP FIN SCAN, TCP XMAS SCAN, TCP
NULL SCAN are reported. The default value is off.

tcp-idle-time <value>

Indicate, in seconds, the time for TCP session management in


absence of traffic. Once it ended, the TCP session is considered
closed. The default value is 120 sec., the availble range is 1-10000
sec..

udp-idle-time <value>

Indicate, in seconds, the time for UDP pseudo-session management


in absence of traffic. Once it ended, the UDP session is considered
closed. The default value is 30 sec., the availble range is 1-10000
sec..

icmp-idle-time <value>

Indicate, in seconds, the time for ICMP session management in


absence of traffic. Once it ended, the ICMP session is considered
closed. The default value is 5 sec., the availble range is 1-10000
sec..

tcp-fin-wait-time <value>

Indicate, in seconds, the time for TCP session management once


noticed a FIN-EXCHANGE2 packet or a packet with a RST3 flag.
The default value is 5 sec., the availble range is 0-100 sec..

FIN-EXCHANGE indicates the TCP status once two peers changed packets with FIN ON bit.

TCP header flag ReSeT.

ATOS User Guide


IDS - 101 / 483

min-len <value>

Configure, in byte, the control for the minimum length of any IP


packet. The default value is 20 bytes , the available range is 0-1500,
here 0 means that the control is disabled.

ATOS\ids\IDSname\dos-in>>add ?
add command parameters:
permitted-protocol
<tcp|udp|icmp|value>

Table 68: add


Syntax

Description

permitted-protocol
<tcp|udp|icmp|value>

Configure the IP protocol permitted; thr value field contains the


protocol value in the IP header. This command is significant when
the IP protocol inspection is active (set inspectionprotcol on ).

ATOS\ids\IDSname\dos-in>>del ?
add command parameters:
permitted-protocol
<tcp|udp|icmp|value>

Table 69: del


Syntax

Description

permitted-protocol
<tcp|udp|icmp|value>

Remove the IP protocol previously configured; the value field


contains the protocol value in the IP header.

Spf4-in / spf-out - Commands


ATOS\ids\IDSname\spf-in[spf-out]>>add ?
add command parameters:
udp|tcp|icmp|tftp|ftp

Stateful Packet Filtering.

<timeout>

ATOS User Guide


IDS - 102 / 483

Table 70: add


Syntax

Description

udp|tcp|icmp|tftp|ftp
<timeout>

Add a transport (udp,tcp,icmp) or an application (tftp,ftp)


protocol to the Stateful Packet Filtering for answer traffic
allowing. The timeout parameter defines, in seconds, the
inactivity timer value: if a session of a selected protocol doesnt
report traffic for the configured timem the session can be
considered closed.

ATOS\ids\IDSname\spf-in[spf-out]>>del ?
add command parameters:
udp|tcp|icmp|tftp|ftp

<timeout>

Table 71: del


Syntax

Description

udp|tcp|icmp|tftp|ftp
<timeout>

Remove the transport (udp,tcp,icmp) or application


(tftp,ftp) protocol previously configured for the Stateful Packet
Filtering.

Alarm logs
0001 first fragment out of sequence
it means that the system notices as first fragment of an IP packet a non initial fragment.
The command for enabling this message is
set detect-ping-of-death-attack on
0002 fragment out of sequence
it means that the system notices an IP fragment out of sequence (i.e. a fragment lost).
The command for enabling this message is
set detect-ping-of-death-attack on
0003 detect ping of death
it means that the system notices a fragment of an IP ICMP packet that, added to the packet total
length, exceeds 64k.
The command for enabling this message is
set detect-ping-of-death-attack on

ATOS User Guide


IDS - 103 / 483

0004 IP length exceed 64 k


it means that the system notices a fragment of an IP packet (no ICMP) that, added to the packet total
length, exceeds 64k.
The command for enabling this message is
set detect-ping-of-death-attack on
0005 detect packet fragmented
it means that the system notices a fragmented packet while fragmentation is not admitted.
The command for enabling this message is
set fragmentation denied
0006 detect tear drop attack(1)
it means that the system notices a fragment that overlapes the last one received.
The command for enabling this message is
set detect-ping-of-death-attack on
0007 detect tear drop attack(2)
it means that the system notices a fragment that overlapes the one having offset parameter equal to
zero.
The command for enabling this message is
set detect-ping-of-death-attack on
0008 detect source routing option
it means that the system notices a not admitted packet with loose or strict source routing option.
The command for enabling this message is
set source-routing-option denied
0009 detetct packet fragmented too short
it means that the system notices an IP fragment that is not at the bottom of the packet and has a
length lower than the configured one.
The command for enabling this message is
set fragment-min-len <value>

0010 wrong length header IP/UDP/TCP/ICMP


it means that the system notices a packet that is incoherent for physical length, IP length and
header length.
The command for this message is always enabled.

ATOS User Guide


IDS - 104 / 483

0011 packet too short


it means that the system notices a packet having a physical length lower that the length configured
using the set min-length <value> command.
The command for his message is enabled once the <value> parameter is greater than zero.

0013 detect land attack


it means that the system notices a TCP or UDP packet havong the source address = destination
address and source port = destination port.
The command for enabling this message is
set detect-land-attack on
0014 protocol not expected
it means that the system notices a packet using a protocol that misses the list created with the
command add permited-protcol <tcp|udp|icmp|all |decimal number>.
The command for enabling this message is
set inspection-protcol on

0015 detect smurf attack


it means that the system notices an ICMP ECHO REQUEST or a TIME STAMP REQUEST
having a destination broadcast/local broadcast address.
The command for enabling this message is
set detect- smurf-attack on
0016 detect fraggle attack
it means that the system notices an UDP packet having:
source port = 75 and the destination address is a broadcast /local broadcast,
source port = 7 and destination port = 7,
source port = 7 and source address = destination address,
source port = 7, destination port = 7 and source address = destination address.
The command for enabling this message is
set detect-fraggle-attack on
0017 detect spoofing attack
it means that the system notices a packet having a source address different from zero on a interface
which static route doesnt head to the source network, or a packet with source address = interface
address.
The command for enabling this message is

Decimal value for reserved Echo Protocol UDP port.

ATOS User Guide


IDS - 105 / 483

set detect-ip-spoofing-attack <on|off>


0020 detect ICMP flood attack
0021 end ICMP flood attack
it means that the system receives more than ICMP-FLOOD-MAX-RATE ICMP requests in a
minute.
The command for enabling this message is
set detect-icmp-flood-attack on
0030 detect UDP flood attack
0031 end UDP flood attack
it means that the system reaches the la max rate value for half open UDP connections configured
by set udp-flood-max-rate <number> command.
The command for enabling this message is
set detect-udp-flood-attack on
0040 detect TCP syn flood attack
0041 end TCP syn flood attack
it means that the system reaches the la max rate value for half open TCP connections configured by
set tcp-flood-max-rate <number> command.
The command for enabling this message is
set detect-tcp-flood-attack on
0050 unexpected BOOTP packet
it means that the system notices an IP DHCP packet as a response to a never sent query message.
The command for this message is always enabled.

0051 stream tcp out of window


it means that the system notices a TCP packet having a correct sequence number but a length that
exceeds the reception window.
The command for enabling this message is
set inspection-sequence-number on
0052 seq num errato
it means that the system notices a TCP packet having sequence number different from the
expected one.
The command for enabling this message is
set inspection-sequence-number on

ATOS User Guide


IDS - 106 / 483

0053 detect tcp scan null


it means that the system notices the first packet of a TCP session with all flags disabled.
The command for enabling this message is
set detect-scanning-tcp-flag on
0054 detect tcp xmas scan
it means that the system notices a TCP packet having at the same time FIN, URG and PUSH flags
active.
The command for enabling this message is
set detect-scanning-tcp-flag on
0055 detect tcp fin scan
it means that the system notices the first packet of a TCP session with FIN flag active; it could be a
false alarm if the configured idle is too brief.
The command for enabling this message is
set detect-scanning-tcp-flag on
0056 detect tcp rst scan
it means that the system notices the first packet of a TCP session with RST flag active; it could be a
false alarm if the configured idle is too brief.
The command for enabling this message is
set detect-scanning-tcp-flag on
0057 detect tcp scan
it means that the system notices the first packet of a TCP session with a flag field not equal to the
active SYN flag.
The command for enabling this message is
set detect-scanning-tcp-flag on
0060 SPI detect unsolecited packet
it means that the system notices a reply packet with a protocol enabled to SPF but it isnt a reply to
packets analyzed by SPF .

0080 drop fragment of discarded packet


it means that the system discarded a packet that is a fragment of packet previously discarded.

0081 SPI drop packet


it means that the system notices and discards a reply packet originated as reply to a packet analyzed
by SPF but the protocol is not enabled to SPF; it happen if at least one protocol is defined for SPF.

ATOS User Guide


IDS - 107 / 483

0008 detect IP option


it means that the system notices it means that the system notices a packet having a not allowed ip
datagram option.
The command for enabling this message is
set source-routing-option denied

ATOS User Guide


Intservices - 108 / 483

Intservices
The intservices node is used to configure the ports to access internal telnet and http services.

This operation is needed when you configure an internal server in the network. It allows
to identify the requests for connection to an internal server that typically uses a
wellknown port number (23 for telnet service and 80 for http service).

Intservices Commands
ATOS\interservices>>set ?
Nodes not available.
Set command parameters:
HTTP
<value>
TELNET
<value>
WEB-REFRESH
<value>
ACCESSLISTNAME <string>
IP-TOS
<hex value>

Table 72: set


Syntax

Description

http <value>

Configure the port for HTTP applications.


Range: 0-65535, default: 80.

telnet <value>

Configure the port for TELNET applications.


Range: 0-65535, default: 23.

web-refresh <value>

Configure the refresh time in seconds for the data received form the
web server (e.g. statistics, status, etc.) [default: 10]

accesslistname <string>

Name of the Access List created in the accesslist node. This


feature can be used to limit the management access.

IP-TOS <hex value>

Set IP TOS value for internal services packets such as telnet,


Internal Web server, SNMP etc. (8 hexadecimal bits) [default: 0]

ATOS User Guide


IP - 109 / 483

IP
The main function of routers is to indicate the route to the final destination to the IP packets from
the various interfaces (LAN, WAN), based on the information contained in the routing tables, on
the information received from the other routers connected over the WAN or LAN network, and also
on the information provided by the network administrator with a specific configuration.
ATOS uses:
advanced routes, entries of the routing table that have strict priority in respect with traditional
routes, as local or static ones;
static routes to reach a network which is different from the network directly connected or from the
ones announced by the routing protocols (RIP, BGP) over the WAN, manually configured
inside ATOS;
the BGP (Border Gateway Protocol) to transmit the contents of the routing table to the other routers
and update the routing table with the contents of the received BGP packets;
the OSPF (Open Shortest Path First) that is a hierarchical Interior Gateway Protocol (IGP), using a
link-state in the individual areas that make up the hierarchy, described by RFC 2328.
the RIP (Routing Information Protocol) to transmit the contents of the routing table to the other
routers and update the routing table with the contents of the received RIP packets.
Routing information carried by routing protocols can be filtered and/or redistributed.

IP - Commands
ATOS\ip>>set ?
network-groups
route
routemng
rip
bgp
ospf-11
Set command parameters:
loglevel
<value>
subnet-zero <on|off>

Table 73: set subnet-zero

Syntax

Description

subnet-zero

Enabling this command subnet zero can be used on interfaces and


on routing updates. If subnet zero parameter is off each network
that ends with 0 is allowed only if it has a natural netmask (/24,

This subnode is present only if an ospf process has been added.

ATOS User Guide


IP - 110 / 483

/16 e /8), e.g. network 134.180.1.0/30 is not allowed while network


134.180.1.4/30 is allowed. [default: off]
loglevel <value>

Set the detail level used by ATOS to log the routing events.
[default: 0]

IP Nodes
ATOS\ip>>?
Nodes available:

route
rip
distlist
bgp
ospf-1

Network groups Commands


The use of network groups allows to have a kind of backup method. Configuring a static route into
backup interface with administrative distance greaten then the dynamic or local route.
The mechanism of routes installation guarantee that the network group static route doesnt operate
until the router can acquire either a dynamic or local route more convenient.
When the convenient route (dynamic or local) is loss, the network group static route is installed
and data traffic can flow into backup interface.
If the convenient route is local, the static route into backup interface is installed only if the
transport protocol or the physique layer of the primary interface is DOWN, while if the
convenient route is acquired y dynamic routing protocol, the backup activation is performed even
the primary interface is UP but the watched network is unreachable.
In the IP\Network-Group subnode the following command are available:
ATOS\Ip\Network-Groups>>add ?
add command parameters:
<GROUP>
ATOS\Ip\Network-Groups>>del ?
del command parameters:
LIST OF GROUPS
group-1
Table 74: add/del group
Syntax

Description

ATOS User Guide


IP - 111 / 483

group

Create/delete a group. The first group created will have id 1, the


second id 2 and so on.
Each entry creates a dynamic node where its name is group-id.

After the use of the add group command a new dynamic subnode is created where it is possible to
set several parameters:
ATOS\Ip\Network-Groups\group-1>>set ?
Nodes not available.
Set command parameters:
route-down-delay
route-up-delay
route-check-initial-delay
loglevel

<value>
<value>
<value>
<value>

Table 75: set


Syntax

Description

route-down-delay

Announcement delay of the DOWN state for the routes of the


group.

<value>

Range: 0-2147493 (seconds), default: 0 (disable).


route-up-delay

Announcement delay of the UP state for the routes of the group.

<value>

Range: 0-2147493 (seconds), default: 0 (disable).

route-check-initial-delay

Set the waiting time in the start up phase of the router, after
which the check of the watched route state is performed.

<value>

Range: 0-2147493 (seconds), default: 0 (disable).


Loglevel
<value>

Set the detail level used by ATOS to log the events of the
selected network group.

To add/delete the network to watch, the following command are available:


ATOS\Ip\Network-Groups\group-1>>add ?
add command parameters:
<NETWORK><address>[<netmask>|</value>]
ATOS\Ip\Network-Groups\group-1>>del ?
del command parameters:
<NETWORK><address><netmask>

Table 76: add / del


Syntax

Description

Network

Keyword

ATOS User Guide


IP - 112 / 483

Addrss

Add / delete an IP address into list of the group

Netmask

Set the mask of the network added. If no mask is specified a


natural mask is used.

The use of network group is possible in the ISDN WAN interface.

Route Commands
In route node it is possible to visualize all routes the device creates on each active interface,
received by dynamic protocols, such as bgp, ospf, rip and add a static route to forward traffic
according to
the destination network,
an access list previously created.
In the latter case, that can be defined as advanced routing, the system uses not only destination
network parameters but any parameter configurable in access list too (source network, protocol,
ports,).

Factory parameters include a static route for Internet surfing:


0.0.0.0 0.0.0.0 0.0.0.0 atm_vc0 1

ATOS\ip\route>>set ?
loglevel
<value>
advanced-routing-priority <off|on>
Table 77: set
Syntax

Description

advanced-routing-priority
<on|off>

Enable/disable the priority of the advanced routing entry. If it is set


off, IP packets are processed first by the static routes, then by the
advanced routes

ATOS\ip\route>>add ?
add command parameters:
<dest ip add><netmask ip add><gateway ip add><interface name>
<distance|group-id>
<access list name><gateway ip add><interface name>

ATOS User Guide


IP - 113 / 483

Table 78: add


Syntax

Description

Dest ip addr

IP address of the final destination network.

netmask ip addr

Subnet Mask value of the destination network.

gateway ip addr

IP address of the first router on the route.

interface name

Name of the interface to use. A list of available interfaces will be


shown using the help command.

distance

Indicate the routing distance in terms of number of network to cross


(hops).

group-id

Indicate the group-id name created in the Ip\Network-Groups node


to use instead of the distance. Purpose of the group-id use is to
indicate a special metric related to the watched network for
backup feature.

access list name

Name of the access list analyzed as forwarding rule. The access list
must be previously configured on accesslist node.

The following command is used to delete a static route:


ATOS\ip\route>>del ?
del command parameters:
<dest ip add><netmask ip add>[<interface name>]
<dest ip add><netmask ip add><group-id>
<access list name>
Table 79: del
Syntax

Description

Dest ip addr

IP address of the final destination network.

netmask ip addr

Subnet Mask value of the destination network you want to delete.

interface name

If there are more then one entry using the same network associated
to different interfaces, selective entry can be deleted, indicating the
interface name.

group-id

If there are more then one entry using the same network (e.g one
using a certain metric and an other using a group-id), selective entry
can be deleted indicating the group-id name.

access list name

Name of the access list associated to the advanced routing entry

Following examples show


how to add a static route via WAN1 interface (second last parameter typed in) to reach the
destination network, with distance value as 2 (last value typed in);

ATOS\ip\route>>add 172.168.0.1 255.255.255.0 192.168.0.0 atm_vc0 2


Command executed

ATOS User Guide


IP - 114 / 483

how to add a static route so that traffic coming from 192.168.1.0 net must be forwarded on LAN0
interface instead of follow the default static route rules.

ATOS\accesslist>>add MKT permit anyprot 192.168.1.1 0.0.0.1 any


ATOS\ip\route>>add MKT 10.0.0.1 LAN0

Do not delete the local route from the route list to avoid malfunctioning over the local network.
The value of the local route depends on the IP address assigned to the device.

ROUTEMNG - Commands
To define the conditions for filtering, attribute manipulation changing, redistributing routes from
one routing protocol into another, or to enable policy routing, ROUTEMNG node must be use to
create the following containers:
Classifier each classifier can contains a condition list
MAP - each map can contains one or more classifiers.
Classifier and MAP can be use in the dynamic IP protocol nodes, such as BGP, RIP, OSPF for the
purpose specified above.

Creating a new Classifier


A Classifier is a container of conditions that can be added using the following format:
ATOS\Ip\RouteMng>>add ?
add command parameters:
<classifier><name><cond-type><param_list>[<permission>][<seq_num>]
<cond-type> = <match-ip|match-next-hop|match-metric|match-tag|match-all>
<param_list> = <aa.bb.cc.dd/0-32>[<ge><0-32>][<le><0-32>] if <cond-type==match-ip>
<aa.bb.cc.dd>
if <cond-type==match-next-hop>
<0-65535 >
if <cond-type==match-metric|match-tag>
<permission> = <permit|deny>

ATOS\Ip\RouteMng>del ?
del command parameters:
<classifier><name> [<seq_num>|match-all]

ATOS User Guide


IP - 115 / 483

Table 80: add/del classifier


Syntax

Description

CLASSIFIER

Keyword

Classifier_name

Name to assign to the Classifier.

Cond_type

Type of rule inserted:


- MATCH-IP: execute the match basing on the IP/Netmask address. Optionally
the mach is performed basing on the key/mask words configured in param_list;
- MATCH-NEXTHOP: execute the mach basing on the IP address of the route
gateway;
- MATCH-METRIC: execute the match basing on the route metric;
- MATCH-TAG: execute the match basing on the route tag;
- MATCH_ALL:
If this roule is added to the classifier the behaviour is the following:
If all classifier roules are homogeneous (all PERMIT or all DENY), the classifier
gives the result PERMIT (or DENY) only if all conditions are verified, otherwise
the value will be NO_MATCH
If the roules are not homogeneous, the roule MATCH_ALL is ignored.
If this roule is not added to the classifier the behaviour is the following:
the classifier gives the result PERMIT or DENY corrisponding to the first
condition which occurs the match.
If the match is not verify for any conditions, the result will be NO_MATCH.

param_list

It depends to the cond_type value.


MATCH-IP
<ip-address>, <netmask>, [ge <netmask>]
<ip-address>, <netmask>, [le <netmask>]
<ip-address>, <netmask>, [ge <netmask> le <netmask>]
Notes:
ip-address and netmask must be expressed by the form a.a.a.a/len
ge = greaten then
le = less then
MATCH-NEXTHOP
<ip-address>
MATCH-METRIC
<value> (from 0 to 4 bytes)
MATCH-TAG
<value > (from 0 to 4 bytes)

Permission

It can assume the following value:


PERMIT (default)
DENY

ATOS User Guide


IP - 116 / 483

Seq_num

Sequence number. It determines the roule position into classifier. The effect for
the final results depends of the roule position.
If any sequence number is inserted, the system assigns to the roule a sequence
number of +10 compared to the last roule sequence number present.

Creating a new MAP


A MAP is a container of CLASSIFIERs and ACTION that can be added with the following format:
ATOS\Ip\RouteMng>>add ?
add command parameters:
<map><name><classifier><name>[<permission>][<seq_num>]
<map><name><action><action_type> <action value>
<map><name><match-all>
<permission> = <permit|deny>
<action_type> = <set-med|set-tag|set-local-pref|set-as-pathprepend|set-metric|set-metric-type>
ATOS\Ip\RouteMng >>del ?
del command parameters:
<map><name>[<classifier><name>|<action><action_type>|<match-all>]

Table 81: add/del map


Syntax

Description

MAP

Keyword

Map_name

Name to assign to the map.

CLASSIFIER

Keyword

Classifier_name

It rappresents the classifier name, created by the add classifier ..


command, to associate to the map.

Permission

It can assume the following value:


PERMIT (default)
DENY
It allows to modify the classifier result according to the following
table:

Seq_num

classifier result

permission

modified classifier result

PERMIT

PERMIT

PERMIT

PERMIT

DENY

DENY

DENY

PERMIT

DENY

DENY

DENY

DENY

Sequence number. It determines the classifier position into map.

ATOS User Guide


IP - 117 / 483

The effect for the final results depends of the classifier position.
If any sequence number is inserted, the system assigns to the
classifier a sequence number of +10 compared to the last classifier
sequence number inserted.
ACTION

Keyword

Action type

It indicates the action to execute, associated to the route-map, if its


result is PERMIT
The possible action are:
SET-MED
SET-LOCAL-PREF
SET-AS-PATH-PREPEND
SET-METRIC
SET-METRIC-TYPE
SET-TAG

Action value

Value dependent of the action.


MED: from 0 to 4 bytes
SET-LOCAL-PREF: from 0 to 4 bytes
SET-AS-PATH-PREPEND: from 0 to 2 bytes
SET-METRIC: from 0 to 4 bytes
SET-METRIC-TYPE: <0 | 1> (0 means metric-type 1, 1 means
metric-type 2, default value 1)
SET-TAG: from 0 to 4 bytes

MATCH_ALL

Keyword.
If this roule is added to the map:
if all classifier gives back the same result of match (all PERMIT or
all DENY), the MAP gives the result PERMIT (or DENY),
otherwise gives the value of NO_MATCH.
If this roule is not added to the map:
it gives the result PERMIT or DENY that is the result of the first
classifier where the match is verified.

A map works receiving as input a route and giving back as output value of PERMIT, DENY,
NO_MATCH.
In case of any mach is recognized a neutral value is used (NO_MATCH).

RIP Commands
ATOS\ip\rip>>set ?
Nodes not available.
Set command parameters:
<on|off>
routeadvice
<on|off>

ATOS User Guide


IP - 118 / 483

distance
loglevel

<value>
<value>

Table 82: set


Syntax

Description

on|off

Activate/deactivate the RIP on all interfaces (default: OFF).

routeadvice <on|off>

Activate/deactivate the advice over the network (route ICMP


advertisement) from ATOS as router (default: off).

distance

Set the distance for every route received by RIP protocol [default:
120].

loglevel <value>

Set the detail level used by ATOS to log the events of the RIP node.
[default: 0]

RIP redistribution and filtering


To redistribute and filter routes into RIP protocol, the following commands are available:
ATOS\ip\rip>>add ?
add command parameters:
<redistribute><protocol>[<map><map_name>][<metric><value>][<tag><value>]
<filter><map|classifier><name><dir><interface_name>
<attribute-mod><Map_name><dir><interface_name>
<protocol> = <local|static|bgp|ospf>
ATOS\Ip\Rip>>del ?
del command parameters:
<redistribute>[<protocol>[<map><map_name>]]
<filter>[<map|classifier><name><dir><interface_name>]
<attribute-mod>[<Map_name><dir><interface_name>]
Table 83: add/del redistribute
Syntax

Description

REDISTRIBUTE

Keyword

Protocol

Define the protocol that will be redistributed by RIP


Local = local routes will be redistributed into RIP
Static = static routes will be redistributed into RIP
Bgp = routes received by BGP will be redistributed into RIP
Ospf = routes received by OSPF will be redistributed into RIP

MAP

Keyword

ATOS User Guide


IP - 119 / 483

map_name

Name of the map associated to the redistribution.


If no map is specified, all routes belonging to the protocol with the specified
METRIC and TAG value will be redistributed.
On the contrary, if a map name is specified, METRIC and TAG value to be use in
the routes redistribution, must be configured in the ip\routemng\map_name
command as additional actions for the same map.
If in the same protocol more entries are added, only one entry can be use without
route_map specified. In this case, it is processed first the entries associated to the
route_map, then the entry withoute route_map.
To evaluate the entries with route_map specified, the return value from the
route_map configuration is used to decide how to manage the routes:

in case of PERMIT the redistribution will be done using the parameters


specified in route_map;

in case of DENY the route is not redistribute;

in case of NO_MATCH, the following entry will be checked.

If no match is verified after checking all maps, the route is not redistribute.
METRIC

Keyword

Metric value

Configure the metric value of the redistributed route.

TAG

Keyword

tag value

Configure the TAG value of the redistributed route.

Table 84: add/del filter


Syntax

Description

FILTER

Keyword.
In the del command, if no other parameters are specified, all filters will be
deleted.

MAP

Keyword.
In the del command, if no other parameters are specified, all filters associated to
the MAPs will be deleted.

map_name

Name of the MAP to associate to the route filtering process


In this context purpose of the MAP is to filter the routes so the following roule is
applied:
if the result of the MAP is PERMIT, the route is not filtered;
if the result of the MAP is DENY, the route is filtered;
if the result of the MAP is NO_MATCH, the route is filtered.

CLASSIFIER

Keyword.
In the del command, if no other parameters are specified, all filters associated to
the CLASSIFIERSs will be deleted

ATOS User Guide


IP - 120 / 483

classifier_name

Name of the CLASSIFIER to associate to the route filtering process.


In this context purpose of the CLASSIFIER is to filter the routes so the following
roule is applied:
if the result of the CLASSIFIER is PERMIT, the route is not filtered;
if the result of the CLASSIFIER is DENY, the route is filtered;
if the result of the CLASSIFIER is NO_MATCH, the route is filtered.

Dir

Indicate in which direction the filter is applied


Dir = IN means that the filter is applied in ingress on the received routes from the
RIP protocol;
Dir = OUT means that the filter is applied in outgoing direction on the routes
sends by RIP protocol.

interface_name

Name of the interface where a RIP connection is present and the filter will be
applied.

Table 85: add/del attribute_mod


Syntax

Description

ATTRIBUTE_MOD

Keyword

map_name

Name of the MAP to associate to the attribute manipulation process.

Dir

Indicate in which direction the MAP is applied


Dir = IN means that the MAP is applied in ingress on the received routes from the
RIP protocol;
Dir = OUT means that the MAP is applied in outgoing direction on the routes
sends by RIP protocol.

interface_name

Name of the interface where a RIP connection is present and the attribute
manipulation will be applied.

BGP Commands
Border Gateway Protocol (BGP), defined in RFC 1105, 1163 e 1267, is a routing protocol operating
between close Autonomuos system (AS). ATOS implements BGP version 4. AS stands for a logical
partition of network with the same administration an routing policies; each AS is identified by an
dallAS Number (ASN).
The main BGP feature is the reliability. BGP protocol is based on TCP transport protocol that
manages ritransmission in case of packet loss or traffic congestion. TCP allows also to get
information about connection status. In an autonomous system BGP configuration deals with ASN
and Hold Timer parameters and neighbour BGP routers can be added setting IP address and ASN
values.
ATOS\ip\bgp>>set ?
Nodes not available.

ATOS User Guide


IP - 121 / 483

Set command parameters:


<on|off>
hold-timer
<value>
as-number
<value>
med-enable
<on|off>
distance
<value>
internal-distance <value>
loglevel
<value>
Table 86: set
Syntax

Description

on|off

Enable/disable the protocol.

Hold-timer <value>

Identify max timeout value between keepalive and/or update


messages. After this time the connection should be closed. Default
value is 90 sec, configurable range is 0-65535 sec.

as-number <value>

Autonomous system identifier, using values from 0 to 65535.


[default: 0]

med-enable <on|off>

Enable/disable multi-exit discriminator (MED) attribute [default:


off]

distance <value>

Set the distance for routes received by external Autonomous System


[1-254, default: 20]

internal-distance <value>

Set the distance for routes received by the internal Autonomous


System [1-254, default: 200]

loglevel <value>

Set the detail level used by ATOS to log BGP. [default: 1]

To add BGP neighbor routers the following command is used:


ATOS\ip\bgp>>add ?
add command parameters:
<ip addr neighbor><AS number>
ATOS\ip\bgp>>del ?
del command parameters:
<ip addr neighbor>

Table 87: add - del


Syntax

Description

ip addr neighbor

BGP neighbor router IP address.

AS number

Autonomous system identifier of neighbor BGP router. Allowed


values: 0-65535.

ATOS User Guide


IP - 122 / 483

To force BGP route reset or refresh the following command are available:
ATOS\Ip\bgp>>reset ?
reset command parameters:
<ip addr neighbor>
Table 88: reset
Syntax

Description

ip addr neighbor

BGP neighbor router IP address.

ATOS\Ip\bgp>>refresh ?
refresh command parameters:
<ip addr neighbor>
Table 89: refresh
Syntax

Description

ip addr neighbor

BGP neighbor router IP address.

BGP redistribution and filtering


The default behaviour is not to redistribute any routes. To redistribute and filter routes into BGP,
the following commands are available:
ATOS000425\Ip\bgp>>add ?
add command parameters:
<redistribute><protocol>[<map><map_name>][<med><value>][<localpref><value>]
<protocol> = <local|static|rip|ospf>
Table 90: add
Syntax

Description

REDISTRIBUTE

Keyword

Protocol

It defines the protocol to be redistribute.


Local = local routes will be redistributed into BGP
Static = static routes will be redistributed into BGP
RIP = routes received by BGP will be redistributed into BGP
OSPF = routes received by OSPF will be redistributed into BGP

MAP

Keyword

map_name

Name of the map associated to the redistribution.


If no map is specified, all routes belonging to the protocol with the
specified METRIC and TAG value will be redistributed.

ATOS User Guide


IP - 123 / 483

On the contrary, if a map name is specified, METRIC and TAG


value to be use in the routes redistribution, must be configured in
the ip\routemng\map_name command as additional actions for
the same map.
If in the same protocol more entries are added, only one entry can
be use without route_map specified. In this case, it is processed first
the entries associated to the route_map, then the entry withoute
route_map.
To evaluate the entries with route_map specified, the return value
from the route_map configuration is used to decide how to manage
the routes:

in case of PERMIT the redistribution will be done using


the parameters specified in route_map;

in case of DENY the route is not redistribute;

in case of NO_MATCH, the following entry will be


checked.

If no match is verified after checking all maps, the route is not


redistribute..
MED

Keyword

med value

Value of the MED attribute for the redistribute route (set medenable on must be configured into node IP\BGP).

LOC_PREF

Keyword

local_pref value

Value of the LOCAL_PREF attribute for the redistribute route.

To eliminate a redistribution the following command is available:


ATOS\Ip\BGP>> del ?
del command parameters:
REDISTRIBUTE [<protocol> [MAP <map_name>]]

Table 91: del


Syntax

Description

REDISTRIBUTE

Keyword. If no other parameters are specified, all redistribution will


be deleted..

Protocol

It defines the protocol.

MAP

Keyword

Map_name

It specify the route map name present into entry to be delete.

On the BGP node it is possible to configure route filters using an association of MAP or a
CLASSIFIER through the following command:
ATOS\Ip\BGP >> add ?
add command parameters:
<filter><map|classifier><name><dir><ip addr neighbor>

ATOS User Guide


IP - 124 / 483

To eliminate a filter the command available is the following:


ATOS\Ip\BGP >> del ?
del command parameters:
<filter>[<map|classifier><name><dir><ip addr neighbor>]
Table 92: add/del filter
Syntax

Description

FILTER

Keyword.
In the del command, if no other parameters are specified, all filters will be
deleted.

MAP

Keyword.
In the del command, if no other parameters are specified, all filters associated to
the MAPs will be deleted.

map_name

Name of the MAP to associate to the route filtering process


In this context purpose of the MAP is to filter the routes so the following roule is
applied:
if the result of the MAP is PERMIT, the route is not filtered;
if the result of the MAP is DENY, the route is filtered;
if the result of the MAP is NO_MATCH, the route is filtered.

CLASSIFIER

Keyword.
In the del command, if no other parameters are specified, all filters associated to
the CLASSIFIERSs will be deleted

classifier_name

Name of the CLASSIFIER to associate to the route filtering process.


In this context purpose of the CLASSIFIER is to filter the routes so the following
roule is applied:
if the result of the CLASSIFIER is PERMIT, the route is not filtered;
if the result of the CLASSIFIER is DENY, the route is filtered;
if the result of the CLASSIFIER is NO_MATCH, the route is filtered.

Dir

Indicate in which direction the filter is applied


Dir = IN means that the filter is applied in ingress on the received routes from the
BGP protocol;
Dir = OUT means that the filter is applied in outgoing direction on the routes
sends by BGP protocol.

ip addr neighbor

Neighbor IP address where the filter is applied.

BGP attribute manipulation

ATOS\Ip\BGP>> add ?
add command parameters:
<attribute-mod><Map_name><dir><ip addr neighbor>

ATOS\Ip\BGP>> del ?

ATOS User Guide


IP - 125 / 483

del command parameters:


<attribute-mod>[<Map_name><dir><ip addr neighbor>]

Table 93: add/del attribute-mod


Syntax

Description

ATTRIBUTE_MOD

Keyword

map_name

Name of the MAP to associate to the attribute manipulation process.

Dir

Indicate in which direction the MAP is applied


Dir = IN means that the MAP is applied in ingress on the received routes from the
RIP protocol;
Dir = OUT means that the MAP is applied in outgoing direction on the routes
sends by RIP protocol.

ip addr neighbor

Neichbor IP address where the attribute manipulation will be applied.

OSPF Commands
The Open Shortest Path First (OSPF) protocol, defined in RFC 2328.
OSPF protocol is based on link-state technology which is started from the Bellman-Ford vector
based algorithms used in IP routing protocols such as RIP. OSPF has introduced new concepts such
as authentication of routing updates, Variable Length Subnet Masks (VLSM), route summarization,
etc.
To create an OSPF process the following command is available in the IP node1:
ATOS\Ip>>add ?
add command parameters:
<OSPF><name>
ATOS\Ip>>del ?
del command parameters:
<OSPF name string>

In ATOS 4.0.x only one OSPF process can be added

ATOS User Guide


IP - 126 / 483

Table 94: add/del OSPF


Syntax

Description

Ospf

Keyword

<name>

Name to identifier the OSPF process. The new ospf process is


identified by the name ospf-x where x is the name string used
in the add command. A new ospf-x subnode is dynamically
created

OSPF-x node
In the ospf-x subnode, the following commands are available:
ATOS\Ip\ospf-x>>set ?
Nodes not available.
Set command parameters:
static-router-id
rfc1583-compatibility
distance
loglevel

<ip addr>
<enable|disable>
<value>
<value>

Table 95: set


Syntax

Description

static-router-id

It defines the ospf router id. it identifies the router into Autonomous
System.

<ip addr>

If the router-id is changed, to activate the new value a SW reboot


must be performed.
[default: 0.0.0.0]
rfc1583-compatibility
<enable|disable>

In case of multiple routes that announce the same destination, it


selects which preference rules must be followed.
Enable = RFC1583 preference rules are used;
Disable = RFC2328 preference rules are used.
[default: disable]

Distance

It defines the distance assigned to the ospf routing protocol.

<value>

It can assume the value 1 to 254. [default: 110]

Loglevel

Set the detail level used by ATOS to log OSPF. [default: 1]

<value>

ATOS\Ip\ospf-1>>add ?
<area><IP address format>
<interface><interface_name>

ATOS User Guide


IP - 127 / 483

Table 96: add


Syntax

Description

<area>

Keyword

<IP address format>

It defines an area trough the area-id, expressed by an IP address


format, where OSPF protocol is active.
A new area-n.n.n.n subnode is dynamically created
The area-id 0.0.0.0 is reserved to the backbone area.

<interface>

Keyword

<interface_name>

It identifies the interface (a list of available interface is shown) on


which the OSPF protocol is active.
A new interface-name subnode is dynamically created

ATOS\Ip\ospf-1>>del ?
del command parameters:
Area-<IP address format>
Interface-<interface_name>
Table 97: del
Syntax

Description

Area-<IP address format>

Delete the selected area.

Interface-<interface_name>

Delete the selected interface.

OSPF area configuration


After creating a new area 1.1.1.1 the following setting are available:
ATOS\Ip\ospf-1\area-1.1.1.1>>set

Nodes not available.


Set command parameters:
ext-routing-capability <stub-area|no-stub-area>
stub-default-cost
<value>
loglevel
<value>
Table 98: set
Syntax

Description

ext-routing-capability

It defines if the area is a stub area or it isnt. In case of stubarea configuration, the routing to external destination will be based
on existence of the default route. [default: no-sub-area]

<stub-area|no-stub-area>

ATOS User Guide


IP - 128 / 483

-default-cost
<value>

If the area is defines as stub-area and the router is a area-border


router, this parameter indicates the default route cost that it is
annunced into area. [default: 0]

Loglevel

Set the detail level used by ATOS to log OSPF area.

<value>

Range: 1-5, default: 1.

OSPF interface configuration


After creating a new ospf interface LAN0 the following setting are available:
ATOS\Ip\ospf-1\interface-lan0>>set ?
Nodes not available.
Set command parameters:
area
rxmt-interval
inftrans-delay
hello-interval
router-dead-interval
ifc-output-cost
router-priority
authentication-type
password
loglevel

<area-1.1.1.1>
<value>
<value>
<value>
<value>
<value>
<value>
<none|Simple_password|MD5>
<string>
<value>

Table 99: set


Syntax

Description

Area

It defines the area associated to the interface. A list of available


areas will be shown using the help subcommand.

Rxmt-Interval

Time in seconds within retransmission of LSA, between adjacent


routers that belong to the interface.

<value>

This timer is ised also in case of Database Description and Link


State Request packet retransmission.
[0 - 65535 sec, default 5]
InfTrans-Delay
<value>

Indicate the time in seconds that is needed to transmit a Link State


Update Packet into interface.
[0 - 65535 sec, default 1]

Hello-Interval
<value>

It rappresents the timer in seconds within Hello packets that the


router sends into interface. It must be the same for all routers
connected to the same network.
[0 - 65535 sec, default 10]

router-dead-interval

When this timer has expired, the router declares the neighbor down.

<value>

The timer is started when the router stops itself to receive Hello
packets from the neighbor.
[0 - 65535 sec, default 40]

Ifc-Output-Cost

It defines the cost for outgoing packets sent into interface,

ATOS User Guide


IP - 129 / 483

<value>

expressed in link state metric. It will be announced as link cost for


the interface, in the router-LSA message.
[0 - 255 sec, default 10]

Router-Priority
<value>

It is a 8 bit entire number. It is used during the Designated Router


election phase. The router with the higher priority value will be
elected as DR.
[0 - 255 sec, default 1]

authentication-type
<none|Simple_password|MD5>

Set the authentication procedure to use in the network. This value


must be the same for all router connected in the same network.
Default none.

Password
<string>

Set the password used during the authentication procedure to verify


OSPF packets into interface.
[max 8 characters]

Loglevel

Set the detail level used by ATOS to log OSPF interface.

<value>

Range: 1-5, default: 1.

OSPF redistribution and filtering


To redistribute and filter routes into OSPF, the following commands are available:
ATOS\Ip\ospf-1>>add ?
add command parameters:
<redistribute><protocol>[<map><map_name>][<metric><value>]
[<metric-type><value>][<tag><value>]
<protocol> = <local|static|bgp|rip>
Table 100: add
Syntax

Description

REDISTRIBUTE

Keyword

Protocol

It defines the protocol to be redistribute.


Local = local routes will be redistributed into OSPF
Static = static routes will be redistributed into OSPF
RIP = routes received by RIP will be redistributed into OSPF
BGP = routes received by OSPF will be redistributed into OSPF

MAP

Keyword

map_name

Name of the map associated to the redistribution.


If no map is specified, all routes belonging to the protocol with the
specified METRIC and TAG value will be redistributed.
On the contrary, if a map name is specified, METRIC and TAG
value to be use in the routes redistribution, must be configured in
the ip\routemng\map_name command as additional actions for
the same map.
If in the same protocol more entries are added, only one entry can

ATOS User Guide


IP - 130 / 483

be use without route_map specified. In this case, it is processed first


the entries associated to the route_map, then the entry withoute
route_map.
To evaluate the entries with route_map specified, the return value
from the route_map configuration is used to decide how to manage
the routes:

in case of PERMIT the redistribution will be done using


the parameters specified in route_map;

in case of DENY the route is not redistribute;

in case of NO_MATCH, the following entry will be


checked.

If no match is verified after checking all maps, the route is not


redistribute..
Metric

Keyword

metric value

Value of the metric for the redistribute route.

Metric_type

Keyword

Metric type value

It defines the metric type to use for the redistribution.


type 1 = entire path cost
type 2 = cost internal AS path

TAG

Keyword

tag value

Il valore del campo tag nella rotta redistribuita.

ATOS\Ip\ospf-1>del ?
del command parameters:
<redistribute>[<protocol>[<map><map_name>]]
Table 101: del
Syntax

Description

REDISTRIBUTE

Keyword. If no other parameters are specified, all redistribution will


be deleted..

Protocol

It defines the protocol.

MAP

Keyword

Map_name

It specify the route map name present into entry to be delete.

On the OSPF-1 node it is possible to configure route filters using an association of MAP or a
CLASSIFIER through the following command:
ATOS\Ip\ospf-1>>add ?
add command parameters:
<filter><map|classifier><name><dir><area-name>
To eliminate a filter the following command is available:

ATOS User Guide


IP - 131 / 483

ATOS\Ip\ospf-1>>del ?
del command parameters:
<filter>[<map|classifier><name><dir><area-name>]
Table 102: add/del filter
Syntax

Description

FILTER

Keyword.
In the del command, if no other parameters are specified, all filters will be
deleted.

MAP

Keyword.
In the del command, if no other parameters are specified, all filters associated to
the MAPs will be deleted.

map_name

Name of the MAP to associate to the route filtering process


In this context purpose of the MAP is to filter the routes so the following roule is
applied:
if the result of the MAP is PERMIT, the route is not filtered;
if the result of the MAP is DENY, the route is filtered;
if the result of the MAP is NO_MATCH, the route is filtered.

CLASSIFIER

Keyword.
In the del command, if no other parameters are specified, all filters associated to
the CLASSIFIERSs will be deleted

classifier_name

Name of the CLASSIFIER to associate to the route filtering process.


In this context purpose of the CLASSIFIER is to filter the routes so the following
roule is applied:
if the result of the CLASSIFIER is PERMIT, the route is not filtered;
if the result of the CLASSIFIER is DENY, the route is filtered;
if the result of the CLASSIFIER is NO_MATCH, the route is filtered.

Dir

Indicate in which direction the filter is applied


Dir = IN means that the filter is applied in ingress on the received routes from the
BGP protocol;
Dir = OUT means that the filter is applied in outgoing direction on the routes
sends by BGP protocol.

Area-name

Name of the OSPF area where the filter is applied.

OSPF attribute manipulation

ATOS\Ip\ospf-1>>add ?
add command parameters:
<attribute-mod><Map_name><dir><area-name>

ATOS User Guide


IP - 132 / 483

ATOS\Ip\ospf-1>>del ?
del command parameters:
<attribute-mod>[<Map_name><dir><area-name>]
Table 103: add/del attribute-mod
Syntax

Description

ATTRIBUTE_MOD

Keyword

map_name

Name of the MAP to associate to the attribute manipulation process.

Dir

Indicate in which direction the MAP is applied


Dir = IN means that the MAP is applied in ingress on the received routes from the
RIP protocol;
Dir = OUT means that the MAP is applied in outgoing direction on the routes
sends by RIP protocol.

Area-name

Name of the OSPF area where the attribute manipulation is applied

ATOS User Guide


IP - 133 / 483

ISDN WAN Interfaces


ATOS permits the use of ISDN BRI interfaces as WAN. Each ISDN WAN can be configured to use
a variable links, from a minimum of one (only one B channel) to six, depending of HW and of the
ISDN interfaces used.
ISDN WAN protocoll used is PPP. When more than one B channel are used for the same link,
Multilink PPP protocol is supported.

Creating a WAN-ISDNx
To create an ISDN WAN, add command is available in the root node:
ATOS>>add ?
add command parameters:
<WAN-ISDN | WAN-FR-SERV>

Table 104: add


Syntax

Description

WAN-ISDN

Creates a new Wan-isdnx where x start from 1 (the first ISDN Wan
created) to 6, depending of the HW equipment

WAN-FR-SERV

Creates a new Frame relay Wan. Up to 6 Wan-Fr-Servx can be built


where x start from 1 (the first WAN-FR-SERV created) to 6. For
further information see Frame Relay WAN Interfaces Chapter

Every time you add an ISDN WAN, the corresponding WAN-ISDNn node is dynamically created.
The relevant sub-nodes will be available starting from WAN-ISDNx node:
ATOS\wan-isdn1>>tree
wan-isdn1
ppp

ip

lcp
authentication
ipcp
mlppp
rip
nat

isdn-bundle

WAN-ISDNx Commands
The following commands are available in the nodes:

echorequest

ATOS User Guide


IP - 134 / 483

ATOS\wan-isdn1>>set ?
Nodes available:

ppp
ip
isdn-bundle

Set command parameters:


<on|off>
remoteadmin
loglevel
acl-in
acl-out
acl-act
multicast
multicast-limit
open-mode
network-group
network-group-disable-time

<on|off>
<value>
<None>
<None>
<None>
<on|off>
<None>
<on-traffic|on-command>
<Empty list>
<value>

Table 105: set


Syntax

Description

remoteadmin <on|off>

Enable/disable the WAN-ISDNx interface to remote management


of the device. Default:off.

loglevel <value>

Set the detail level used by ATOS to log the events of the ISDN
WANx [default: 1]

acl-in
<string>

Name of the Access List created in the accesslist node to be


associated to the ingress traffic of ISDN WAN interface.

acl-out
<string>

Name of the Access List created in the accesslist node to be


associated to the outgoing traffic of ISDN WAN interface

multicast <on|off>

Enable/disable the WAN-ISDNx interface to multicast. [default:


off]

multicast-limit
<string>

Associate an access list previously created to outgoing multicast


traffic

open-mode

Configure ISDN WAN session modes:

<on-traffic|on-command>

On-traffic: the session is opened in case of traffic over the


interface;
On-command: the session is opened and closed with the connect
and disconnect commands.
[default: on-traffic]

network-group
<string>

Name of the network-group created in the ip\network.group


node to be associated to the ISDN WAN interface

network-group-disable-time
<value>

Time to delay the ISDN WAN disconnection when a network-group


up state is received (e.g. the main interface recovers)

ATOS User Guide


IP - 135 / 483

Connect and Disconnect


ATOS\ wan-isdn1>>connect
ATOS\ wan-isdn1>>disconnect

Table 106: connect - disconnect


Syntax

Description

connect

Manually open the session for the ISDN WAN interface selected.
The command is valid only if ISDN Wan configuration is
completed. The session is closed in case of no traffic over the
interface for a certain time configured in set wan-isdn1 ppp
inactivitytime.

disconnect

Manually close the session for the the ISDN WAN interface
selected. The command is valid only if ISDN Wan configuration is
completed.

WAN-ISDNx - Nodes
You can show the structure of the WAN-ISDNx node with the tree command:
ATOS\wan-isdn1>>tree
wan-isdn1
ppp

lcp
authentication
ipcp
mlppp
rip
nat

ip
isdn-bundle

PPP Commands
The PPP subnode is used to configure the PPP protocol.
ATOS\wan-isdn1\ppp>>set ?
Nodes available:
lcp
authentication
ipcp
mlppp

echorequest

ATOS User Guide


IP - 136 / 483

Set command parameters:


maxconfigure
<value>
maxterminate
<value>
maxfailure
<value>
restarttimer
<value>
inactivitytime <value>
loglevel
<value>

Table 107: set


Syntax

Description

maxconfigure <value>

Maximum number of requests to establish the PPP session over


WAN (CFG REQUEST) in order to consider the attempt as failure.
Range: 1- 20, default: 10.

maxterminate <value>

Maximum number of requests to clear the PPP connection


(TERMINATE REQUEST) in order to clear the connection.
Range: 1- 20, default: 2.

maxfailure <value>

Maximum number of negative acknowledgements during the


negotiation phase of the PPP session parameters (CFG NAK) before
sending the acknowledge message (CFG ACK). Range: 1- 20,
default: 5.

restarttimer <value>

Set the timeout between two attempts for the parameters above.
Range: 1- 30 secondi, default: 3 sec..

inactivitytime <value>

Indicate the time after which the PPP session is cleared in case of
no data packet transmission. The timer is not active if the value is 0.
This means that the connection is always-on , i.e. it is active as
long as the physical level is active. If the value is not 0, the
connection is on-demand , i.e. it activates with data traffic and
remains active until the set timer expires. Range: 0- 65535 seconds,
default: 0.

loglevel <value> [-s]

Set the detail level for the information generated by ATOS


following to errors on the services offered by the PPP subnode
(default: 1). The command is extended to the subnodes by selecting
the [s] option.

PPP Nodes
The PPP node contains the lcp (Link Control Protocol), authentication (configuration of
authentication parameters), ipcp (configuration of compression type) and mlppp (use of multilink
PPP Protocol) subnodes.

LCP Commands
ATOS\wan-isdn1\ppp\lcp>>set ?
Nodes available:

echorequest

ATOS User Guide


IP - 137 / 483

Set command parameters:


mru <value>
pfc <on|off>
acfc <on|off>
echo <on|off>
Table 108: set
Syntax

Description

mru <value>

Value of the MRU parameter (Max Receive Unit) in bytes. Range:


256-1500, default: 1500.

pfc <on|off>

Activate/deactivate the compression of the PID field (default: off).

acfc <on|off>

Activate/deactivate the compression of the Address and Control


field (default: off).

echo <on|off>

Activate/deactivate the sending of PPP ECHO REQUEST packets


to check the status of the PPP link (default: on).

LCP - Nodes
ATOS\wan-isdn1\ppp\lcp\echorequest>>set ?
Nodes not available.
Set command parameters:
maxretries <value>
timeout
<value>
Table 109: set
Syntax

Description

maxretries <value>

Maximum number of ECHO requests in order to terminate the PPP


link in case of no reply from the server .Range: 1-255, default: 5.

timeout <value>

Time between two ECHO requests. Range: 1-255 seconds, default:


30 sec..

Authentication Commands
The commands for the configuration of the authentication parameters are contained in the
authentication node:
ATOS\wan-isdn1\ppp\authentication>>set ?
Nodes not available.
Set command parameters:
username <string>
password <string>

ATOS User Guide


IP - 138 / 483

pap
chapmd5
ms-chapv1
ms-chapv2

<on|off>
<on|off>
<on|off>
<on|off>

Table 110: set


Syntax

Description

username <string>

pap <on|off>

Username (typically provided by the ISP) for authentication with the


remote server.
Field with 0-25 characters, default: empty.
Password (typically provided by the ISP) for authentication with the
remote server.
Field with 0-15 characters, default: empty.
Activate/deactivate the PAP authentication mode (default: on).

chapmd5 <on|off>

Activate/deactivate the CHAPMD5 authentication mode (default: on).

ms-chapv1 <on|off>

Activate/deactivate the MS-CHAPv1 authentication mode (default: off).

ms-chapv2 <on|off>

Activate/deactivate the MS-CHAPv2 authentication mode (default: off).

password <string>

ATOS supports the PAP and CHAP MD5 authentication modes. If ATOS does not supports the
requested protocol during the negotiation phase of the authentication protocol, ATOS replies with
the safest enabled protocol. The authentication phase ends when client and server agree on the
protocol to use.

IPCP Commands
ATOS\wan-isdn1\ppp\ipcp>>set vjcomp <on|off>
Table 111: set vjcomp
Syntax

Description

on|off

Activate/deactivate the reception of packets compressed with the Van


Jacobson technique. Default: on.

MLPPP Commands
From the ATOS\wan-isdn1\ppp\mlppp>> node you can set the following feature:
ATOS\wan-isdn1\ppp\mlppp>>set ?
Nodes not available.
Set command parameters:
bacp-enable <on|off>
edo-enable <on|off>

ATOS User Guide


IP - 139 / 483

Table 112: set


Syntax

Description

bacp-enable <on|off>

Enable/disable the Bandwith Allocation Control Protocol


procedure [default off]
Enable/disable the Endpoint Discrimination Option (EDO) feature.
[default off]

edo-enable

<on|off>

IP Commands
This node is used to configure the IP protocol parameters over the WAN-ISDNx.

ATOS\wan-isdn1\ip>>set ?
Nodes available:
rip
nat
Set command parameters:
address
<ip addr>[/value]
netmask
<ip addr>
defaultrouter
<ip addr>
remoteaddress
<ip addr>
addressvalidation <on|off>
napt
<on|off>
mtu
<value>
dhcp-client
<on|off>
loglevel
<value>

Table 113: set


Syntax

Description

address <ip add>

IP address of the WAN-ISDNx port (default: 0.0.0.0).

netmask <ip add>

WAN-ISDNx subnet mask (default: 0.0.0.0, i.e. the implicit subnet


mask of the IP address class is assigned).

defaultrouter <ip addr>

Set the default router IP Address of the WAN-ISDNx (default:


0.0.0.0).

remoteaddress <ip add>

IP address of the system connected to the remote side of the WANISDNx (default: 0.0.0.0).

addressvalidation <on|off>

Activate/deactivate the function used to check if the source IP address


contained in every packet received from the WAN-ISDNx port is
included in the routing tables as address that can be reached from the

ATOS User Guide


IP - 140 / 483

WAN-ISDNx port. The packet is accepted if the address is present,


otherwise it is rejected. (Default: off).
napt <on|off>

Activate/deactivate the NAPT function (configured in the NAPT


node) in the WAN-ISDNx. (Default: on).

mtu <value>

MTU (Maximum Transmission Unit) parameter. Range: 576-2048,


default: 1500.

loglevel <value> [-s]

Detail level for the information generated by ATOS on the services


offered by the IP subnode (default: 1).The command is extended to
the subnodes by selecting the [s] option (default 1)..

IP Nodes
RIP
The configurable parameters for the Routing Information Protocol (RIP) over the WAN-ISDNx
interface are the same as the parameters for the LAN interface. The only difference between the two
interfaces for the RIP refers to the default value: OFF for LANx and BOTH for WAN-ISDNx.
ATOS\WAN-ISDNx\ip\rip>>set ?
Nodes not available.
Set command parameters:
<off|both|receive>
version <v1|v2|v1compatible>

NAT
The following commands are available for NAT configuration over WAN_ISDNx:
ATOS\WAN-ISDNx\ip\nat>>set ?
Nodes not available.
Set command parameters:
address <ip addr>
alias
<string>
Table 114: set
Syntax

Description

address <ip add>

IP address for the NAT, as alternative to the public IP address assigned to the WANISDNx. If the parameter is configured, the source address of the outgoing packets
from the WAN-ISDNx interface is the parameter value.

alias <string>

Alias name used in the WAN-ISDNx created in the NAPT\ALIAS node.

ATOS\WAN-ISDNx\ip\nat>>add <ip add>

ATOS User Guide


IP - 141 / 483

Table 115: add


Syntax

Description

ip add

Create a list of IP addresses that are ignored by the NAT operations. Incoming and
outgoing packets having one of the IP addresses contained in the list in the
destination and source field, respectively, are ignored by the NAT operations.

ATOS\WAN-ISDNx\ip\nat>>del <ip add>


Table116: del
Syntax

Description

ip add

Delete one entry from the list of IP addresses that are ignored by the NAT operations.

ISDNBUNDLE Commands
When a WAN-ISDNx has been created, the isdn-bundle automatically appears. This node is used
to configure several parameters, to define the use of the ISDN ports and the remote connection:

ATOS\wan-isdn1\isdn-bundle>>set ?
Nodes not available.
Set command parameters:
loglevel
first-called-number
first-called-subaddress
other-called-number
other-called-subaddress

<value>
<decimal
<decimal
<decimal
<decimal

string>
string>
string>
string>

Table 117: set


Syntax

Description

loglevel <value>

Detail level for the information generated by ATOS on the isdnbundle node (default: 1).

first-called-number
<decimal string>

Define the first ISDN number to call to activate the PPP connection

first-called-subaddress
<decimal string>

Define the first ISDN subadress, if necessary, to call to activate the


PPP connection

other-called-number
<decimal string>

Define an other ISDN number to call to activate a MLPPP


connection, using a different number from the first one called

other-called-subaddress
<decimal string>

Define an other ISDN subaddress, if necessary to call to activate a


MLPPP connection.

ATOS User Guide


IP - 142 / 483

To define which ISDN ports to use for the selected WAN-ISDN interface, the following command
is available:
ATOS\wan-isdn1\isdn-bundle>>add ?
add command parameters:
<ISDNLINE><line-id>
Table 118: add
Syntax

Description

ISDNLINE <line-id>

Define the ISDN port interface to use for the selected WAN-ISDN
interface.
Line-id can be from 1 to 3, depending either of the HW.
After a successful add command, a new ISDNLINEx node will be
created, where x is the number of the line-id used.
If the ISDN port is busy to an other service, the command is refused
with the following warning:
ATOS\wan-isdn1\isdn-bundle>>add isdnline 1
ISDN line 1 is already in use on VOIP
Command not executed

ISDNBUNDLE\ISDNLINEx node
In the ISDN-BUNDLE\ISDNLINEx node, the following parameters can be configured:

ATOS\wan-isdn1\isdn-bundle\isdnline1>>set ?
Nodes not available.
Set command parameters:
link-b-number
<value>
calling-number
<decimal string>
calling-subaddress <decimal string>
tei
<auto|<value>>
Table 119: set
Syntax

Description

link-b-number <value>

Select the number of ISDN B channels to use for the outgoing calls
(default: 1).

calling-number
<decimal string>

Configure the ISDN calling number that will be used in the calling
party number field for the outgoing SETUP. If this parameter is
empty, the outgoing SETUP will be sent without any calling party

ATOS User Guide


IP - 143 / 483

number.
calling-subaddress
<decimal string>

Configure the ISDN calling subadress that will be used in the calling
party subaddress field for the outgoing SETUP. If this parameter is
empty, the outgoing SETUP will be sent without any calling party
subaddress.

tei <auto|<value>>

Configure the TEI value to use for the selected ISDNLINE port.
For PMP (Point to Multipoint) ISDN network, select auto;
(default),
For PP (Point to Point) ISDN network, select 0;
Other value are usually not implemented in the ISDN network

ATOS User Guide


LAN Interfaces - 144 / 483

LAN interfaces
LAN means Local Area Network, that is to say a local network in a confined area (building, office).
Within ATOS, a LAN interface is a communication interface, supporting bridging and routing
operation. One or multiple LAN interfaces are defined depending on the specific hardware model
(usually referred to as lan0, lan1, etc.).
A logical LAN interface is an abstract interface built on top an a LAN interface. All the traffic from
and to this logical LAN interface is actually transferred over the underlying LAN interface. The
traffic flows related to the different logical LAN interfaces are differentiated at the IP level (i.e.
different IP subnets) or at the MAC level (using VLAN tagging). Creating logical LAN interfaces
does not prevent direct access to the underlying LAN interface.

Bridging and Routing Engines

Logical Interface

Logical Interface
LAN Interface

Ethernet Port

A LAN interface can be mapped onto a single physical Ethernet port or to an embedded MAC
switch with multiple physical ports (e.g. 4 or 8 ports). The basic operation of a MAC switch is to
provide 802.1D self learning bridging between its physical ports and the LAN interface.

LANx Commands
ATOS\lan0>>set ?
Nodes available:
ip
bridgepar
phy1
l2switch2

If LANx interface is mapped onto a single physical Ethernet port.

If LANx interface is mapped to an embedded MAC switch with multiple physical ports (e.g. 4 or 8 ports).

ATOS User Guide


LAN Interfaces - 145 / 483

Set command parameters:


<on|off>
loglevel
<value>
acl-in
<string>
acl-out
<string>
multicast
<on|off>
multicast-limit <string>
bridging
<on|off>
prio-id-extension <on|off>
ATOS\lan0>>add ?
add command parameters:
<logic LAN name string> [<vid> [<priority>]]
Table 120: set
Syntax

Description

<on|off>

Enable/disable the LAN interface (default on).

loglevel <value>

Set the detail level <0-5> used by ATOS to log the events of the
LAN node. If you select the [-s] option, the configuration extends to
all subnodes of the current node.
Range: 1-5, default: 1.

bridging <on|off>

Activate/deactivate the bridging mode. [default: off]

multicast <on|off>
4

Enable/disable the interface to multicast. [default: off]

multicast-limit <string>

Associate an access list previously created to outgoing multicast


traffic.

Acl-in

Name of the Access List created in the accesslist node for


incoming LAN0 packets.

Acl-out

<string>
<string>

Name of the Access List created in the accesslist node for


outgoing LAN0 packets.

prio-id-extension <on|off>

If this parameter is enabled, a vlan is identified by both VID and


priority values. [default: off]

LANx Nodes
IP - Commands
The IP parameters of the LANx (address and net mask) are configured in this subnode.

ATOS can process incoming multicast traffic to the interface enabled to multicast and replicate it over all interfaces with
multicast on.
4

An access list can be associated to each interface to delimit traffic on that interface.

ATOS User Guide


LAN Interfaces - 146 / 483

ATOS\lan0\ip>>set ?
Nodes available:

rip
nat

Set command parameters:


address
<ip addr>[/value]
netmask
<ip addr>
defaultrouter <ip addr>
napt
<on|off>
dhcp-client
<on|off>

Table 121: set


Syntax

Description

address
<ip addr>[/value]

Set IP the LANx IP address5.

netmask <ip addr>

Set the LANx net mask6 (default: 255.0.0.0).

defaultrouter <ip addr>

Set the deafult router IP address (deafult 0.0.0.0)

napt <on|off>

Enable/disable napt on LANx interface. If this parameter is on, the


HTTP and Telnet management are not available from the LAN
interface. To enable the management it is mandatory to open the
service HHTP and Telnet on the Napt\Proxy node [default: off]

dhcp-client <on|off>

Enable/disable dhcp-client on LANx interface. [default: off]

BridgePar Commands
The following commands can be used to configure the bridging parameters of the interface.
ATOS\lan0\bridgepar>>set ?
Nodes not available.
Set command parameters:
<bridge1|bridge2|bridge3|bridge4>
priority
<value>
cost
<value>
flow-direction
<tx|rx|tx-rx|off>
vlan-out-mode7
<tag|transparent|untag>
vlan-in-mode
<tag|transparent|untag>

Default IP address for LAN0 interface: 10.0.0.1.

Default IP net mask address for LAN0 interface: 255.0.0.0.

Command available in L2LogicLAN/BridgePar node only.

ATOS User Guide


LAN Interfaces - 147 / 483

Table 122: set


Syntax

Description

<bridge1|bridge2|bridge3|
bridge4>

Set the bridging class associated with the interface. Configurable


values: bridge1 / bridge2 / bridge3 / bridge4.
Default: bridge1.

priority <value>

Set the priority associated to the port. Range: 0~255, default: 128.

cost <value>

Set the cost associated to the bridge port. Range: 0~65535, default:
1000/line rate.

flow-direction

Set flow direction:

<tx|rx|tx-rx|off>

tx enable LANx interface to transmit bridge traffic,


rx enable LANx interface to receive bridge traffic,
tx-rx enable LANx interface to transmit and receive bridge
traffic,
off disable LANx interface to transmit and receive bridge traffic.
[default: tx-rx]

vlan-out-mode
<tag|transparent|untag>

Define the level 2 action to perform on outgoing packets:


tag option add the 802.1Q encapsulation,
transparent option forward packets without any change,
untag option remove, if present, the 802.1Q encapsulation.
[default: tag]

vlan-in-mode
<tag|transparent|untag>

Define the level 2 action to perform on incoming packets:


tag option add the 802.1Q encapsulation,
transparent option forward packets without any change,
untag option remove, if present, the 802.1Q encapsulation.
[default: untag]

LogicLANname - Commands
Logical LANs are dynamically created under the relevant LAN interface node. It is possible to
create up to 16 logic LAN.
If the optional vid8 parameter is present in the command line, the logical LAN interface acts as a
layer 2 Virtual LAN (VLAN) interface that can be connected across a Layer 2 bridge to other LAN,
VLAN or WAN interfaces (typically ATM PVC with RFC2684 "bridged" encapsulation).
Independently from the vid parameter, a Logical LAN interface can also operate as a network
interface for the routing engine. Once the logical LAN interface has an IP address and a network
mask configured, the routing engine will use this interface to forward IP packets destined to the

VLAN ID.

ATOS User Guide


LAN Interfaces - 148 / 483

connected IP subnets, as it would for a physical LAN interface. If a null IP address is configured
(0.0.0.0) for this interface, then this interface will not receive or forward IP traffic.
ATOS\lan0>>add ?
add command parameters:
<logic LAN name string> [<vid> [<priority>]]
vid = 1-4094
priority = 0-7

Table 123: add LogicLAN


Syntax

Description

LogicLAN_name

Name of the subinterface to create.

vid

802.1Q vlan id; range: 1 - 4094

priority

802.1p bits, range: 0 - 7

Next, an example:
ATOS\lan0>>add L2_LogicLAN 1 0
Command executed
ATOS\lan0>>add L3_LogicLAN
Command executed

LANx L3_LogicLAN - Commands


ATOS\lan0\L3_LogicLAN >>set ?
Nodes available:
ip
Set command parameters:
loglevel
<value>
acl-in
<string>
acl-out
<string>
The loglevel, acl-in and acl-out commands are similar to the equivalent commands in LANx
interface.

LANx L3_LogicLAN Nodes

ATOS User Guide


LAN Interfaces - 149 / 483

ATOS\lan0\L3_LogicLAN>>tree
L3_LogicLAN
ip
rip
nat

The ip, rip and nat nodes are similar to the equivalent nodes in a LANx interface.

LANx L2_LogicLAN - Commands


ATOS\lan0\L2_LogicLAN >>set ?
Nodes available:
ip
bridgepar
vlan
Set command parameters:
<on|off>
loglevel
<value>
acl-in
<string>
acl-out
<string>
multicast
<on|off>
multicast-limit <string>
bridging
<on|off>
The loglevel, acl-in, acl-out, multicast and multicast-limit and bridging
commands are similar to the equivalent commands in LANx interface.

LANx L2_LogicLAN Nodes


ATOS\lan0\L2_LogicLAN>>tree
L2_LogicLAN
ip
rip
nat
bridgepar
vlan

The ip, rip , nat and bridgepar nodes are similar to the equivalent nodes in a LANx
interface.
The vlan node is used to display the current values of the 802.1q VLAN ID and the 802.1p
priority bits (e.g. using the show conf command) or to modify them.

ATOS User Guide


LAN Interfaces - 150 / 483

ATOS\lan0\L2_LogicLAN\vlan>>show conf
Show of ATOS Lan0 vlan1 vlan
vlan id
: 1
vlan priority : 0

ATOS\lan0\L2_LogicLAN\vlan>>set ?
Set command parameters:
vid
<value>
priority <value>
The vid and priority parameters use values described in table 117

Phy - Commads
From ATOS 2.5 its possible to configure, in LANx node, the transmission mode of Ethernet port.
ATOS\lan0\phy>>set ?
Nodes not available.
Set command parameters:
link-mode <auto|10-half|10-full|100-half|100-full>

Table 124: set link-mode


Syntax

Description

Auto

Configure port in automatic mode (default), according to the 802.3


IEEE stardard.

10-half

Configure port in 10 half duplex transmission mode.

10-full

Configure port in 10 full duplex transmission mode.

100-half

Configure port in 100 half duplex transmission mode.

100-full

Configure port in 100 full duplex transmission mode.

L2switch Commads
ATOS\lan0\l2switch>>set ?
Nodes available:
port1
port2
port3
port9

4 or 8 ports, depending on device model.

ATOS User Guide


LAN Interfaces - 151 / 483

Set command parameters:


null-vid-replacement <on|off>

Table 125: set null-vid-replacement


Syntax

Description

on|off

Enable/disable the retagging action with the default port specific


VID10 to ingress frames with a null VID (a null VID may still carry
802.1p bits). [default: off]

ATOS\lan0\l2switch>>add ?
add command parameters:
add vlan <vid><port (n-m,k,l)>

Table 126: add vlan


Syntax

Description

vid

802.1Q vlan id; range: 1 - 4094

port (n-m,k,l)

Identify ports associated to vlan id. Ports can be configured one to


one, using a comma to separate them, or as a range.

L2switch Nodes
ATOS\Lan0\l2switch\portX>>set ?
Nodes not available.
Set command parameters:
link-mode
<auto|10-half|10-full|100-half|100-full>
default-vid <value>
default-prio <value>
tag-removal <on|off>

Table 127: set


Syntax

Description

link-mode

Configure the Ethernet port transmission

<auto|

in automatic mode (default), according to the 802.3 IEEE stardard.;

10-half|

in 10 half duplex mode,

10-full|

10

The default port VID parameter is configured on each portX subnode.

ATOS User Guide


LAN Interfaces - 152 / 483

100-half|

in 10 full duplex mode;

100-full>

in 100 half duplex mode;


in 100 full duplex mode.

default-vid <value>

Define the default vid applied to untagged ingress frames (range: 1


4094, default 0).

default-priority <value>

Define the default priority applied to untagged ingress frames


(range: 0 7, default 0).

tag-removal <on|off>

Enable/disable 802.1Q and 8021.p tag removal from the frames


transmitted from portX. [default: on]

Vlan packets (802.1q) coming from the local network are dropped when their VID value is
different from the one already configured on one of the switch ports. Ethernet packets (802.3)
coming from the local network become vlan packets with the default VID value.

LANx IP Nodes
Nat - Commands
The following commands are available for NAT configuration over LAN:
ATOS\lan0\ip\nat>>set ?
Nodes not available.
Set command parameters:
address <ip addr>
alias
<string>

Table 128: set


Syntax

Description

address <ip add>

IP address for the NAT, as alternative to the IP address assigned to


the LAN. If the parameter is configured, the source address of the
outgoing packets from the LANx interface is the parameter value.
[default: 0.0.0.0]

alias <string>

Alias name used in the LAN created in the NAPT\ALIAS node.

ATOS\wan1\ip\nat>>add <ip add>

Table 129: add


Syntax

Description

ip add

Create a list of IP addresses that are ignored by the NAT operations.

ATOS User Guide


LAN Interfaces - 153 / 483

Incoming and outgoing packets having one of the IP addresses


contained in the list in the destination and source field,
respectively, are ignored by the NAT operations.

ATOS\wan1\ip\nat>>del <ip add>

Table 130: del


Syntax

Description

ip add

Delete one entry from the list of IP addresses that are ignored by the
NAT operations.

RIP - Commands
ATOS uses the Routing Information Protocol (RIP) to exchange routing information with nearby
routers over WAN or LAN connections.
The following configurations are available for every WAN or LAN port:
ignore the incoming RIP traffic and avoid sending RIP datagrams (OFF);
send and receive RIP datagrams (BOTH);
receive RIP datagrams, acquiring information on the routing tables of nearby routers, without
sending the contents of the routing table (RECEIVE).
ATOS\lan0\ip\rip>>set <off|both|receive>

RIP datagrams cannot be sent over connections with NAPT.

Table 131: set


Syntax

Description

off|both|receive

RIP operating mode (default: off):


off, the use of RIP is not enabled;
both, ATOS periodically sends the contents of its routing table
over RIP packets and uses the received RIP packets to update its
routing table (active RIP);
receive, ATOS uses the received RIP packets to update its
routing table without sending the contents of its routing table
(passive RIP).

ATOS User Guide


LAN Interfaces - 154 / 483

ATOS can be configured to use version 1 or 2 of the RIP. You can select the V1-compatible mode,
where the RIP follows V2, without using multicast addresses. This allows the device to work with
routers supporting only RIP V1.
The information received from nearby routers is used to update the dynamic entries of the routing
table. If a dynamic entry of the routing table is not updated with RIP datagrams (typically after 180
seconds), the entry is deleted and the destination network is marked as not reachable.
However, the entry is not immediately deleted from the routing table so that the next RIP datagram
sent by the device propagates the information to the other routers. The entry is deleted after a
certain time (typically 30 seconds).
ATOS\wan1\ip\rip>>set version <v1|v2|v1compatible>

Table 132: set version


Syntax

Description

v1|v2|v1compatible

Set the RIP version:


v1, to use version 1;
v2, to use version 2;
v1compatible, to use version 2 without multicast addresses. The
device can work with routers supporting version 1 only.
[default: v1]

ATOS User Guide


Loopback Interfaces - 155/ 483

Loopback interfaces
The loopback interface is used to establish a virtual connection to a fictitious network inside a
device, allowing the client and server connected on the same device to communicate.
Packets sent to a loopback are not transmitted over the LANx or WANx. They are sent through a
fictitious network interface, internal to the TCP/IP stack.
The loopback interface delivers a connection that can be permanently used and reached, regardless of
the status of the other interfaces.
In addition to interface 127.0.01 (default), the loopback implementation in ATOS allows you to
define up to 32 additional loopback interfaces, whose IP addresses can be used as NAPT alternative
addresses in each WAN.

Loopback Commands
The following commands are available to configure the loopback interface:

ATOS\loopback>>add ?
[<loopback name>]<ip address[/<1-32>]>[<ifc name>[<NAT>]]
LIST OF AVAILABLE INTERFACES
ATM_VC0
ATM_VC1
ATM_VC2
ATM_VC3
ATM_VC4
ATM_VC5
ATM_VC6
ATM_VC7

Table 133: add


Syntax

Description

loopback name

Optionally a name can be assigned to the creating loopback


interface. In no loopback name is specified, the number of the IFC
interface is the progressive number after the last IFC interface in the
list.

ip address

Add a new loopback interface with IP address.

wan1|wan10

Set the WANx interface on which the NAPT function is not active,
for the loopback interface you have created (optional).

nat

Configure the loopback address as a NAPT address for the WANx


interface (optional).

ATOS User Guide


Loopback Interfaces - 156 / 483

ATOS\loopback>>del <loopback name>

Table 134: del


Syntax

Description

loopback name

Delete an existing loopback interface.

ATOS\loopback>>set loglevel <value>

Table 135: set loglevel


Syntax

Description

value

Set the detail level used by ATOS to record events of the loopback
interface. Range: 1-5, default: 1.

The following example shows the configuration of two new loopback interfaces:
ATOS\loopback>>add 213.199.5.1 wan1
Command executed
ATOS\loopback>>show conf
Show of ATOS loopback
Level of log : 1
List of loopback interface
ifc id
0
1

ip address
127.0.0.1
213.199.5.1

wan
--wan1

nat
--off

ATOS\loopback>>add 213.199.6.1 wan1 nat


Command executed
ATOS\loopback>> show conf
Show of ATOS loopback
Level of log : 1
List of loopback interface
ifc id
0
1
2

ip address
127.0.0.1
213.199.5.1
213.199.6.1

wan
--wan1
wan1

ATOS\loopback>>restart
Save configuration ? (Y or N) Y

nat
--off
on

ATOS User Guide


Loopback Interfaces - 157 / 483

Loopback1 (IFC ID 1) with address 213.199.5.1; set the parameter <wan1> to add the IP address of
Loopback1 to the HoleAddress list of the WAN1 (see section NAPT);
Loopback2 (IFC ID 2) with address 213.199.6.1; in addition to <wan1>, you have specified the
parameter <NAT> that adds the IP address of Loopback2 to the IPAddress list of the WAN1.
ATOS\wan1\ip\nat>>show conf
Show of ATOS wan1 ip nat
Nat address : 213.199.6.1
Alias name :
List of hole address
n ip address
0 213.199.5.1
1 213.199.6.1

The interfaces are activated upon configuration. The show conf command in the
ATOS\ip\route>> node shows the list of interfaces and the list of static routes:
ATOS\ip\route>>show conf
Show of ATOS ip route
List of available interface
Value interface
0
lan
1
atm_vc0
2
atm_vc1
3
atm_vc2
4
atm_vc3
5
atm_vc4
6
atm_vc5
7
atm_vc6
8
atm_vc7
9
loopbk0
10
loopbk1
11
loopbk2
List of static route
dest ip add
net mask
213.199.6.1
255.255.255.255
213.199.5.1
255.255.255.255
127.0.0.1
255.255.255.255

gateway add
0.0.0.0
0.0.0.0
0.0.0.0

interface
loopbk2
loopbk1
loopbk0

cost
0
0
0

type
local
local
local

ATOS User Guide


Monitor - 158/ 483

Monitor
ATOS can show statistics about interfaces and protocols. The monitoring of the typical parameters
of LAN and WAN, LES connections provides a diagnostic instrument to check the correct
operation of the device.

How to show the status of Aethra devices


The following command from CLI console is used to show the status of the device, for example to
check the operation of the ADSL:
show status [-s]

Table 136: show status


Syntax

Description

show status [-s]

The command given in a specific node shows the status of the


current node only; -s is used to show the status of parameters in
the subnodes that depend on the node where the command is given.
The nodes with the show status command are the nodes with log
generation.

ATOS\adsl>>show status
Adsl link status: up

How to show statistics


The following command is used to show statistics about the device operation. The nodes with
statistics are the nodes with log generation:
show statistics [-s]

Table 137: show statistics


Syntax

Description

show statistics [-s]

The command given in a specific node shows the statistics on the


current node only;
-s is used to show statistics of the subnodes that depend on the
node where the command is given.

ATOS User Guide


Monitor - 159 / 483

You can delete the statistics generated by ATOS with the following command:
delete statistics [-s]

Table 138: delete statistics


Syntax

Description

delete statistics [-s]

The command given in a specific node deletes the statistics of the


current node only;
-s is used to delete statistics of the subnodes that depend on the
node where the command is given.

ADSL statistics
ATOS\adsl>>show statistics
*********** Adsl statistics **********
****** Downstream direction ******
Channel bitrate interleaved: 8000 kbps
Channel bitrate fast: 0 kbps
Relative capacity occupation: 88 %
Noise margin: 8.0 dB
Output power: 15.5 dbm
Attenuation: 3.0 dB
****** Upstream direction ******
Channel bitrate interleaved: 928 kbps
Channel bitrate fast: 0 kbps
Relative capacity occupation: 98 %
Noise margin: 7.0 dB
Output power: 12.0 dbm
Attenuation: 2.5 dB
Table 139: ADSL statistics
Syntax

Description

Channel bitrate interleaved

If the provider connection profile is interleaved, it indicates the


connection rate. If the profile is fast, the value is 0.

Channel bitrate fast

If the provider connection profile is fast, it indicates the connection


rate. If the profile is interleaved, the value is 0.

Relative capacity
occupation

Percentage ratio between connection rate and maximum potential


rate of the device. The percentage depends on the contract
subscribed with the provider.

Noise margin

Noise margin that is still available, after which the system does not
guarantee the 10-7 error rate.

Output power

Output power from the public network modem in case of


downstream.

Attenuation

Attenuation introduced by the telephone line.

ATOS User Guide


Monitor - 160 / 483

How to show ATM statistics


ATM statistics are available in the ATOS\wanx\atm>> node. They refer to the traffic transmitted
and received over the individual virtual channel.
ATOS\wan1\atm>>show statistic
Statistics of physical atm_vc0 interface
******* Upstream direction *******
Frames : 20602
Errors : 0
Pool full errors : 0
Queue full errors : 0
****** Downstream direction ******
Frames : 48068
Bad CRC frames : 0
Too long frames : 0
Aborted frames : 0
Bad hec frames : 0
CLP frames : 0
Congestion frames : 0
Bad length frames : 0
FIFO overflow : 0

Table 140: ATM statistics


Syntax

Description

UPSTREAM DIRECTION
Frames

Number of packets transmitted over the interface.

Errors

Number of untransmitted packets due to driver AAL5 level error (API).

Pool full errors

Number of untransmitted packets due to the lack of memory block in


the physical transmission buffer pool (API).

Queue full errors

Number of untransmitted packets due to the lack of space in the


physical transmission queue (API).

DOWNSTREAM DIRECTION
Frames

Number of valid packets received on the interface.

Bad crc frames

Number of packets with errored CRC-AAL5 received on the interface.

Too long frames

Number of packets received on the interface with AAL5 payload longer


than the negotiated or configured MRU value plus the size of
encapsulation headers.

Aborted frames

Number of aborted packets received on the interface.

Bad hec frames

Number of packets received on the interface with at least one cell with
errored HEC.

Clp frames

Number of packets received on the interface with at least one cell with
CLP bit.

Congestion frames

Number of packets received on the interface with the last cell with PTI
congestion bit.

Bad length frames

Number of packets received on the interface with an octet number other


than the length indicated in the AAL5 length field.

ATOS User Guide


Monitor - 161 / 483

Fifo overflow

Number of packets received on the interface that were discarded due to


the lack of space in the reception FIFO.

How to show PPP statistics


These statistics are available on the WANx interfaces when the
wanx\service\encapsulation configuration parameter is pppoa or pppoe.
ATOS\wan1\ppp>>show statistic
Statistics of ppp on atm_vc0 interface
******* Upstream direction *******
Frames : 20601
****** Downstream direction ******
Frames : 48066
Invalid frames : 0
Unknown pid frames : 0
Discarded frames : 0

Table 141: PPP statistics


Syntax

Description

UPSTREAM DIRECTION
Frames

Number of packets transmitted on the interface.

DOWNSTREAM DIRECTION
Frames

Number of valid packets received on the interface.

Invalid frames

Number of packets received on the interface with one of the following


errors:
control or authentication protocol implemented with length lower than
the size of the message header;
control or authentication protocol implemented with length lower than
the length of the message header.

Discarded frames

Number of packets received on the interface that were discarded due to:
Echo Request with invalid format;
IP packet with IPCP layer not in opened status;
unexpected message in the current status of the protocol.

Unknown pid frames

Number of packets received on the interface with unimplemented


protocol.

ATOS User Guide


Monitor - 162 / 483

How to show PPPoE statistics


PPPoE statistics are available only on the WANx interfaces when the
wanx\service\encapsulation configuration parameter is pppoe.

ATOS\wan1\service\pppoe>>show statistic
Statistics of pppoe on atm_vc0 interface
******* Upstream direction *******
Frames : 50202
****** Downstream direction ******
Frames : 97302
Invalid frames : 0
Unknown ether-type frames : 0
Discarded frames : 0

Table 142: PPPoE statistics


Syntax

Description

UPSTREAM DIRECTION
Frames

Number of packets transmitted on the interface.

DOWNSTREAM DIRECTION
Frames

Number of valid packets received on the interface.

Invalid frames

Number of packets received on the interface with one of the


following errors:
size lower than the Ethernet header plus PPPoE header;
PPPoE payload lower than the Length field of the PPPoE header;
discovery packet with code other than PADO, PADS or PADT;
PPP Stage packet with code other than PPP (0x00);
PPP Stage packet with Session Id other than the assigned one;
PADO or PADS with length field = 0;
PADO with Session Id other than zero;
PADS or PADT with Session Id zero;
PADO or PADS with at least one invalid TAG for:
incomplete Type and Length field;
length field higher than available octets;
PADO or PADS without one or more compulsory TAGs.

ATOS User Guide


Monitor - 163 / 483

Discarded frames

Number of packets received on the interface that were discarded


for:
PPPoE Version or Type not supported;
MAC destination address other than your own;
PADO after selecting an AC;
PADS from an unselected AC;
PADS in PPP_STAGE status;
PADT with Session Id other than the used one;
PADT from an unselected AC;
PPP stage packet not in PPP_STAGE status;
PPP stage from an unselected AC.

Unknown ether-type frames

Number of packets received on the interface with the ether-type


field other than 0x8863 or 0x8864.

How to show DHCP statistics


ATOS\dhcp>>show statistic
Dhcp statistic
Plain bootp requests received:
Plain bootp replies sent:
Discover packets received:
Offer packets sent:
Dhcp request packets received:
Declines received:
Releases received:
Aacks sent:
Naks sent:
Requests for other servers:
Protocol errors all types:

0
0
1
1
1
0
1
1
0
0
0

Table 143: DHCP statistics


Syntax

Description

Plain bootp requests


received

Non- DHCP frame, of BOOTP type, same as Discover of DHCP.

Plain bootp replies sent

Non-DHCP frame, of BOOTP type, same as Offer of DHCP.

Discover packets received

Frame originated by the host to search for DHCP servers in the


network.

Offer packets sent

Frame originated by ATOS in reply to discover to indicate the


parameters offered by the DHCP server. The DHCP indicates the IP
address it can offer to the host.

Dhcp request packets


received

Frame originated by the host to request configuration parameters to


the DHCP server. The host indicates the IP address it wants to be
assigned.

ATOS User Guide


Monitor - 164 / 483

Declines received

Frame originated by the host after ack. reception. The host informs
that the IP address assigned to it is already in use.

Releases received

Frame originated by the host to indicate the release of the assigned


parameters. The host informs the release of the assigned IP address.

Aacks sent

Frame originated by ATOS in reply to the request to inform the


assigned parameters to the host. The DHCP informs the IP address
assigned to the host.

Naks sent

Frame originated by ATOS in reply to the request to inform the host


of the requested parameter it cannot satisfy. The DHCP informs if
the requested IP address is out of range.

Requests for other servers

DHCP or BOOTP frames sent to other DHCP servers.

Protocol errors all types

Sum of errors in reception:


reception of DHCP frames not expected;
reception of reply frames without MAGIC COOKIE option.

How to show IP statistics


These statistics are available on any type of WANx interface regardless of the encapsulation mode.
The statistics are show in the ATOS\wanx\ip>> node.
An example of Wan IP statistics:

ATOS\wan1\ip>>show statistic
Statistics of ip on atm_vc0 interface
******* Upstream direction *******
Frames : 2598
Discarded frames : 0
Max frame size : 52
Min frame size : 40
Average frame size : 40
Average speed (bps) : 8800
****** Downstream direction ******
Frames : 4864
Unexpected tcpcomp frames : 0
Invalid tcpcomp frames : 0
Max frame size : 1500
Min frame size : 28
Average frame size : 1497
Average speed (bps) : 653600

ATOS User Guide


Monitor - 165 / 483

Table 144: IP statistics


Syntax

Description

UPSTREAM DIRECTION
Frames

Number of packets transmitted on the interface.

Discarded frames

Number of transmitted packets discarded because the interface is


not open.

Max frame size

Maximum size of transmitted packets.

Min frame size

Minimum size of transmitted packets.

Average frame size

Average size of transmitted packets.

Average speed (bps)

Average speed in bits per second (time with interface closed is not
considered in the calculation).

DOWNSTREAM DIRECTION
Frames

Number of valid packets received on the interface.

Unexpected tcpcomp frames

Number of packets received on the interface with TCP/IP


compressed header when compression is not negotiated (this
parameter is only available with PPP or PPPoE encapsulation).

Invalid tcpcomp frames

Number of packets received on the interface with invalid TCP/IP


compressed header (this parameter is available only with PPP or
PPPoE encapsulation).

Max frame size

Maximum size of received packets.

Min frame size

Minimum size of received packets.

Average frame size

Average size of received packets.

Average speed (bps)

Average speed in bits per second (time with interface closed is not
considered in the calculation).

How to show statistics on voice interfaces


Statistics on voice interface can be shown in the ATOS\les\cpiwfn>> node.
ATOS\les\cpiwf1>>show statistic
Statistics of les_sm1\q931parser interface
Received frames:
Invalid frames:

0
0

Statistics of les_sm1\pcp interface


Received frames:
Invalid frames:

0
0

Statistics of les_sm1\pstn interface


Received frames:
Frames with error not rejected:

0
0

ATOS User Guide


Monitor - 166 / 483

Frames with error rejected:

Statistics of les_lap1\sssar interface


--------------------RX-----------TX---------Cps-packets
: 0
0
Frames
: 0
0
Too long (e10)
: 0
Ras timeouts (e11): 0
Statistics of les_lap1\ssted interface
------------------RX-----------TX---------Frames
: 0
0
Too long (e20) : 0
Bad length (e21): 0
Bad crc (e22)
: 0
-

Table 145: Voice interface statistics


Syntax

Description

les_sm1\q931parser
interface

Number of packets transmitted/received by the Q931 Parser interface of


the CPIWF. The characteristics and number of invalid packets are
indicated in case of errors (Invalid Frames other than 0).

les_sm1\pcp interface

Number of packets transmitted/received by the PCP interface of the


CPIWF. The characteristics and number of invalid packets are indicated
in case of errors (Invalid Frames other than 0).

les_sm1\pstn interface

Number of packets received with errors by the PSTN interface that were
accepted and discarded.

les_lap1\sssar interface

Number of packets in reception/transmission from the SSSAR interface.


Events on reception/transmission of anomalous packets are recorded.

les_lap1\ssted interface

Number of packets in reception/transmission from the SSTED interface.


Events on reception/transmission of anomalous packets are recorded.

ATOS User Guide


167 / 483

Multicast
Multicast is a protocol for transmitting a single message to multiple selected receivers on the
network. It uses an IP multicast address, a class D adddress which ranges from 224.0.0.0 to
239.255.255.255 or 224.0.0.0/4.
ATOS can process multicast traffic coming from each interface enabled to multicast and replicate it
over all interfaces with multicast on. Once configured in the main node
(ATOS\multicast>>), the multicast parameter must be enabled in each involved interface too.
Each interface belonging to a switch (LAN side) supports the IGMP1 snooping functionality, and it
must be configured on the main node.
IGMP snooping uses a table of dynamic associations; each entry joins one or more switch ports to a
multicast group. Associations are built inspecting all incoming multicast messages. Messages like
membership report and leave group create or remove an association as switch port /
multicast group. Switch port is referred to the switch port the message come from; multicast
group is referred to the multicast IP address written in the packet.
This functionality allows to optimize the received multicast traffic forwarding it to the switch ports
associated to a configured multicast group only. In this way multicast traffic will be direct to hosts
belonging to that group only.
When a multicast association misses, ATOS forwards traffic to all the switch ports.

Multicast Commands
ATOS\multicast>>set ?
Nodes not available.
Set command parameters:
<on|off>
loglevel
<value>
Table 146: set

Syntax

Description

on|off

Enables/disables multicast.

loglevel <value>

Set the detail level used by ATOS to record multicast events.

Internet Group Management Protocol.

ATOS User Guide


168 / 483

Multicast Nodes
IGMP commands
The following commands can be used to configure the general IGMP parameters.
ATOS\Multicast\Igmp>>set ?
Nodes not available.
Set command parameters:
snooping
<on|off>
protocol
<on|off>
version
<value>
proxying
<on|off>
proxying-interface
<ATM_VC0|ATM_VC1|ATM_VC2|ATM_VC3|ATM_VC4|ATM_VC5|ATM_VC6|ATM_VCx>
robustness-variable
<value>
query-interval-time
<value>
query-response-time
<value>
last-member-query-interval <value>
last-member-queries-number <value>
Table 147: set
Syntax

Description

snooping <on|off>

Enables/disables igmp snooping2 option.

protocol <on|off>

Enable/disable IGMP protocol

Version <value>

It sets the IGMP protocol version [1 - 3 ]

proxying <on|off>

Enable/disable IGMP proxying

proxying-interface

It selects the IGMP proxying interface

robustness-variable <value>

It indicats the value of the IGMP robustness variable that provides


fine-tuning to allow for expected packet loss on a subnet. The
minimum value is 2 [2 - 255 ]

query-interval-time <value>

It is the amount of time in seconds between General Queries. It can


be used to limit the number of IGMP messages in the network.
[10 - 1000 sec]

query-response-time <value>

It is the maximum amount of time in seconds that the IGMP router


waits to receive a response to a General Query message. It must be
smaller than query.interval-time.
[1 - 100 sec]

last-member-query-interval
<value>

It is the amount of time in seconds that the IGMP router waits to


receive a response to a Group-Specific Query message. The last
member query interval is also the amount of time in seconds
between successive Group-Specific Query messages.
[1 - 10 sec]

Igmp snooping option makes sense on devices with switch embedded.

ATOS User Guide


169 / 483

last-member-queries-number
<value>

It is the number of Group-Specific Query messages sent before the


router assumes that there are no members of the host group being
queried on this interface.
[1 - 100 ]

ATOS User Guide


NAPT - 170 / 483

NAPT
ATOS supports the NAT (Network Address Translation) and PAT (Port address Translation)
advanced functionality. This allow you to use freely-assigned IP addresses over the local network
and a public address (typically provided by the service provider) over the WAN ports.
Local IP Hosts
10.0.0.2

10.0.0.3

10.0.0.4

NAT Router
10.0.0.1
206.86.223.7

Internet
local 10.0.x.x net

You can use multiple PCs at the same time over the LAN to access external resources (i.e. Internet)
even if you have subscribed only one contract with the service provider.

NAPT Commands
ATOS\napt>>set ?
Nodes available:
proxy
alias
map
Set command parameters:
<on|off>
first port
<value>
last port
<value>
tcptimeout
<value>
udptimeout
<value>
defaultserver
<ip add>
connectedhost
<on|off>
max-hosts
<0-64>
h323-connection <0|1|2|4|8|16>
h323-gatekeeper <on|off>
sip-port-start <0-65535>
sip-port-range <0-65535>
loglevel
<value> [-s]

ATOS User Guide


NAPT - 171 / 483

Table 148: set


Syntax

Description

on|off

Activate/deactivate the NAT and PAT functionality in all WAN


interfaces (default: on).

first port <value>

Set the first port used to translate the native port. [default 49152]

last port <value>

Set the last port used to translate the native port. [default 65535]

tcptimeout <value>

Set the timer used to delete the NAPT association with a remote
host with TCP protocol. The value ranges from 0 to 100 minutes
(default: 100).

udptimeout <value>

Set the timer used to delete the NAPT association with a remote
host with UDP protocol. The value ranges from 0 to 100 seconds
(default: 100).

defaultserver <ip add>

Identify the IP address of a local server as default server in order to


satisfy connection requests from the WAN (default: 0.0.0.0,
disable).

max-hosts <0-64>

It sets the maximum number of hosts that can use NAPT operations.
No limitations exist if the value is 0, default value.

connectedhost <on|off>

Activatesdeactivate the reception of incoming packets with no entry


in the NAPT table (in spite of the connection established between
remote host and device for another service). Default: off.

h323-connection
<0|1|2|4|8|16>

Set the maximum number of H323 outgoing connections permitted


at the same time. Only one incoming connection is permitted for
every public IP. H323 connections are not permitted if the value is
0. No limitations exist if the value is 16. Default value: 0.

h323-gatekeeper <on|off>

Enable/disable H323 calls managed by gatekeepers (default: off).

sip -port-start <0-65535>

Configure the start value for the SIP protocol UDP port range. If
this value is set to zero the SIP ALG doesnt work. [default 5060]

sip-port-range <0-65535>

Configure the width of the SIP protocol UDP port range. [default 0]

loglevel <value> [-s]

Set the detail level used by ATOS to record events for NAPT
operations; s option extends the same log level to all the NAPT
subnodes. [default 1]

In addition to set the number of H323 connections, for INCOMING connections you must add one
or more proxy lists to create the correspondence between port/s (for H323 connection) and hosts
of the local network.
Example of configuration for H323 incoming connection, such as Microsoft NetMeeting:
ATOS\napt\proxy>>add ?
Add command parameters:
<public port value><private ip addr><private port
value><udp|tcp|value>
ATOS\napt\proxy>>add 1720 10.0.0.5 1720 tcp

Session Initiation Protocol.

ATOS User Guide


NAPT - 172 / 483

Example of configuration for H323 incoming connection using a gatekeeper:


ATOS\napt\proxy>>add ?
Add command parameters:
<public port value><private ip addr><private port
value><udp|tcp|value>
ATOS\napt\proxy>>add 1718 10.0.0.5 1718 udp
Command executed
ATOS\napt\proxy>>add 1719 10.0.0.5 1719 udp
Command executed
ATOS\napt\proxy>>add 1720 10.0.0.5 1720 tcp

NAPT Nodes
Proxy
The NAPT node contains a subnode that is used to designate a host in the LAN to reply to service
requests from one of the WAN ports (proxy server).

ATOS\napt\proxy>>add ?
add command parameters:
<public port value><private ip addr><private port value>
<UDP|TCP|value><port range value>
Table 149: add
Syntax

Description

public port value

Number of the public port you want to use2 (0-65535).

private ip address

Private IP address of the host you want to use as proxy


(aa.bb.cc.dd).

private port value

Number of the private port you want to use (0-65535).

UDP|TCP|value

Protocol code assigned to the proxy (UDP,TCP, 0-65535).

ATOS\napt\proxy>>del ?
del command parameters:
<public port value><UDP|TCP|value>

This number becomes the search key of the added proxy.

ATOS User Guide


NAPT - 173 / 483

Table 150: del


Syntax

Description

public port value

Identify the number of the public port assigned to the proxy you
want to delete.

UDP|TCP|value

Protocol code assigned to the proxy (UDP,TCP, 0-65535).

Example: to add a UDP proxy to public port 10, private IP address 192.168.118.70, private port 100
and delete it:

ATOS\napt\proxy>>add 10 192.168.118.70 100 udp


ATOS\napt\proxy>>del 10 udp

Alias
The NAPT node contains the alias subnode that is used to create associations between private IP
addresses (LAN) and public IP addresses. You can designate one or more hosts in the LAN to
answer the service requests from the WAN interfaces. The hosts that are statically associated with
public addresses through alias are no longer subject to NAPT operations. They use the public IP
address both for incoming and outgoing traffic.

206.86.223.8
10.0.0.2

10.0.0.3

206.86.223.7
10.0.0.4

10.0.0.1

Local
IP Hosts

206.86.223.7
206.86.223.8
206.86.223.9

Internet

local 10.0.x.x net

The following configuration commands are available:

ATOS\napt\alias>> add ?
add command parameters:
<alias name><private ip addr|host name><public ip addr>

ATOS User Guide


NAPT - 174 / 483

Table 151: add


Syntax

Description

alias name

Name of the alias to create. The same alias can include more than
one entry. Once configured, the alias must be associated to an
interface (see the example below)..

private ip addr | host name

Private IP address or host name of the device in the LAN for


association to a public address.

public ip addr

Public IP address used to reach the host over the LAN through a
WAN or Loopback interface.

ATOS\napt\alias>> del ?
del command parameters:
<alias name><private ip addr|host name>

Table 152: del


Syntax

Description

alias name

Name of the alias you want to delete.

private ip addr | host name

Private IP address or host name of the device in the LAN to delete


the association to the public address.

Next example shows how to associate a public IP address to a host in the LAN:
ATOS\napt\alias>>add ALIASname 10.0.0.4 206.86.223.7
ATOS\napt\alias>>add ALIASname 10.0.0.7 206.86.223.8
ATOS\napt\alias>>add ALIASname 10.0.0.10 206.86.223.9
Command executed
ATOS000236\Napt\Alias>>add ALIASname 10.0.0.7 206.86.223.8
Command executed
ATOS000236\Napt\Alias>>add ALIASname 10.0.0.10 206.86.223.9
Command executed
ATOS000236\Napt\Alias>>show conf
Show of ATOS000236 Napt Alias
LIST NAME
PRIVATE IP ADDRESS OR NAME
PUBBLIC IP
ADDRESS
ALIASname
ALIASname
ALIASname

10.0.0.10
10.0.0.7
10.0.0.4

Command executed
ATOS\napt\alias>>top
ATOS>>wan1
ATOS\wan1>>ip
ATOS\wan1\ip>>nat
ATOS\wan1\ip\nat>>set ?
Nodes not available.
Set command parameters:

206.86.223.9
206.86.223.8
206.86.223.7

ATOS User Guide


NAPT - 175 / 483

address <ip addr>


alias
<string>
ATOS\wan1\ip\nat>>set alias ALIASname

Map
Starting from ATOS 3.0 version the map node allows to associate a public IP address to a part of s
private network. It means that the traffic generated by local hosts configured in <private net
ip addr> comes to the public network using the <public ip addr> public address.

ATOS\napt\map>>add ?
add command parameters:
<private net ip addr><mask addr|/bits mask><public ip addr>

Table 153: add


Syntax

Description

private net ip addr

IP address of a private network to associate to a public IP address.

mask addr | /bits mask

Netmask of the private network, that can be configurd as dotted


decimal mask or as /bits mask (e.g. the dotted decimal mask
255.255.255.0 in /bits mask format is /24).

public ip addr

Public IP address the private network use in the public network.

The example below shows the association of the first 6 hosts of the private network 10.0.0.0 to the
public IP address 80.70.60.50:
ATOS\napt\map>>add 10.0.0.0 255.255.255.248 80.70.60.50
Command executed
ATOS\napt\map>>show conf
Show of ATOS napt map
public addresses mapping
private net
mask
pubblic address
10.0.0.0
255.255.255.248
80.70.60.50

A map between a private network IP address and a private IP address can be removed typing the
private IP address next to the del command .

ATOS User Guide


NAPT - 176 / 483

ATOS\napt\map>>del ?
del command parameters:
<private net ip addr>

ATOS User Guide


177 / 483

POTS and ISDN interfaces


POTS and ISDN interfaces (for Aethra devices with voice interfaces only) can use VoIP
technology or Voice over ATM technology (LES).
The technology can be selected in the voiceservice node:
ATOS\voiceservice>>set voiceservice ?
Nodes not available.
Set command parameters:
voiceservicetype <les|voip>

Table 154: set voiceservicetype


Syntax

Description

les

Indicate that POTS and ISDN interfaces are used for Voice Over
ATM technology.

voip

Indicate that POTS and ISDN interfaces are used for Voice Over IP
technology.

Once selected les or voip, the respective dynamic node will be created on the root.
Changing configuration from one mode to the other, only the selected node will be displayed.
ATOS\voiceservice>>set voiceservicetype les
You need save and restart.
Continue (y/n)? y
Command executed
Restarting ....

Les Commands
The device can implement multiple interworking requests of loop emulation service type. Each
request corresponds to one cpiwf1n node, where n identifies the request.
Every cpiwf request uses its own VC ATM.
The following commands are available in the node:
add cpiwf
del cpiwfn

Customer Premises Interworking Function.

ATOS User Guide


POTS and ISDN Interfaces - 178 / 483

Table 155: add del cpiwfn


Syntax

Description

add cpiwf

Create a CPIWFn dynamic node, where n is the progressive


creation number. Once you have created the node, the AAL2 and
ATM subnodes are automatically created.

del cpiwfn

Delete the CPIWF number n.

warmrestart
coldrestart

Table 156: warmrestart-coldrestart


Syntax

Description

warmrestart

The device executes the warm restart of all CPIWF. The


modifications made to the configuration are not implemented.

coldrestart

The device executes the cold restart of all CPIWF. The


modifications made to the configuration are implemented.

Its possible, for SHDSL models only, to set the system clock used internally, either adaptive or
derived form SHDSL interface.

ATOS\les>> set sysclock <ntr | adaptive | external>

Table 157: set sysclock


Syntax

Description

ntr

Timing is derived from the ShDSL interface. This clock is supposed


to be synchronous to the network timing.2

adaptive

Timing is derived from the cell rate arrival rate (default).

external

Timing is derived from the Synk IN interface3

Les Nodes
The les4 node is used to access the configuration of analogue and ISDN lines (for Aethra devices
with voice interfaces only).

Available only for ShDSL models

Available only for SV12xx and SV22xx models

Loop Emulation Service.

ATOS User Guide


POTS and ISDN Interfaces - 179 / 483

The node structure is:

les

cpiwfn

aal2
atm
potslinen
isdnlinen

Subnodes can be displyed if a configuration file is loaded in the device (default).

Cpiwfn - Commands
The CPIWFn subnode is used to personalize the POTS and ISDN voice interfaces. The following
direct commands are available:

ATOS\les\cpiwf1>>add ?
add command parameters:
<potsline|isdnline><physical-port value>[string description]

Table 158: add


Syntax

Description

potsline|isdnline

Create an analogue (potsline) or ISDN (isdnline) line, n


is the progressive number of the logic port to be created.

physical-port value

Number of the device physical port (POTS or ISDN) associated to


the logic port to be created. Range: 1-4.

string description

Optional description associated with the line to be created.

ATOS\les\cpiwf1>>add potsline 1
Command executed

ATOS\les\cpiwf1>>del ?
del command parameters:
<potslinen|isdnlinen>
Table 159: del
Syntax

Description

potslinen|isdnlinen

Delete the analogue (potslinen) or ISDN (isdnlinen) line,

ATOS User Guide


POTS and ISDN Interfaces - 180 / 483

n is the progressive number of the logic port.

If you want to delete a POTSLINEx or ISDNLINEx line, it is recommended to delete all


lines first and then recreate them, to ensure the correct association between physical ports
and voice gateway.

ATOS\les\cpiwf1>>set ?
Nodes available:
atm
aal2
potsline1
potsline2
potsline3
potsline4
isdnline1
isdnline2
Set command parameters:
echo-cancellation
protocol
elcp-pstn-bandwidth
max-playout-delay
snmp-trap-generation
impairement-time
impairement-threshold
max-wait-restart
path-collision-priority
eoc-bandwidth
decode
vag

<on|off|auto>
<elcp|voiceband|cas|none>
<value>
<value>
<off|cold-start|on>
<value>
<value>
<value>
<incoming|outgoing>
<value>
<disable|lev2-lev3|lev2-lev3-hex|lev3|
lev3-hex|lev3-elcp|lev3-elcp-hex|
lev3-pstn|lev3-pstn-hex|lev2|lev2-hex>
<generic|tdsoft|zhone|paradyne|alcatel>

Table 160: set

Syntax

Description

echo-cancellation
<on|off|auto>

Activate/deactivate the echo cancellation for all CPIFW lines. On


and auto modes is aware of echo cancellation configuration on
each port. Off mode ignores echo cancellation configuration on
each port.

protocol
<elcp|voiceband|cas|none>

Select the protocol

Emulated Loop Control Protocol

1. elcp5,with dynamic CIDs;

ATOS User Guide


POTS and ISDN Interfaces - 181 / 483

2. voiceband, that must be enabled with Paradyne Voice


Gateway only;
3. cas6;
or disable (none) the CID dynamic association expected in ELCP
protocol.
elcp-pstn-bandwidth
<value>

Set the maximum band of the AAL2 connection with CID=8 used
to transport ELCP and PSTN messages. Range: 0-128000, default:
64000.

max-playout-delay <value>

Set the maximum playout delay of the contents of the VCC AAL2
channel cells towards the user terminal. Range: 0-200, default: 20
mSec.

snmp-trap-generation
<off|cold-start|on>

Deactivate/activate the generation of TRAP by the CPIWF (default:


on):
4. off : all TRAP not enabled;
5. cold-start : cold start TRAP only;
6. on : all TRAP enabled.

impairement-time <value>

Time interval, in minutes, for impaired octets calculation. Range: 0720, default: 15.

impairement-threshold
<value>

Set the threshold value of impaired bytes counted in the


impairement-time interval. If the threshold is exceeded, the
CPIWF sends the TRAP to the CO-IWF. Range: 0 - 4294967295,
default: 0=disabled.

max-wait-restart <value>

Configure the maximum time,in seconds, used to send the TRAP


during the cold startRange: 0 - 4294967295, default: 600 sec.

path-collision-priority
<incoming|outgoing>

Set the priority between incoming and outgoing call in case of


simultaneous events (default: incoming).

eoc-bandwidth <value>

Set the maximum band of the eoc signaling. Range: 300-64000,


default: 32000.

decode
<disable|lev2-lev3|lev2lev3-hex|lev3|lev3-hex|
lev3-elcp|lev3-elcp-hex|
lev3-pstn|lev3-pstn-hex|
lev2|lev2-hex>

Set the trace level and mode of transmitted and received frames
(protocol monitor) at LES level for the CPIWF (default: disable). If
you select trace with any level/mode, you must give the log
console command to start visualization on screen.

vag
<generic|tdsoft|zhone|parad
yne|alcatel>

Select the parameter


7. generic (default), that enables the device to Voice Gateway
connections that use standard protocols;
8. tdsoft, that enables the device to TDSOFT Voice Gateway
connections using nonstandard protocols;
9. zhone, that enables the device to Zhone Voice Gateway
connections using nonstandard protocols;
10. paradyne, that enables the device to Paradyne Voice Gateway
connections using nonstandard protocols;
11. alcatel, that enables the device to Alcatel Voice Gateway
connections using nonstandard protocols.

Channel Associated Signaling.

ATOS User Guide


POTS and ISDN Interfaces - 182 / 483

Cpiwfn Nodes
ATOS\les\cpiwf1>>?
Nodes available:
atm
aal2

Aal2 Commands
The following commands are available in the AAL2 node at LES level:
ATOS\les\cpiwf1\aal2>>set ?
Nodes not available.
Set command parameters:
cps-max-sdu
cps-cu-timer
cps-optimisation
pcm-encoding
sssar-max-assembly-time
profile-identifier

atm-user-to-user

<45|64>
<value>
<on|off>
<alaw|ulaw>
<value>
<1
2
3
4
5
6
7
8

(ITU
(ITU
(ATM
(ATM
(ATM
(ATM
(ATM
(ATM

Prof1: PCM-64, 40 octets, no silence)|


Prof2: PCM-64, 40 octets, silence)|
Prof7: PCM-64, ADPCM-32, 44 octets, silence)|
Prof8: PCM-64, 44 octets, silence)|
Prof9: PCM-64, 44 octets, no silence)|
Prof10: PCM-64, ADPCM-32, 44 octets, no silence)|
Prof11: PCM-64, ADPCM-32, 40 octets, no silence)|
Prof12: PCM-64, ADPCM-32, 40 octets, silence)>

<0|1>

Table 161: set cps-max-sdu.


Syntax

Description

cps-max-sdu <45|64>

Set the maximum number of octets of the CPS-SDU transported


over the AAL2 channel of the ATM (VCC) connection (default:
45). If you set the CID value, the octet value is applied to the
CID.

cps-cu-timer <value>

Time, in milliseconds, before sending the CPS-PDU even if it is not


full. The time is considered only if cps-optimisation is off.
Range: 0-4294967295, default: 0.

cps-optimisation <on|off>

Set the mode used to contain the CPS packets in the CPS-PDU in
transmission (default: on):
12. on : the CPS-PDU is sent as individual CPS-packet, regardless
of the number of octets;
13. off : the CPS-PDU is sent by aggregating multiple CPS-

ATOS User Guide


POTS and ISDN Interfaces - 183 / 483

packets up to the maximum number of permitted octets.


pcm-encoding <alaw|ulaw>

Set the type of PCM coding, default: a-law.

sssar-max-assembly-time
<value>

Maximum time, in milliseconds, waited to reassemble the entire


SSAR-SDU (I.366.1 SAR ). Range: 0-4294967295, default:
2147483647.

profile-identifier
<1 (ITU Prof1: PCM-64, 40
octets, no silence)|

Set the default profile used by all lines configured in the CPIWF;
default: 5, range: 1-8. Profile correspondences are shown below:

2 (ITU Prof2: PCM-64, 40


octets, silence)|
3 (ATM Prof7: PCM-64,
ADPCM-32, 44 octets,
silence)|
4 (ATM Prof8: PCM-64, 44
octets, silence)|
5 (ATM Prof9: PCM-64, 44
octets, no silence)|

ITU Prof.1: PCM-64, 40 octet packets, without silence;


ITU Prof.2: PCM-64, 40 octet packets, with silence;
ATM Prof.7: PCM-64, ADPCM-32, 44 octet packets, silence;
ATM Prof.8: PCM-64, 44 octet packets, silence;
ATM Prof.9: PCM-64, 44 octet packets, without silence;
ATM Prof.10: PCM-64, ADPCM-32, 44 octet packets, without
silence;
ATM Prof.11: PCM-64, ADPCM-32, 40 octet packets, without
silence;
ATM Prof.12: PCM-64, ADPCM-32, 44 octet packets, with
silence.

6 (ATM Prof10: PCM-64,


ADPCM-32, 44 octets, no
silence)|
7 (ATM Prof11: PCM-64,
ADPCM-32, 40 octets, no
silence)|
8 (ATM Prof12: PCM-64,
ADPCM-32, 40 octets,
silence)>
atm-user-to-user <0|1>

Set the UUI7 bit value present in the ATM PTI field transmitted,
default 0.

The configuration of this parameter must be consistent with the configuration set in the
VAG. While receiving data the device does not consider the configuration and accepts
both modes.

Atm Commands
The ATOS\les\cpiwf1\atm>> node contains the commands used for the configuration of the
ATM parameters for the CPIWF.

User to User Information.

ATOS User Guide


POTS and ISDN Interfaces - 184 / 483

ATOS\les\cpiwf1\atm>>set ?
Nodes not available.
Set command parameters:
vpi
<value>
vci
<value>
traffic-type <cbr|vbr-rt|vbr-nrt>
pcr
<value>
scr
<value>
mbs
<value>

Table 162: set


Syntax

Description

vpi <value>

Assign the VPI value for the VCC AAL2. Range: 0-255.

vci <value>

Assign the VCI values for the VCC AAL2. Range: 32-65535.

traffic type

The traffic-type parameter indicates the shaping applied to


the outgoing ATM traffic; default value is vbr-rt.

<cbr8|vbr-rt9|vbr-nrt10>

14. if you select cbr, you must specify the Peak Cell Rate value
(atmpcr range: 0-MaxPhysSpeed);
15. if you select vbr-rt or vbr-ntr you must specify the Peak Cell
Rate (atmpcr), Sustainable Cell Rate (atmscr range: 0-atmpcr)
and Maximum Burst Size (atmmbs range: 0-65535) values.
pcr11 <value>

Using cbr traffic-shape, the pcr value must be configured (range:


0 - MaxPhysSpeed).

scr12 <value>

Using vbr-rt or vbr-nrt traffic-shape, pcr, scr(range: 0pcr) and mbs (range: 0-pcr) values must be configured.

mbs13 <value>

Using vbr-rt or vbr-nrt traffic-shape, pcr, scr(range: 0pcr) and mbs (range: 0-pcr) values must be configured.

Potslinen / Isdnlinen Nodes


Every time you add a POTS or ISDN line, the corresponding potslinen or isdnlinen node is
dynamically created.
The following commands are available in the nodes:
8

Constant Bit Rate.

Variable Bit Rate - Real Time.

10

Variable Bit Rate - Non-Real Time.

11

Peak Cell Rate.

12

Sustainable Bit Rate.

13

Maximum Burst Size.

ATOS User Guide


POTS and ISDN Interfaces - 185 / 483

ATOS\les\cpiwfn\potslinen>>set ?
Nodes not available.
Set command parameters:
description
<string>
emergency-operational <on|off>
echo-cancellation
<on|off|auto>
profile-identifier
<1 (itu prof1: pcm-64,
2
3
4
5
6
7
8

tx-loop-gain
rx-loop-gain
tax-enable

(itu
(atm
(atm
(atm
(atm
(atm
(atm

40 octets, no silence)|
prof2: pcm-64, 40 octets, silence)|
prof7: pcm-64, adpcm-32, 44 octets, silence)|
prof8: pcm-64, 44 octets, silence)|
prof9: pcm-64, 44 octets, no silence)|
prof10: pcm-64, adpcm-32, 44 octets, no silence)|
prof11: pcm-64, adpcm-32, 40 octets, no silence)|
prof12: pcm-64, adpcm-32, 40 octets, silence)>

<value>
<value>
<on|off>

ATOS\les\cpiwfn\isdnlinen>>set ?
Nodes not available.
Set command parameters:
description
emergency-operational
echo-cancellation
permanent-line
profile-identifier

tax-enable

<string>
<on|off>
<on|off|auto>
<on|off>
<1
2
3
4
5
6
7
8

(ITU
(ITU
(ATM
(ATM
(ATM
(ATM
(ATM
(ATM

Prof1: PCM-64, 40 octets, no silence)|


Prof2: PCM-64, 40 octets, silence)|
Prof7: PCM-64, ADPCM-32, 44 octets, silence)|
Prof8: PCM-64, 44 octets, silence)|
Prof9: PCM-64, 44 octets, no silence)|
Prof10: PCM-64, ADPCM-32, 44 octets, no silence)|
Prof11: PCM-64, ADPCM-32, 40 octets, no silence)|
Prof12: PCM-64, ADPCM-32, 40 octets, silence)>

<on|off>

Table 163: set


Syntax

Description

description <string>

Set the description string associated with the line you have created
with:
add <potsline|isdnline><physical-port
value>[string description]

emergency-operational
<on|off>

Activate/deactivate the line for emergency operation. Default: off.

echo-cancellation
<on|off|auto>

Selecting
16. on|off echo cancellation over the potslinen line is
permanently activated/deactivated;
17. auto echo cancellation is dynamically disabled in case of
analog fax/modem connection or Unrestricted Digital 64K
ISDN calls.

ATOS User Guide


POTS and ISDN Interfaces - 186 / 483

permanent-line <on|off>14

Configure level 1 ISDN; selecting


18. on the level 1 is maintained active by the Aethra device in
permanent mode without ISDN traffic too;
19. off the activation of level 1 ISDN is related to the TE request
or signaling from CO-IWF.

profile-identifier
<1 (itu prof1: pcm-64, 40
octets, no silence)|
2 (itu prof2: pcm-64, 40
octets, silence)|
3 (atm prof7: pcm-64,
adpcm-32, 44 octets,
silence)|
4 (atm prof8: pcm-64, 44
octets, silence)|
5 (atm prof9: pcm-64, 44
octets, no silence)|

Set the profile used by the port; default: 5, range: 1-8.


Profile correspondences are shown below:
1.

ITU Prof.1: PCM-64, 40 octet packets, without silence;

2.

ITU Prof.2: PCM-64, 40 octet packets, with silence;

3.

ATM Prof.7: PCM-64, ADPCM-32, 44 octet packets,


silence;

4.

ATM Prof.8: PCM-64, 44 octet packets, silence;

5.

ATM Prof.9: PCM-64, 44 octet packets, without silence;

6.

ATM Prof.10: PCM-64, ADPCM-32, 44 octet packets,


without silence;

7.

ATM Prof.11: PCM-64, ADPCM-32, 40 octet packets,


without silence;

8.

ATM Prof.12: PCM-64, ADPCM-32, 44 octet packets,


with silence.

6 (atm prof10: pcm-64,


adpcm-32, 44 octets, no
silence)|
7 (atm prof11: pcm-64,
adpcm-32, 40 octets, no
silence)|
8 (atm prof12: pcm-64,
adpcm-32, 40 octets,
silence)>
tx-loop-gain <value>15

Set the TX audio level to digital channel. The max recommended


level is 0 dBr. Range: 12 - +4 dBr, default: 4 dBr.

rx-loop-gain <value>

Set the RX audio level from digital channel. The max recommended
level is -7 dBr. Range: 12 - +4 dBr, default : 11 dBr.

tax-enable <on|off>

Enable/disable the metering pulses forwarding on the selected


POTS/ISDN port. The effective service operation is dependant on a
metering pulse management activation by the telephone service
provider. Default value: off.

POTS and ISDN terminals with data traffic, such as facsimiles, modems, and
videoconference devices, operate correctly if the echo cancellation function is not active.
In case of terminals with voice traffic, the activation of the echo cancellation function
improves the quality of communication.

14

Command available in isdnlinen node only.

15

Command available in potslinen node only.

ATOS User Guide


POTS and ISDN Interfaces - 187 / 483

In case of POTS lines the diagnostic command is used to:


show, with port in idle state, the line capacity measurement and send a ring to the connected
devices. The result 0 nF indicates that no devices are connected to the port;
show, with port in busy state, the message informing that the line is in use.
ATOS\les\cpiwf1\potsline1>>diagnostic
Measured capacity (nf) = 2000
Command executed

Voip Commands
VoIP mode allows to configure analogic and ISDN lines in voip node.
The CLI structure is the following:

ATOS\voip>>set ?
Nodes available:

potsparameters
fax
rings
tones
timers
sip
potsline1 ... potsline4
isdnline1 ... isdnline4
bundlename

Set command parameters:


sysclock
<ntr|adaptive|external|free-running>
softswitch
<generic|cirpack|italtel|netcentrex|cisco|
cirpack_ddi|ericsson>
local-ipaddress <ip addr>
accesslistname <None|acl1|acl2>
automatic-advanced-route-enable <off|on>
message-waiting-indication-enable
<off|not-subscription|
subscription>
interface-name <string>
loglevel
<value>

ATOS User Guide


POTS and ISDN Interfaces - 188 / 483

Table 164: set


Syntax

Description

sysclock

Clock setting

<ntr|adaptive|external|freerunning>

20. ntr means that timing is derived from the ShDSL


interface. This clock is supposed to be synchronous to the
network timing.16
21. adaptive means that timing is derived and recalculated
according to the IP packets receiving rate from the line;
22. external means that timing is derived from the Synk
IN interface
23. free-running means that the clock is derived from the
internal clock (default).

softswitch

Selecting the parameter

<generic|cirpack|italtel|netcen
trex|cisco|cirpack_ddi|ericsson
>

24. generic, the device is enable to connections with


softswitch that dont use proprietary signal (default);
25. cirpack, the device is enabled to connections with
Cirpack softswitch;
26. italtel, the device is enabled to connections with Italtel
softswitch;
27. netcentrx, the device is enabled to connections with
Netcentrx softswitch;
28. cisco the device is enabled to connections with Cisco
softswitch;
29. cirpack_ddi, the device is enabled to connections
with Cirpack softswitch when a DDIBundle is used. In this
case, the To number for incoming INVITE is used as
destination call.
30. Ericsson, the device uses the DNS proxy name instead of
the relevant IP address in the Register startline message
Indicates the interface (LANx,ATM_VCx,) used for VoIP
packets (max 16 characters).

interface-name <string>
Local-ipaddress <ip address>

Configure the Ip address used as source for outgoing packets


and to receive incoming packets. It also used for the
CONTACT, FROM and TO field for SIP messages.
The IP address must be present on one of the interface
available, created before (i.e. loopback). After assigning the
new IP Address, a restart is needed.
If this parameter is set to 0.0.0.0 means that source for
outgoing packets and to receive incoming packets will be the
Ip Address assigned to LANx,ATM_VCx, set in the above
interface-name. [default: 0.0.0.0]

Accesslistname

Set the accesslistname to apply to VOIP service

automatic-advanced-route-enable

Enable/disable the creation of the automatic advanced route


for the embedded voice interface [default: on]

<on|off>

16

Available only for ShDSL models

ATOS User Guide


POTS and ISDN Interfaces - 189 / 483

message-waiting-indicationenable
<off|not-subscription|

Enable/disable the MWI feature, to receive the special tone


when messages are present in the Centralized Message
Waiting Service.

subscription >

not-subscription: the service is active without any subsciption


procedure
subscription: the service is active with a subsciption procedure
[default: off]

loglevel <value>

Set the detail level used by ATOS to log the events of the
VoIP, from the less detailed one (0) to the more detailed one
(5). Adding the [ - s ] option, this command will be extended
to all voip subnodes. [default: 1]

ATOS\voip>>add ?
add command parameters:
<POTSLINE|ISDNLINE|DDIBUNDLE><physical-port value|bundle name (max.30
char)>
ex: add potsline 2
ex: add ddibundle bundlename17
Table 165: add
Syntax

Description

potsline|isdnline

Add POTS (potslinen) or an ISDN (isdnlinen) line; n


indicates the number of the port.

physical-port value

Indicate the physical port number (POTS or ISDN) that will be


associated to the ports previously created. Admitted values: 1-4.

Ddibundle <string>

Add a DDI bundle where it is possible to associate POTS


(potslinen) or ISDN (isdnlinen) line to a telephone number
or to a range of numbers. The new node bundlename is
automaticaly created

ATOS\voip>>add potsline 1
Command executed

ATOS\voip>>del ?
del command parameters:
<POTSLINES|POTSLINE1|..|ISDNLINES|...ISDNLINEn|BUNDLENAME>
Table 166: del

17

Syntax

Description

Potslines|potslinen

remove all POTS (potslines) or an ISDN (isdnlines) line,


remove POTS (potslinen) or an ISDN (isdnlinen) line n

To configure a ddibundle see paragraph DDIBundle Commands

ATOS User Guide


POTS and ISDN Interfaces - 190 / 483

Isdnlines|isdnlinen

indicates the number of the port.

BUNDLENAME

Remove the bundlename DDI-Bundle

ATOS\voip>>register ?
register command parameters:
<PORTS|BUNDLES|ALL|STOP>
ATOS\voip>>unregister ?
unregister command parameters:
<PORTS|BUNDLES|ALL|STOP>

Table 167: register unregister


Syntax

Description

Register
<PORTS|BUNDLES|ALL|STOP>

Force the registration for the selected PORTS (potsline1,


isdnline1, etc.), for the selected BUNDLES or for ALL ports,
DDIBundle included.
If STOP is selected, all registration request will be stopped
within 32 seconds

Unregister
<PORTS|BUNDLES|ALL|STOP>

Force the unregistration for the selected PORTS (potsline1,


isdnline1, etc.), for the selected BUNDLES or for ALL ports,
DDIBundle included
If STOP is selected, all unregistration request will be stopped
within 32 seconds

Next an example for parameters in show conf command:


ATOS\voip>>show conf
Show of ATOS voip
Level of log
: 1
Clock Tracking : off
Softswitch
: generic
Interface name : ATM_VC0
LIST OF AVAILABLE INTERFACES
LAN0
ATM_VC0
ATM_VC1
ATM_VC2
ATM_VC3
ATM_VC4
ATM_VC5
ATM_VC6
ATM_VC7
loopbk0

and an example of parameters in show status -s command, with shows parameters of all the
configured ports (POTS and ISDN) and the IP address of the proxy that manages SIP protocol:

ATOS User Guide


POTS and ISDN Interfaces - 191 / 483

ATOS\voip>>show status -s
SIP STATUS:
Proxy
Address = 199.199.199.199
ATM_VC0
- status = up
POTSLINE1 STATUS:
---------------------------------AB port - FSM state = IDLE
Descrittore chiamata 0
Stato
= IDLE
call id
= 255
Descrittore chiamata 1
Stato
= IDLE
call id
= 255
IWFPort - status = REGISTERED
IWF
- status = REGISTERED, rtpport = 5004
call1
- status = IDLE
call2
- status = IDLE
Port1 status: IDLE
more...[y][n]?ATM_VC0
- status = up
AB port - FSM state = IDLE
Descrittore chiamata 0
Stato
= IDLE
call id
= 255
Descrittore chiamata 1
Stato
= IDLE
call id
= 255
IWFPort - status = REGISTERED
IWF
- status = REGISTERED, rtpport = 5008
call1
- status = IDLE
call2
- status = IDLE
Port2 status: IDLE
Command executed

Table 168: sip status


Syntax

Description

proxy address =
199.199.199.199

IP address of the proxy , obtained from a DNS or already


configured on SIP node using set proxy address command.

Table 169: potsline1 status


Syntax

Description

atm_vc0 - status

Conneciton status for the interface selected for VoIP service:


31. up = active;
32. down = disactive.

ab port - fsm state

Selected POTS port status:


33. idle = non-active status;

ATOS User Guide


POTS and ISDN Interfaces - 192 / 483

34. off_hook = engaged port;


35. incoming = incoming call;
36. selecting = outgoing call, selecting phase;
37. search_ss_req = searching for match of keypad string (used in
supplementary service);
38. call_in_progress = call status between the receiving of progress
183 and 200OK with audio channel (early media) opened;
39. active = call in active phase;
40. held_selecting = outgoing call in selecting status with another
call in held status;
41. held_call_in_progress = outgoing call in process with another
call in held status;
42. active_held = second active call with another call in held status;
43. active_call_waiting = call waiting reception with a call in active
status;
44. wait_on_hook = chiamata disconnected call waiting for hang up;
45. reminder = ring noification for waiting call;
46. disconnected_2nd_call = disconnection for an active call with
another in hold status.
First call

State machine of POTS port (first call) .

Status = IDLE
Call id = 255
Second call

State machine of POTS port (second call) .

Status = IDLE
Call id = 255
IWFPort - status =
REGISTERED

Registration status of POTS port

IWF - status = REGISTERED,


rtpport = 5004

State machine of POTS-SIP interworking.

call1

- status = IDLE

State machine of SIP protocol.

call2

- status = IDLE

Port1 status: IDLE

The show status command from POTSLINEn or ISDNLINEn node shows the information
of the examined interface while the same command from the SIP node shows the status of
the proxy.

ATOS User Guide


POTS and ISDN Interfaces - 193 / 483

Voip Nodes
In VoIP18 mode analogic and ISDN lines can be configured by the voip node.
Next the node structure::
voip

potsparameters
fax
rings
tones
timers
sip
potslinen

codec
callfeatures
codec
callfeatures

isdnlinen
bundlename

Potsparameters Show configuration


In the potsparameters subnode it is possible to examine all configuration parameters
concerning POTS voice interface customization and used by the phone service provider.
ATOS\voip\potsparameters>>show conf
Show of ATOS voip potsparameters
caller id type
:
caller id delay
:
dtmf relay
:
hook flash time
:
debounce on-off time
:
debounce off-on time
:
accept waiting hold active call code
:
reject waiting keep active call code
:
accept waiting drop active call code
:
disconnect held call code
:
drop active retrieve held call code
:
swap from active to held call code
:
call transf with consultation act code
:
call transf without consultation act code :
call forward always act code
:
call forward always deact code
:
call forward busy act code
:
call forward busy deact code
:
call forward no answer act code
:
call forward no answer deact code
:
calling line restriction code
:
internal call code
:
Drop first added in 3-party-conference Code:
Drop last added in 3-party-conference Code :
18

Voice over IP.

dtmf
500
off
200
150
200
r2
r0
r1
r0
r1
r2

R1
R2

ATOS User Guide


POTS and ISDN Interfaces - 194 / 483

Hold first added in 3-party-conference Code: R5


Hold last added in 3-party-conference Code : R6
3-party-conference Request Code
: R3

In the following table the meaning of parameters that appear in the potsparameters node,
selected by the phone service provider:
Table 170: potsparameters

19

Syntax

Description

caller id type
<fsk-v23|fsk-bell202|dtmf>

Protocol used to send CLIP19.

caller id delay

Delay time between the end of the first ring and the starting CLIP
signal generation.

hook flash time

Recall/flash recognition time.

debounce on/off time

Minimum time for off hook status recognition.

debounce off/on time

Minimum time for on hook status recognition, starting from an


active status.

Call Waiting Codes

User procedure

accept waiting hold active


call code [R2]

Press R2 to place the call on hold and accept the waiting call.

reject waiting keep active


call code [R0]

Press R0 to release the waiting call.

accept waiting drop active


call code [R1]

Press R1 to release the active call and accept the wainting call.

One active and one held call codes

User procedure

disconnect held call code


[R0]

Press R0 to clear the held call.

drop active retrieve held


call code [R1]

Press R1 to clear the active call and retrieve the held call.

swap from active to held


call code [R2]

Press R2 to place the active call on hold and retrieve the held call
(alternate call).

call transf with


consultation act code
call transf without
consultation act code
call forward always act
code

Service not yet implemented.

call forward always deact


code

Code to deactivate an unconditional call transfer.

call forward busy act code

Starting code to make a call transfer on busy. It must be followed


by the telephone destination number, than by #.

call forward busy deact


code

Code to deactivate a call transfer on busy.

Calling Line Identification Presentation.

Service not yet implemented.


Starting code for an unconditional call transfer. It must be followed
by the telephone destination number, than by #.

ATOS User Guide


POTS and ISDN Interfaces - 195 / 483

call forward no answer act


code

Starting code to activate a call transfer on no answer. It must be


followed by the telephone destination number, than by #.

call forward no answer


deact code

Code to deactivete a call tranfer on no answer.

Calling line restriction code


CLIR on Call Basis Code

Starting code that allows the calling user to restricit his identity to
the called party. It must be followed by the telephone destination
number, than by #.

CLIR Permanent Act Code

Allow the calling user to restricit his identity to the called party for
all outgoing calls.

CLIR Permanent Deact Code

Deactivate CLIR service.

CLIR Permanent Query Code

CLIR status interrogation.

internal call code

Service not yet implemented.

Rings Show configuration


In the following table the meaning of parameters that appear in the ring subnode, selected by the
phone service provider:
Table 171: rings
Syntax

Description

normal ring <string>


[max 4 on-off sequences]
(msec)

Ring pattern for normal calls.

remainder ring <string>


[max 4 on-off sequences]
(msec)

Ring pattern to notify a call waiting or a call hold.

internal ring <string>


[max 4 on-off sequences]
(msec)

Service not yet implemented.

Tones Show configuration


In the following table the meaning of parameters that appear in the tones subnode, selected by
the phone service provider:
Table 172: tones
Syntax

Description

dial tone <string>

Pattern, frequency and level used for the dial tone.

ATOS User Guide


POTS and ISDN Interfaces - 196 / 483

[max 4 on-off sequences,


frequency, level]
busy tone <string>
[max 4 on-off sequences,
frequency, level]

Pattern, frequency and level used for busy tone.

ringback tone <string>


[max 4 on-off sequences,
frequency, level]

Pattern, frequency and level used for ringback tone.

call waiting tone <string>


[max 4 on-off sequences,
frequency, level]

Pattern, frequency and level used for call waiting tone.

disconnect tone <string>


[max 4 on-off sequences,
frequency, level]

Pattern, frequency and level used for disconnect tone.

Timers Show configuration


In the following table the meaning of parameters that appear in the timers subnode, selected by
the phone service provider:
Table 173: timers
Syntax

Description

interdigit timer <value>


(sec)

Interdigit time after that the Invite message is sent even if #


key is not pressed (effective only if the typed digits are 2).

delayed clearing timer


<value> (sec)

Delay time for delayed clearing service. After this time, if the port
remains in on hook state, the call is disconnected. Available for
incoming calls only.

alert timer <value> (sec)

Ringing timer for incoming calls.

ringback timer <value>


(sec)

Ringback timer received for outgoing calls that received a 180


RINGING message from the remote user.

Fax - Commands
The available commands in the fax node at VoIP level are:
ATOS\voip\fax>>set ?
Nodes not available.
Set command parameters:
loglevel
<value>
t38enable
<on|off>
t38port
<value>
t38protocol
<udptl>

ATOS User Guide


POTS and ISDN Interfaces - 197 / 483

t38maxbitrate
<2400|4800|7200|9600|14400>
t38ratemanagement <localTCF|transferredTCF|both>
t38errorcorrection <on|off>
t38maxbuffer
<value>
t38maxdatagram
<value>
t38packettime
<value>
t38oldasn98
<on|off>
fax-ecm-disable
<on|off>
fax-voice-band-mode <on|off>
Table 174: set
Syntax

Description

t38enable <on|off>

Enable/disable the T38 protocol used for fax devices on VoIP


technology. [default off]

t38port <value>

Assign the port number to use for the T38 protocol. Range: 060000, default: 0.

t38protocol <udptl>

Protocol used for T.38 signaling (fix to UDPTL)

t38maxbitrate
<2400|4800|7200|9600|14400>

Set the max speed used for the fax connection when T.38
signaling is used. Default 14400

t38ratemanagement
<localTCF|transferredTCF|both>

Specify the Training check failure frame management:


47. localTCF: the frame is localy genetated by DSP
48. transferedTCF: the frame is reveived by the remote side
(default)
49. both: is used in the handshake phase. The answering entity
will decide wich TCF management to be used

t38errorcorrection <on|off>

Enable/disable the ECM protocol of the T.38 signaling. [default


off]

t38maxbuffer <value>

Set the max buffer size used for the T.38 signaling. [default
524]

t38maxdatagram <value>

Set the max datagram size used for the T.38 signaling [default
176]

t38packettime <value>

Set the duration in ms of each T.38 packet. Default 40 ms

t38oldasn98 <on|off>

Enable/disable the ASN.1 notation. Default on

fax-ecm-disable <on|off>

Enable/disable the fax ECM protocol. Default on

fax-voice-band-mode <on|off>

If T38enable is off and the fallback to G.711 is possible, there


are two kind of methods to use G.711 when a fax is recognised.
If the fax-voice-band-mode parameter is off, a G.711 re-invite
messages is used to notify that a fax tone has been recognised
and codec changed is needed.
If the fax-voice-band-mode parameter is on, the codec
automatically changes to G.711 when a fax tone is recognised
(without re-invite). [default off]

loglevel <value>

Set the detail level used by ATOS to log the events of the fax
node, from the less detailed one (0) to the more detailed one (5).
Default value: 1.

ATOS User Guide


POTS and ISDN Interfaces - 198 / 483

Sip - Commands
The available commands in the sip node at VoIP level are the following:

ATOS\voip\sip>>set ?
Nodes not available.
Set command parameters:
loglevel
localsipport
rtplocalport
sipdomain
transportprotocol
proxyaddress
proxyport
expiretime
expiretimepercentage
enable-prack
dtmfrelay
rfc2833-payload-type
response-183-enable
registration-retry-timer
trunking-mode

<value>
<value>
<value>
<string>
<udp>
<string>
<value>
<value>
<value>
<off|supported|required>
<off|rfc2833|info>
<value>
<on|off>
<value>
<off|on>

Table 175: set localsipport


Syntax

Description

localsipport <value>

Assign the local port number to use for SIP protocol. Range: 060000; default 5060.

rtplocalport <value>

Assign the local port number to use for RTP protocol. Range: 500059999; default 5004.

sipdomain <string>

Configure the SIP domain name used [max 129 char]. [default:
empty]

transportprotocol <udp>

Assign a protocol used to transport the SIP (in current version UDP
availble only).

poxyaddress <string>

Assign the IP address or the name resolved by the DNS of the SIP
proxy server [max 129 char]. [default: empty]

proxyport <value>

Assign the port used by SIP proxy server. Range: 0-60000; default:
5060.

expiretime <value>

Configure, in seconds, the time after that registration to the SIP


proxy server expires. Range: 0-3600 sec; default: 60.

expiretimepercentage <value>

It is the percentage of the expiretime value after wich a registration


refresh is sent to the REGISTRAR entity. [default: 70]

enable-prack
<off|supported|required>

50. off: PRACK messages are not sent in the SIP signaling
(default);

ATOS User Guide


POTS and ISDN Interfaces - 199 / 483

51. supported: in the INVITE messages, support for provisional


reliable is declared;
52. required: in the INVITE messages, support for provisional
reliable is requested to the remote peer.
dtmf relay
<off|rfc2833|info>

53. off: DTMF tones transparent transport in bandwidth (default).


54. rfc2833: DTMF20 tones transport with signal agreeing with
RFC2833;
55. info: DTMF are sent as info messages into the SIP signaling.

rfc2833-payload-type
<value>

Set the payload type value for DTMF transport when RFC2833
method is used. This value shall be different from other payload
type value used by other services (e.g. RFC4040 payload type).
(Default 101)

response-183-enable
<on|off>

Setting this parameter on, for incoming calls, when the ISDN port
receives from the TE a CALL PROCEEDING o PROGRESS
message containing a Porgress Indicator=1 or Progress
Indicator=8, the IAD will send a 183 Progress SIP message to the
proxy with the appropriate SDP and connects the ISDN B channel
to the RTP media.
If this parameter is set to off (default), all compatible incoming
calls will be answered using a 180 Ringing SIP message to notify
that the call is in ALERT state.

CALL PROCEEDING o PROGRESS dal terminale/PBX:


Se il messaggio contiene un PI=1 o PI=8 si risponde 183 Progress
con opportuno SDP e si connette il canale B al media RTP
registration-retry-timer
<value>

Set the timer for a new registration retry when a registration failure
occurs. [default: 600]

trunking-mode
<on|off>

Enable/disable the possibility to work without


registration/authentication to a Register entity.
Off (default), the registration SIP method will be used
On , the device assumes that it is always registered. The username
parameter must be used to configure the account number. No any
other parameters are necessary, such as authenticatio-user-id,
authentication-password. Register/unregister command must be
used after/before to change VOIP parameters (e.g. proxy address,
username, etc.).

loglevel <value>

Set the detail level used by ATOS to log the events of the sip
node, from the less detailed one (0) to the more detailed one (5).
Default value: 1.

Tracesip <on|off> command, available in any node, enables/disables an output monitor of


SIP protocol messages. Its reccomended to enable it only for a troubleshooting session and to
disable it after the debug.

20

Dual Tone MultiFrequency.

ATOS User Guide


POTS and ISDN Interfaces - 200 / 483

Potslinen Commands
Any time you add POTS line under VoIP node, a potslinen node is dinamically created.
In this node the following commands are available:

ATOS\voip\potsline1>>set ?
Nodes available:
codec
callfeatures
Set command parameters:
tax-enable
<on|off>
username
<string>
display-name
<string>
authentication-user-id <string>
authentication-password <string>
force-display-as-identity <off|on>
msn-type <username-registration|all-msn-registration|
all-msn-own-auth-id>
jitter-buffer
<value>
voice-activity-detector <off|on>
echo-cancellation
<on|off|auto>
tx-loop-gain
<value>
rx-loop-gain
<value>
caller-id-presentation <off|on-hook|off-hook|both>
reminder-ringing
<off|on>
delayed-clearing
<off|on>
call-enable
<both|in|out>
description
<string>
loglevel
<value>

Table 176: set


Syntax

Description

tax-enable <on|off>

Enable/disable the metering pulses forwarding to the selected POTS


port. The effective service operation is dependant on a metering
pulse management activation by the telephone service provider.
Default value: off.

username <string>

Assign the username used by the SIP protocol to identify the POTS
port selected (usually the telephone number assigned) [max 32
char].

display-name <string>

Assign the string sent to the called user, present in the


INVITEmessage, Display Name field [max 32 char].

ATOS User Guide


POTS and ISDN Interfaces - 201 / 483

authentication-user-id
<string>

Assign the username of the account of the POTS port used for the
SIP proxy server registration [max 32 char].

authentication-password
<string>

Assign the password of the account of the POTS port used for the
SIP proxy server registration [max 31 char].

force-display-as-identity
<off|on>

Setting this parameter on, the number sent in the from and
Contact fields will be always the number configured in the
display-name setting. [default off]

msn-type
<username-registration|
all-msn-registration|

Username-registration (default): when the MSN numbers are added


in this node, a unique register message is sent using the configured
main number in the To, From e Contact fields (authentication
password and user id are always the same configured for this port).

all-msn-own-auth-id >

All-msn-registration: in this case a register message is sent for each


MSN number added where in the To, From e Contact the single
MSN is present (authentication password and user id are always the
same configured for this port)
all-msn-own-auth-id: in this case a register message is sent for each
MSN number added using as username and authentication user id
the MSN number (authentication password is always the same
configured for this port). This implementation allows to use
different account with its username and authentication user id in a
unique port.
jitter-buffer <value>

Duration in ms of the jitter buffer used in the local reproduction of


the voice. [default 50]

voice-activity-detector
<off|on>

Enable/disable the voice activity detection functionality and the


subsequent silence trasmission during an active call. Default value:
off.

echo-cancellation
<on|off|auto>

Enable/disable permanently the echo cancellation on the selected


potslinen line. Auto mode instead disables the echo
cancellation dinamically if it notices fax/modem connections.
[default auto]

tx-loop-gain <value>

Configure the transmission audio level to the digital channel.


Range: 12 - +4 dBr; default: 4. It is reccomended to use a range
between 0/ +4 dBr.

rx-loop-gain <value>

Configure the reception audio level to the digital channel. Range:


12 - +4 dBr; default: 11. It is reccomended to use a range between
11 / -7 dBr.

caller-id-presentation
<off|on-hook|off-hook|both>

off: disables the CLIP on the selected POTS port;


on-hook: enables CLIP reception in on hook status;
off-hook: enables CLIP reception for call received in call
waiting mode;
both: enables CLIP both in on-hook and in off-hook status.
[default both]

reminder-ringing <off|on>

If a call on hold exists, when the user goes on hook and this feature
is enabled, the port will ring to remind the user of the held call.
[default on]

delayed-clearing

During an active call , if the user goes on hook, the call is not
disconnected when this service is active. Available for incoming
calls only. [default on]

call-enable
<both|in|out>

<off|on>

Set the potsline call mode:


56. both means that incoming and outgoing calls are permitted

ATOS User Guide


POTS and ISDN Interfaces - 202 / 483

57. in means that only incoming calls are allowed (outgoing calls
are blocked)
58. out means that only outgoing calls are allowed (incoming calls
are blocked)
[default both]
description
<string>

It is possible to set a description for each potsline node e.g a short


descprition of the service related to the line [max 100 char]

loglevel <value>

Set the detail level used by ATOS to log the events of the pots
interface, from the less detailed one (0) to the more detailed one (5).
Adding the [ - s ] option, this command will be extended to all
potsline subnodes. [default 1]

ATOS\voip\potsline1>>add ?
add command parameters:
<number><string>
Table 177: add
Syntax

Description

number <string>

Associate additional number (string) to the POTSLINE (MSN).


Up to 10 numbers can be associated for each POTS interface.

ATOS\voip\potsline1>>add number 071218981


Number 071218981 added!
Command executed
ATOS007862\voip\potsline1>>add number 071218982
Number 071218982 added!
Command executed

ATOS\voip\potsline1>>del ?
del command parameters:
<number><num1|...|numN>
Table 178: del
Syntax

Description

number < num1|...|numN >

eliminate the number (num1|...|numN) to the POTSLINE.

ATOS007862\voip\potsline1>>del number 071218981


Number 071218981 is deleted
Command executed

ATOS User Guide


POTS and ISDN Interfaces - 203 / 483

ATOS\voip\potsline1>>register
ATOS\voip\ potsline1>>unregister

Table 179: register unregister


Syntax

Description

register

Force the registration for the selected potsline

unregister

Force the deregistration for the selected potsline

For diagnostic purpose, the show statistics command is available, where incoming and
outgoing call statistics will be showed:
ATOS\voip\potsline1>>show statistics
POTSLINE1 STATISTICS:
---------------------------------Successful calls: 81
Failed
calls: 0
Last 5 Calls:
Direction Result
Duration
IN
Success
10 min 21
IN
Success
21 min 39
OUT
Success
7 min 46
OUT
Success
125 min 45
OUT
Success
1 min 32
Command executed

Potslinen Nodes
Codec - Commands

ATOS\voip\potslinen\codec>>set ?
Nodes not available.
Set command parameters:
codec-rate
<10|20|30>
codec-priority <string>
loglevel
<value>

sec
sec
sec
sec
sec

Remote Number
071123456
07198765432
07155443322
07111223344
07199887766

ATOS User Guide


POTS and ISDN Interfaces - 204 / 483

Tabella 2: set
Sintassi

Descrizione

codec-rate <10|20|30>

Configure the codec rate, in milliseconds, for RTP packets sending


[default 20,20,20].

codec-priority <string>

Configure the audio codec priority to use, startin from 1 (highest


priority) to 3 (lowesrt priority) . Parameters must be divided by
comma (see the example below). [default 1,2,0]

loglevel <value>

Set the detail level used by ATOS to log the events of the codec
node, from the less detailed one (0) to the more detailed one (5).
[default 1]

ATOS007862\voip\potsline1\codec>>set codec-priority ?
Codec priority [1(max) - 3(min) (0=not used)
<G.711Alaw,G.729a,G.711Ulaw>]
ex: 1,2,0 : G.711Alaw = max, G.729a = min, G.711Ulaw = not used
ex: 2,1,0 : G.711Alaw = min, G.729a = max, G.711Ulaw = not used
(comma is mandatory!)

Callfeatures Commands

ATOS\voip\potslinen\callfeatures>>set ?
Nodes not available.
Set command parameters:
hold-enable
waiting-enable
held-local-tone
transfer-without-cons-enable
forw-always-enable
forw-busy-enable
forw-no-answer-enable
timer-forw-no-answer
clir-enable
three-party-conference
loglevel

<RFC2543|RFC3264>
<off|on>
<off|on>
<off|on>
<off|on>
<off|on>
<off|on>
<value>
<off|on>
<off|local>
<value>

Tabella 3: set hold-enable


Sintassi

Descrizione

hold-enable
<RFC2543|RFC3264>

Configure in RFC2543/RFC3264 the mode to manage the hold


service for the selected POTS port. [default RFC2543]

waiting-enable <off|on>

Enable/disable the call waiting supplementary service for the


selected POTS port (effective only if the IAD locally manage the
service, not the softswitch). [default off]

ATOS User Guide


POTS and ISDN Interfaces - 205 / 483

held-local-tone <off|on>

Enable/disable the tone generated by the IAD when an active call is


placed in held by the remote side (it receives a re-invite message
that contains a SDP=sendonly. The IAD sends 200 OK with a
SDP=inactive). [default off].

transfer-without-consenable <off|on>

Enable/disable the unconditional call transfer supplementary


service for the selected POTS port (effective only if the IAD locally
manage the service, not the softswitch). [default off]

forw-always-enable <off|on>

Enable/disable the call transfer on busy supplementary service for


the selected POTS port (effective only if the IAD locally manage
the service, not the softswitch). [default off]

forw-busy-enable <off|on>

Enable/disable the call transfer on no answer supplementary


service for the selected POTS port (effective only if the IAD locally
manage the service, not the softswitch). [default off]

timer-forw-no-answer
<value>

Timer, in seconds, for the call transfer on no answer service.


Once the timer expired, the received call is transferred to the
destination number selected during the service configuration
(effective only if the IAD locally manage the service, not the
softswitch). [default 30]

clir-enable <off|on>

Enable/disable the ID restriction service that allows not to


transmit one's identifier for the outgoing calls (effective only if the
IAD locally manage the service, not the softswitch). [default off]

three-party-conference
<off|local>

Enable/disable the three party conference supplementary service


for the selected POTS port (effective only if the IAD locally
manage the service, not the softswitch). [default off]

loglevel <value>

Set the detail level used by ATOS to log the events of the codec
node, from the less detailed one (0) to the more detailed one (5).
[default 1]

Isdnlinen Commands
Any time you add ISDN line under VoIP node, a isdnlinen node is dinamically created.
In this node the following commands are available:

ATOS\voip\isdnline1>>set ?
Nodes available:

Set command parameters:


loglevel
protocol
point-to-point
bearer-capability
type-of-number
tax-enable
username

codec
callfeatures
<value>
<ETSI|Q.SIG>
<off|on>
<3.1KHz|Speech|UDI>
<Unknown|National>
<on|off>
<string>

ATOS User Guide


POTS and ISDN Interfaces - 206 / 483

display-name
<string>
authentication-user-id
<string>
authentication-password
<string>
force-display-as-identity <off|on>
msn-type
<username-registration|all-msn-registration|
all-msn-own-auth-id>
alias
<string>
jitter-buffer
<value>
voice-activity-detector
<off|on>
echo-cancellation
<on|off|auto>
rfc4040-enable
<off|on>
rfc4040-payload-type
<value>
caller-id-presentation
<off|on-hook|off-hook|both>
description
<string>

Table 180: set


Syntax

Description

Protocol <ETSI|Q.SIG>

Select the Standard protocol used on the ISDN interface selected.


(default ETSI)

point-to-point <off|on>

Off means that the ISDN interface works as multi-point


configuration (automatic TEI assignment)
On means that the TE connected to the ISDN interface must be
work using TEI fix to 0
[default off]

bearer-capability
<3.1KHz|Speech|UDI>

Configure the bearer capability used by the IAD for incoming calls
[default speech]

type-of-number
<Unknown|National>

Set the type of number field (TON) in the called party number IE
for incoming calls. [default unknown].

tax-enable <on|off>

Enable/disable the ISDN charge messages to the selected ISDN


port. The effective service operation is dependant on a management
activation by the telephone service provider. [default off].

username <string>

Assign the username used by the SIP protocol to identify the ISDN
port selected (usually the telephone number assigned) [max 32
char].

display-name <string>

Assign the string sent to the called user, present in the


INVITEmessage, Display Name field [max 32 char].

force-display-as-identity
<off|on>

Setting this parameter on, the number sent in the from and
Contact fields will be always the number configured in the
display-name setting. [default off]

msn-type
<username-registration|
all-msn-registration|

Username-registration (default): when the MSN numbers are added


in this node, a unique register message is sent using the configured
main number in the To, From e Contact fields (authentication
password and user id are always the same configured for this port).

all-msn-own-auth-id >

All-msn-registration: in this case a register message is sent for each


MSN number added where in the To, From e Contact the single
MSN is present (authentication password and user id are always the
same configured for this port)
all-msn-own-auth-id: in this case a register message is sent for each
MSN number added using as username and authentication user id

ATOS User Guide


POTS and ISDN Interfaces - 207 / 483

the MSN number (authentication password is always the same


configured for this port). This implementation allows to use
different account with its username and authentication user id in the
same port.
alias

<string>

If configured, it translates the ISDN called number Setup related to


the incoming INVITE to the configured main number.
It translates also the Calling number present in the outgoing ISDN
Setup to the Display number present in the outgoing INVITE
using the configured main number

authentication-user-id
<string>

Assign the username of the account of the ISDN port used for the
SIP proxy server registration [max 32 char].

authentication-password
<string>

Assign the password of the account of the ISDN port used for the
SIP proxy server registration [max 31 char].

jitter-buffer <value>

Duration in ms of the jitter buffer used in the local reproduction of


the voice [default 50]

voice-activity-detector
<off|on>

Enable/disable the voice activity detection functionality and the


subsequent silence trasmission during an active call. [default off]

echo-cancellation
<on|off|auto>

Enable/disable permanently the echo cancellation on the selected


isdnlinen line. Auto mode instead disables the echo
cancellation dinamically if it notices fax/modem or UDI
connections. [default auto]

rfc4040-enable
<off|on>

Enable/disable RFC4040 feature. For such applications, there is a


necessity for a transparent relay of 64 kbit/s data streams in realtime transport protocol (RTP) packets. When its enable and an
unrestricted in/out call is received, echo cancellation is switched off
and G.711 codec is used for transfer via RTP connection. [default
off]

rfc4040-payload-type
<value>

Set the payload type value for packets transport when RFC4040 is
enable. This value shall be different from other payload type value
used by other services (e.g. RFC2833 payload type). [default 97]

caller-id-presentation
<off|on-hook|off-hook|both>

off: disables the CLIP messages on the selected ISDN port;


on-hook: enables CLIP reception in on hook status only;
off-hook: enables CLIP reception for call received in call
waiting mode only;
both: enables CLIP both in on-hook and in off-hook status.
[default both]

loglevel <value>

Set the detail level used by ATOS to log the events of the pots
interface, from the less detailed one (0) to the more detailed one (5).
Adding the [ - s ] option, this command will be extended to all
potsline subnodes. [default 1]

ATOS\voip\isdnline1>>add ?
add command parameters:
<NUMBER><number string>[<alias string>]
Table 181: add
Syntax

Description

ATOS User Guide


POTS and ISDN Interfaces - 208 / 483

number <string>

Associate additional number (string) to the ISDNLINE (MSN).

[<alias string>]

Up to 10 numbers can be associated for each ISDN interface. If


configured, the alias string is used to translate the MSN numbers
as described in the ATOS\voip\isdnline1>>set alias <string>
command

ATOS\voip\isdnline1>>add number 071218981


Number 071218981 added!
Command executed
ATOS\voip\isdnline1>>add number 071218982
Number 071218982 added!
Command executed

ATOS\voip\isdnline1>>del ?
del command parameters:
<number><num1|...|numN>
Table 182: del
Syntax

Description

number < num1|...|numN >

eliminate the number (num1|...|numN) to the ISDNLINE.

ATOS\voip\isdnline1>>del number 071218981


Number 071218981 is deleted
Command executed

ATOS\voip\isdnline1>>register
ATOS\voip\ isdnline1>>unregister

Table 183: register unregister


Syntax

Description

register

Force the registration for the selected isdnline

unregister

Force the deregistration for the selected isdnline

ATOS User Guide


POTS and ISDN Interfaces - 209 / 483

Isdnlinen Nodes
Codec - Commands

ATOS\voip\isdnlinen\codec>>set ?
Nodes not available.
Set command parameters:
codec-rate
<10|20|30>
codec-priority <string>
loglevel
<value>

Tabella 4: set
Sintassi

Descrizione

codec-rate <10|20|30>

Configure the codec rate, in milliseconds, for RTP packets sending.


[default 20,20,20]

codec-priority <string>

Configure the audio codec priority to use, startin from 1 (highest


priority) to 3 (lowesrt priority) . Parameters must be divided by
comma (see the example below). [default 1,2,0]

loglevel <value>

Set the detail level used by ATOS to log the events of the codec
node, from the less detailed one (0) to the more detailed one (5).
[default 1]

ATOS\voip\isdnline1\codec>>set codec-priority ?
Codec priority [1(max) - 3(min) (0=not used)
<G.711Alaw,G.729a,G.711Ulaw>]
ex: 1,2,0 : G.711Alaw = max, G.729a = min, G.711Ulaw = not used
ex: 2,1,0 : G.711Alaw = min, G.729a = max, G.711Ulaw = not used
(comma is mandatory!)

Callfeatures Commands

ATOS\voip\isdnlinen\callfeatures>>set ?
Nodes not available.
Set command parameters:
loglevel
<value>
hold-enable
<RFC2543|RFC3264>
waiting-enable <off|on>

ATOS User Guide


POTS and ISDN Interfaces - 210 / 483

Tabella 5: set hold-enable


Sintassi

Descrizione

hold-enable
<RFC2543|RFC3264>

Configure in RFC2543/RFC3264 the mode to manage the hold


service for the selected ISDN port. [default RFC2543]

waiting-enable <off|on>

Enable/disable the call waiting supplementary service for the


selected ISDN port (effective only if the IAD locally manage the
service, not the softswitch). [default off]

loglevel <value>

Set the detail level used by ATOS to log the events of the codec
node, from the less detailed one (0) to the more detailed one (5).
[default 1]

DDIBundle Commands
Any time you add a DDIBundle under VoIP node, a Bundlename node is dinamically created.
DDIBulndle feature allows to manage GNR service, Multi-port to one number association and vice
versa, Multi port to multi-number range association.
In this node the following commands are available:

ATOS\voip\bundlename>>set ?
Nodes not available.
Set command parameters:
loglevel
<value>
registration-type
<wildcard|first|username>
display-name
<string>
authentication-user-id
<string>
authentication-password
<string>
number
<string>
username
<string>
alias
<string>
line-hunting
<circular|broadcast|potsline1|potsline2|potslinen|
isdnline1|isdnline2>
force-display-as-identity <off|on>
nt1plus-mode
<off|on>
msn-type
<username-registration|all-msn-registration|
all-msn-own-auth-id>
Table 184: set
Syntax

Description

registration-type
<wildcard|first|username>

First means that the first number present on the range


number will be used in the username register field
Wildcard means that the radix followed by a * will be used in
the username register field (as CISCO system required)
Username means that the <string> configured on the relevant
set command (set username <string>), will be used in the

ATOS User Guide


POTS and ISDN Interfaces - 211 / 483

username register field. [default username]


display-name <string>

Assign the string sent to the called user, present in the


INVITEmessage, Display Name field for all ports present in
the bundle [max 32 char].

Authentication-user-id
<string>

Assign the username of the account for all ports present in the
bundle, sent for the SIP proxy server registration [max 32 char].

Authentication-password
<string>

Assign the password of the account for all ports present in the
bundle, sent for the SIP proxy server registration [max 31 char].

Number <string>

Assign the number to the created bundle or a range of numbers


(e.g. MSN, DDI services).
In case of range, the first and the second number should have
the same radix. The second number can be different for up to 4
last digits.
This setting is allowed only if registration-type is
<wildcard>or <first>

Username <string>

Set the username used in the username register field, when


registrationtype is configured ad Username

alias <string>

If configured, it translates the ISDN called number Setup related


to the incoming INVITE to the configured main number
(username string).
It translates also the Calling number present in the outgoing
ISDN Setup to the Display number present in the outgoing
INVITE using the configured main number (username string).

line-hunting
<circular|broadcast|potsline1|
potslinen|isdnline1>

Configure the management of incoming calls, compatible with


the number/range numbers configued.
Circular the incoming calls are offered in round-robin
modality, starting from the first POTS line present in the bundle
(potsline1 ... potsline4 than isdnline1 ... isdnline4). If the first
POTS/ISDN port is busy, the incoming calls will be offered to
the next idle port
Broadcast the incoming calls are offered to all ports present
in the bundle at the same time (potsline and isdnline)
Potsline1/isdnline1 the incoming calls are prefered
offered to the potslinen/isdnlinen configured. ). If the prefered
POTS/ISDN port is busy, the incoming calls will be offered to
the next POTS/ISDN line idle port.
[default circular]

force-display-as-identity
<off|on>

Setting this parameter on, the number sent in the from and
Contact fields will be always the number configured in the
display-name setting. [default off]

nt1plus-mode
<off|on>

Setting this parameter on, the incoming calls are offered to all
ISDN lines and at the same time to the POTS port selected in
line-hunting configuration. Using this configuration in a
buldle, typically associating two potsline and an isdnline, its
possible to riproduce the same NT1 Plus behaviour for
incoming calls. [default off]

msn-type

Username-registration: when single numbers are added using


the command add range (e.g. \voip\bundlename>>add range
123456), a unique register message is sent using the configured
main number in the To, From e Contact fields (authentication
password and user id are always the same configured for this
bundle).

<username-registration|allmsn-registration|
all-msn-own-auth-id>

ATOS User Guide


POTS and ISDN Interfaces - 212 / 483

All-msn-registration: in this case a register message is sent for


each single number added using the command add range
where in the To, From e Contact each single number is present
(authentication password and user id are always the same
configured for this bundle)
all-msn-own-auth-id: in this case a register message is sent for
each single number added with the command add range, using
as username and authentication user id the single number
configured. (authentication password is always the same
configured for this bundle). This implementation allows to use
different account with its username and authentication user id in
a unique bundle.
[default username-registration]

ATOS\voip\bundlename>>set number 071218981001-2000


Command executed

ATOS\voip\bundlename>>add ?
add command parameters:
<PORT><POTSLINE1|...|ISDNLINEn>
<RANGE><range>[<alias>][<PORT><POTSLINE1|...|ISDNLINEn>]
Table 185: add
Syntax

Description

Port <POTSLINE1|...|ISDNLINEn>

Add the potslinen/isdnlinen to the selected DDI-bundle.

Range <range>

Add a number or a range of numbers to the created bundle (e.g.


MSN, DDI services).

[<alias>][<PORT><POTSLINE1|...|ISDNLI
NEn>]

In case of range, the first number should have the same radix.
The second number can be different for up to 4 last digits.
It is possible to add up to 10 different ranges
This setting is allowed only if registration-type is <username>
Alias: if configured, translates the ISDN called number Setup
related to the incoming INVITE to the configured number/range
added. It translates also the Calling number present in the
outgoing ISDN Setup to the Display number present in the
outgoing INVITE using the configured number contained into
the added range.
Port: if configured (valid only for single number and not for
ranges), selects the POTSLINE or the ISDNLINE port where
the compatible incoming call for this number will be offered.
The POTSLINEn or IDSNLINEn shall be added before to use
the above command.

ATOS User Guide


POTS and ISDN Interfaces - 213 / 483

ATOS\voip\bundlename>>add port isdnline1


IsdnLine1 added to DDIbundle bundlename
Command executed

ATOS\voip\bundlename>>add range 071218981001-100 71987654-753


Command executed
ATOS\voip\bundlename>>add range 071218982020-40
Command executed

ATOS\voip\bundlename>>add range 9876543 port potsline2


Command executed
Note: potsline2 must be added before the add range command

ATOS\voip\bundlename>>del ?
del command parameters:
<PORT><POTSLINE1|...|ISDNLINEn>
<RANGE><range>
Table 186: del
Syntax

Description

Port <POTSLINE1|...|ISDNLINEn>

Delete the potslinen/isdnlinen to the selected DDI-bundle.

Range <range>

Delete the number / range to the selected DDI-bundle

ATOS\voip\bundlename>>del port isdnline1


IsdnLine1 deleted from DDIbundle bundlename
Command executed

ATOS\voip\bundlename>>del range 071218982020-40


Command executed

ATOS\voip\bundlename>>register
ATOS\voip\bundlename>>unregister

ATOS User Guide


POTS and ISDN Interfaces - 214 / 483

Table 187: register unregister


Syntax

Description

register

Force the registration for the selected DDI-Bunldle

unregister

Force the deregistration for the selected DDI-Bunldle

ATOS User Guide


Quality of Service - 215 / 483

Quality of Service
An Overview
The term "Quality of Service" generally refers to a set of mechanisms that provide an optimal
bandwidth utilization when different types of traffic share a single communication link.
IP data networks traditionally provide a kind of "best effort" services, which may result in large
delays, unpredictable transmission times ("jitter") and in some cases in the loss of a certain fraction
of the packets sent. These impairments may be acceptable for some types of traffic, for example
when browsing an Internet site or when downloading a bulk file, but they may instead heavily affect
some other traffic flows, such as voice, video or highly transactional or interactive data traffic.
For example, the small packets composing a voice traffic flow are produced at a regular pace and
require fast and timely service, while most types of bulk data traffic are composed of large packets
with a "bursty" emission pattern. If these two traffics share a single communication path, it may
happen that a voice packet may be queued behind multiple large packets and then it must be waiting
for them to be forwarded, thus generating some variable amount of delay ("jitter").
Additionally, a communication node may become congested at some time due to heavy traffic
conditions and it may decide to drop packets. Again, data traffic is much more resilient to packet
loss than voice traffic, where instead the loss of a single voice packet may propagate into hundreds
of milliseconds of corrupted speech.
As long as the available end-to-end bandwidth is largely exceeding the actual data rates, these
problems are minimized, but when the bandwidth becomes scarce, it becomes necessary to use
some Quality of Service mechanisms. For example, QoS may provide a communication node with a
mean to distinguish among the different traffic types, so that it may put packets from different flows
into separate queues and properly schedule transmission from each queue or even select which
packets are to be preferentially dropped when the node enters into a congested state.

QoS does not actually provide additional bandwidth; it only guarantees an optimal usage of the
available bandwidth.

Network level QoS techniques fall in two broad areas, the Integrated Services (IntServ) and the
Differentiated Services (DiffServ) models.
The IntServ model relies on specific signaling protocols to reserve network resources and to enforce
admission control.
The DiffServ model instead relies on differentiating traffic flows according to specified IP
parameters, associating a different behaviour to each traffic class; and performing specific actions
such as classification, meter, marking, policing and traffic shaping on each separate traffic class.
DiffServ does not use require any kind of signaling among the routers in the path.

ATOS User Guide


Quality of Service - 216 / 483

ATOS and QoS


ATOS provides an implementation of the DiffServ model. This is referred to as level 3 QoS
(L3QoS) as it applies to IP traffic subject to routing operations.
Actually ATOS extends some DiffServ functionalities to the Ethernet traffic. This is referred to as
level 2 QoS (L2QoS) and it applies to Ethernet traffic subject to bridging and routing operations.
Additionally, ATOS also extends QoS at the ATM level by applying some special marking policies
to ATM cells. In the remaining parts of this manual this is referred to as ATM CLP marking QoS,
which is described in a subsequent section.

The DiffServ Model


The figure below describes a typical arrangement of DiffServ actions on a DiffServ enabled router:

DiffServ
Metering

Classifier

Marker

Shaper/Dropper

RFC2474 redefines the TOS octet defined in the IP standard document (RFC791) for specific use
by DiffServ.
The first 6 bits of this octet are coded as a Differentiated Services Code Point (DSCP):
0

DSCP

7
1

cu

DSCP is used to identify traffic classes.


The DiffServ uses the term Per Hop Behavior (PHB) to indicated the forwarding treatment of
packets in a certain traffic class.
The DiffServ documents define different classes of PHB:
the Expedited Forwarding (EF) PHB applies to privileged flows requiring low-loss, low-latency
and low-jitter behavior;

cu = currently unused, reserved for future use

ATOS User Guide


Quality of Service - 217 / 483

the Assured Forwarding (AF) PHBs share the bandwidth remaining after allocation to EF traffic.
AF traffic is guaranteed a limited QoS, mainly in terms of assured minimum bandwidth and
drop precedence.
The DiffServ model supports up to four separated AF classes: AF1, AF2, AF3 and AF4, with a
certain fraction of the available bandwidth assigned to every class.
Each AF class is further subdivided into up to three sub-classes with different discard
precedence levels. Subclasses are indicated as AFxy, e.g. AF11 or AF43. Subdividing Classes into
sub-classes is also referred to as coloring.
the Default PHB corresponds to the Best Effort Services, where no packet loss, delay or jitter
performance is guaranteed;
the Class Selector PHB guarantees compatibility with implementations that utilize the Precedence
Bits, previously allocated to the same bits as the DSCP.
A number of codepoints has been defined to indicate the different PHBs:
0

0
1
X
X

0
0
X
X

DSCP
0 0
1 1
X Y
X 0

cu
0
1
Y
0

0
0
Y
0

0
0
0
0

Per Hop Behavior

0 Default PHB (RFC 2474)


0 Expedited Forwarding (EF) PHB (RFC 2598),
0 Assured Forwarding (AFxy) PHB (RFC 2597),
0 Class-Selector PHBs (RFC 2474)

Classification
DiffServ packets are classified basing on a set of level 3 or level 2 conditions, such as the selector
fields contained in an access list (Source IP Address / Port, Destination IP Address / Port, protocol),
the value contained in the DSCP field, VLAN ID (IEEE 802.1Q), VLAN priority (IEEE 802.1p),
and Source Interface.

Marking
Classified traffic may be submitted to a Marking action to modify the DSCP value of each packet in
the level3 classes, while to modify the VLAN priority (IEEE 802.1p) for packets belonging to
level2 classes.

Metering
Metering consists in monitoring the packet arrival pattern in each traffic class to verify whether the
traffic flow is conforming to a specific temporal profile.

ATOS User Guide


Quality of Service - 218 / 483

Different types of meters are used:


Band Limit (CIR2);
Single Rate Double Bucket (CIR,CBS3,EBS4);
Double Rate Double Bucket (CIR,PIR5,CBS,EBS).
Based on the results of SRDB6 and DRDB7 metering, packets can be colored:
full conforming packets are tagged as GREEN;
packets exceeding the average rate are tagged as YELLOW;
packets exceeding the peak rate are tagged as RED.
Different actions can be taken on a metered packets according to the resulting color:
the packet can be discarded;
the packet can be downgraded to a lower priority.
Band Limit meter instead, does not color or downgrade packets but limits the flow rate speed to the
configured value (CIR). Packets exceeding are discarded.

Active Queue Management


Diffserv documents define algorithms to avoids traffic congestion. The following figure describes
the behavior of one of these techniques, known as Random Early Discard (RED).
RED monitors the average occupancy of a queue, and when this occupancy exceeds a minimum
threshold (ThMin) it starts discarding packets with some dropping probability. This probability
increases linearly up to a maximum value when the queue occupancy level reaches a maximum
threshold (ThMax).
Drop Prob %
100

Queue
Status

0
Empty

Committed Information Rate

Committed Burst Size

Excess Burst Size

Peak Information Rate

Single Rate Double Bucket

Double Rate Double Bucket

ThMin

ThMax

Full

ATOS User Guide


Quality of Service - 219 / 483

Scheduling
Scheduling techniques are used to prioritize traffic and to allocate the bandwidth among the
different traffic flows. ATOS implements a configurable scheduling scheme. A typical scheme is
represented in this figure:

max

EF

Queue

AF1x

Queue

50%

AF2x

Queue

30%

AF3x

Queue

20%

BE

Queue

WFQ

med

Priority
Scheduler

min

The Priority Scheduler select ("de-queues") packets for forwarding from one of its several input
queues based on fixed priorities. As long as a higher priority input has packets to be sent, other
packets are not removed from lower priority queues.
In the Weighted Fair Queuing Scheduler each input flow is granted at least a certain percentage of
the output bandwidth. The WFQ scheduler is usually put in front of the priority scheduler and
provides bandwidth sharing among AF classes.

Level 3 QoS
Level3 QoS is implemented by applying DiffServ actions to IP traffic classes Basically, ATOS
allows to define:
one or more sets of rules to classify traffic (classifiers).
Classification parameters include access lists containing IP selectors (addresses, ports and/or
protocol numbers), the DSCP value or the IP precedence value
one or more lists of DiffServ actions (policies).
A policy can contain one or more actions for the defined the traffic classes. A traffic class for
which no action is defined is not affected by that policy.
Actions listed in a policy are:
marking (DSCP or precedence-TOS),
metering (Band Limit, Single Rate Double Bucket, Double Rate Double Bucket),
queueing (Priority, Bandwidth Repartition/WFQ),
congestion avoidance (Random Early Discard).
one or more associations, binding policies to interfaces. An association specifies a policy, an
interface and a specific direction (incoming or outgoing traffic).

ATOS User Guide


Quality of Service - 220 / 483

Level 2 QoS
Level2 QoS is also implemented by applying actions to Ethernet (level 2) traffic classes as indicated
in level 2 specific policies.
ATOS uses a similar scheme as for level 3 QoS, although with level 2 specific classification
parameters and actions:
Level 2 classification parameters include
the VLAN Id in the 802.1Q tag,
the Source Interface,
the 802.1p priority value,
the DSCP values contained in the IP payload.
Level 2 policies use the following actions:
marking (affecting 802.1p priority bits only)
queueing (priority or bandwidth repartition)
Opposite to level 3 associations, Level 2 associations only bind a policy to an "output" interface.

ATM CLP Marking


ATOS provides a mechanism to operate differentiated level 2 traffic marking based on level 3
classification. This allows traffic at different level 3 priority to receive differentiated treatment
when level 2 marking is applied.
On ATM interfaces, a Maximum Cell Rate is defined (e.g. PCR for CBR/UBR and SCR for VBR
traffic). Cells exceeding this MCR may receive a lower quality of service, for example they may be
discarded along the route if one or more nodes enter a congestion state.
When multiple traffic flows share the same VCC, cells originated from traffic flows with different
priorities (e.g. VoIP and Best effort traffic) will receive the same treatment. So if a host on the
LAN generates Internet traffic in excess of the provisioned MCR, it may adversely affect the
transmission of voice packets generated, for example, by another host on the LAN.
A possible solution to this problem is to route different traffic flows to separate VCCs with different
CoS ("VC bundling") so that any interference between different traffic flows is avoided. This
solution is however expensive as it requires provisioning and operation of multiple ATM VCCs
even if to the same destination.
L2QoS provides instead an alternative solution, by applying selective marking of the Cell Loss
Priority bit, so to allow ATM switches along the route to only discard cells related to low priority
traffic flows.
ATOS Level2 QoS can be represented by the following diagram:

Classifier

MultiBucket
Meter

CLP
Marker

ATOS User Guide


Quality of Service - 221 / 483

L2QoS first classifies outgoing IP traffic flows based on the DSCP value (which can be set to
different values by the external hosts or by the internal IP QoS engine). Up to 63 priority levels can
be defined.
The aggregate traffic is then metered by a Multi-Bucket Meter (MBM). The MBM consists in a set
of single-rate, single-bucket meters. If we consider three precedence levels (for example VOIP,
VPN and BEST EFFORT) the MBM will be configured with three SR-SB meters. The first meter
measures the VOIP traffic only, the second meter measures the aggregate VOIP and VPN traffic,
the third one measures the aggregate VOIP, VPN and BEST EFFORT traffic.
In first place, the MBM guarantees that if the aggregate traffic exceeds the MCR, an adequate
number of cells is marked with CLP=1. At the same time, it also preserves traffic at a certain
priority level from being marked if the MCR is exceeded only by traffic at lower priorities.
As an example, suppose that traffic with three different levels of priority are sent through an ATM
VCC:
VoIP traffic (highest priority);
VPN traffic (mid level priority);
Best Effort (BE) traffic (lowest priority).
The L2QoS algorithm acts as follows:
cells generated from VoIP packets are only marked if the VoIP traffic actually exceeds the MCR;
cells generated from VPN packets are only marked if the aggregate VoIP and VPN traffic exceeds
the MCR;
cells generated from BE packets are marked if the aggregate VoIP and VPN and BE traffic exceeds
the MCR.
When a cell exceed the MCR, the MBM either marks the cells or it issues a penalty which is used to
mark the first subsequent cell originated from a lower priority flow, even if that particular cell is
conforming to the MCR. So, for example, a cell originated by a BE packet may be marked even if
it is complying with the MCR, due to a previous VPN or VoIP cell having exceeded the MCR.

Configuring QoS
The ATOS configuration tree includes a QoS node, with a DiffServ sub-node.

DiffServ Nodes
Under the DiffServ node, the CLI defines three classes of dynamic objects (nodes):
a CLASSIFIER node defines the criteria used to identify packets as belonging to a certain traffic
class. Classification criteria are either based on an access list or on a DSCP value;
a POLICY node defines the set of the QoS actions applied to one or multiple traffic classes;
an ASSOCIATION node binds a policy to an interface either in the inbound or outbound direction.
Once classifiers and policies are defined, the user creates one or more associations to bind a policy
to an interface and a direction.

ATOS User Guide


Quality of Service - 222 / 483

Subsequently, packets belonging to a certain class and arriving from (or destined to) an interface are
subject to the actions specified by the policy bound for that interface.

DiffServ - Commands
Under the DiffServ node, the add command is used to create classes, policies and associations.
ATOS\qos\diffserv>>add ?
add command
classifier
policy
association
association

parameters:
<classifier name>
<level-2|level-3>
<policy name>
<level-2|level-3>
<association name> level-2 <policy name><interface name>
<association name> level-3 <policy name>
<interface name><in|out>

Table 188: add policy | classifier


Syntax

Description

classifier name

Name of the CLASSIFIER to create, identified by an alphanumeric


string, with a maximum of 20 characters.

policy name

Name of the POLICY to create, identified by an alphanumeric


string, with a maximum of 20 characters.

level-2|level-3

Keywords that identify class to use in level 2 or level 3 policy.

Table 189: add association


Syntax

Description

association name

Name of the association being created, identified by an


alphanumeric string, with a maximum of 20 characters.

level-2 | level-3

Keywords that identify class to use in level 2 or level 3 policy.

policy name

Name of an already configured policy.

interface name

Name of an interface to associate to the policy.

in|out

Direction for which the policy apply. This parameter must be


indicated in level 3 association only.

ATOS User Guide


Quality of Service - 223 / 483

Level 3 Classifier Commands


Under each Classifier node an add command is used to specify a classification rule. Each
classification rule is expressed by a reference to an access list or as value in the DSCP field.
The clause <match all off> (default) requires that at least one of the listed rules must be matched.
The clause <match all on> requires that all the listed rules must be matched.
ATOS\qos\diffserv\MY_L3_CLASS>>add ?
add command parameters:
accesslist <access list name>
dscp
<dscp value>
prec
<prec value>
Table 190:add
Syntax

Description

access list name

Name of the access list used to classify the packet. In QoS


Classifier only PERMIT access list can be used, in fact it should
indicate which packets have the permission to belong to a class.

dscp value

Value of the dscp field.

prec value

Value of IP precedence field.

Level 2 Classifier Commands


Under each Classifier node an add command is used to specify a classification rule. Each
classification rule is expressed by a reference to an access list or as value in the DSCP field.
The clause <match all off> (default) requires that at least one of the listed rules must be matched.
The clause <match all on> requires that all the listed rules must be matched.
ATOS\qos\diffserv\MY_L2_CLASS>>add ?
add command parameters:
vlan-id
<vlan-id value>
vlan-prio <vlan-prio value>
dscp-val <dscp value>
src-ifc
<src ifc name>
dst-mac
<mac-address aa-bb-cc-dd-ee-ff>
src-mac
<mac-address aa-bb-cc-dd-ee-ff>
Table 191: add
Syntax

Description

vlan-id value

Value of the vlan-id.

vlan-prio value

Value of the vlan-prio.

ATOS User Guide


Quality of Service - 224 / 483

dscp value
src ifc name
dst-mac
<mac-address aa-bb-cc-dd-ee-ff>
src-mac
<mac-address aa-bb-cc-dd-ee-ff>

Value of the dscp field.


Name of the source interface.
Value of the destination mac address
Value of the source mac address

Level 3 Policy Commands


Under each policy node a list of add commands is used to specify classes of traffic and the relevant
actions.
Defining a level 3 policy:
ATOS\qos\diffserv\MY_L3_POLICY>>add ?
add command parameters:
<classifier><QUEUING-BAND><bandwidth><queue length>
<classifier><QUEUING-PRIORITY><priority><queue length>
<classifier><MARK-DSCP><dscp>
<classifier><MARK-IPPREC><precedence><tos>
<classifier><MARK-VC><vpi><vci>[<port>]
<classifier><MARK-DLCI><dlci>
<classifier><SHAPING><shaping rate>
<classifier><METER-BAND-LIMIT><CIR>
<classifier><METER-SR-DB><color aware><color
marking><CIR><CBS><EBS><red PHB><green PHB><yellow PHB>
<classifier><METER-DR-DB><color aware><color
marking><CIR><CBS><EBS><PIR><red PHB><green PHB><yellow PHB>
<classifier><RED><min threshold><max threshold><red discard
probability><green discard probability><yellow discard probability>
bandwidth:
1-100%
priority:
1-1000
dscp:
0-63
vpi:
0-255
vci:
32-65535
dlci:
16-4194303
precedence:
0-7
tos:
0-15
color aware: AWARE|BLIND
color marking:ON|OFF
PIR CIR:
Kbit/sec
EBS CBS:
byte
queue length 2,4,8,16,32,64,128,256,512,1024
shaping rate Kbit/sec (0: no shaping)
r/g/y PHB:
to-same-phb|to-best-effort|to-be-dropped
min/max threshold:
0-63
r/g/y discard probability: 1-100%

ATOS User Guide


Quality of Service - 225 / 483

Table 192:add

Syntax

Description

classifier name

The name of the class the action is associated to.

bandwidth value

Bandwidth percentage (1-100%)

priority value

1 to 1000 where 1000 is the maximum priority

dscp value

The value to be used in the marking of the DSCP field (0-63).

queue length

Configure the packets code length: 2, 4, 8, 16, 32, 64, 128, 256,
512, 1024

precedence value

IP Precedence field value (0-7).

tos value

The value to be used in the marking the TOS field value (0-15).

mark

Keyword that indicates a marking action.

shaping

Keyword to configure the shaping rate in Kbps

cir value

Committed Information Rate (0-8.000 kbps).

<meter-SR-SB>
<meter-SR-DB>
<meter-DR-DB>

Keywords that indicate a Metering.


-

SR stands for Single-Rate (CIR);

SB stands for Single-Bucket (CBS);

DB stands for Double-Bucket (CBS, EBS);

DR stands for Double-Rate (CIR, PIR);

DB stands for Double-Bucket (CBS, EBS).

aware|blind

keyword that indicates if the meter is color aware or not.

color marking

Enable coloring for the packets processed by the meter (values ON


or OFF)

CIR

Committed Information Rate (0-8.000 kbps).

PIR

Peak Information Rate (0-8.000 kbps).

CBS

Committed Burst Size in byte.

EBS

Excess Burst Size in byte.

<green PHB>
<yellow PHB>
<red PHB>

The PHB assigned to the metered packets, based on the results of


the metering action ("packet color"). The original PHB of the
packet can be maintained ("to-same-phb") or the packets can be
downgraded to the Default PHB ("to-best-effort") or
discarded ("to-be-dropped").

RED

Random Early Discard.

min threshold

Minimum threshold (ThMin).

max threshold

Maximum threshold (ThMax).

<green discard probab.>


<yellow discard probab.>
<red discard probab.>

Discard percentage for green/yellow/red packets at ThMax.

<queuing-band><bandwidth>

Packets in this class are input to a WFQ8 scheduler, with the


indicated guaranteed bandwidth percentage.

Weighted Fair Queuing

ATOS User Guide


Quality of Service - 226 / 483

<queuing-priority><priority>

Packets in this class are DIRECTLY input to a Priority scheduler


with the indicated priority (1 to 1000).

Level 2 Policy Commands


ATOS\qos\diffserv\MY_L2_POLICY>>add ?
<classifier><QUEUING-BAND><bandwidth<queue length>>
<classifier><QUEUING-PRIORITY><priority><queue length>
<classifier><MARK-VC><vpi><vci>[<port>]
<classifier><MARK-DLCI><dlci>
<classifier><MARK-VLAN-PRIO><vlan priority>
<classifier><MARK-DSCP-L2><dscp>
bandwidth:
priority:
vpi:
vci:
dlci:
vlan priority:
dscp:

1-100%
1-1000
0-255
32-65535
16-4194303
0-7
0-63

Table 193:add
Syntax

Description

classifier

The name of the class the action is associated to.

queuing-band

Keyword that indicates a WFQ scheduling behaviour.

bandwidth

The value of the bandwidth percentage of the WFQ queue.

queuing-priority

Keyword that indicates a priority scheduling behaviour.

priority

The value of the priority. Data stream belonging to a class


associated to higher priority value are processed before the lower
priority ones.

queue length

Configure the packets code length: 2, 4, 8, 16, 32, 64, 128, 256,
512, 1024

mark-vc

Keyword that indicates a marking action dealing with a certain VC


indicated by a VPI and a VCI. If more then one port is using the
same VC (e.g. two different ShDSL links) <port> indicates which
one is involved.

mark-dlci

Keyword that indicates a marking action dealing with a certain


DLCI.

mark-vlan-prio

Keyword that indicates a marking action dealing with IEEE 802.1p.

vlan priority

The value of vlan priority the packet will be marked with.

MARK-DSCP-L2

Keyword that indicates a marking action dealing with a certain


DSCP value

ATOS User Guide


Quality of Service - 227 / 483

Level 3 / Level 2 Association - Commands


ATOS\qos\diffserv>>
ATOS\qos\diffserv>>MY_L3_ASSOCIATION
ATOS\qos\diffserv\MY_L3_ASSOCIATION>>set ?
Nodes not available.
Set command parameters:
loglevel <value>
ATOS\qos\diffserv>>
ATOS\qos\diffserv>>MY_L2_ASSOCIATION
ATOS\qos\diffserv\MY_L2_ASSOCIATION>>set ?
Nodes not available.
Set command parameters:
loglevel <value>

A DiffServ level 3 configuration example


This paragraph shows a level 3 QoS configuration example using the CLI.
Start from the node ATOS\qos\diffserv>>. Initially classifiers, policies and associations are
not defined.
ATOS>>qos
ATOS\qos>>diffserv
ATOS\qos\diffserv>>show conf
No classifier added
No policy added
No association added
Command executed

The first step is to configure an access list to define the parameters used to separate the traffic into
classes. In this example we will define three classes:
a VOIP class for the UDP traffic;
a WEB class for HTTP Browsing traffic (TCP on 80 port);
a FTP class for FTP Data TCP on 20 and 21 ports traffic.
ATOS\accesslist>>add VOIP permit udp any any anyport anyport
Command executed
ATOS\accesslist>>add WEB permit tcp any any anyport equ http
Command executed
ATOS\accesslist>>add FTP permit tcp any any anyport range 20 21
Command executed

The following access lists are now configured.

ATOS User Guide


Quality of Service - 228 / 483

ACCESS LIST VOIP RULE N.1


Access right and protocol ..
Source/dest address ........
IP option ..................
Source/dest port ...........

permit udp
<any><any>
none
<anyport><anyport>

ACCESS LIST WEB RULE N.1


Access right and protocol ..
Source/dest address ........
IP option ..................
Source/dest port ...........
TCP flag (value/wildmask) ..

permit tcp
<any><any>
none
<anyport><equ http>
none

ACCESS LIST FTP RULE N.1


Access right and protocol ..
Source/dest address ........
IP option ..................
Source/dest port ...........
TCP flag (value/wildmask) ..

permit tcp
<any><any>
none
<anyport><range 20 21>
none

From the ATOS\QoS\DiffServ node add a VOIP_CLASS QoS class and associate it to the
VOIP Access List;
ATOS\qos\diffserv>>add ?
add command
classifier
policy
association
association

parameters:
<classifier name>
<level-2|level-3>
<policy name>
<level-2|level-3>
<association name> level-2 <policy name><interface name>
<association name> level-3 <policy name>
<interface name><in|out>

ATOS\qos\diffserv>>add classifier VOIP_CLASS


Command executed
ATOS\qos\diffserv>>VOIP_CLASS
ATOS\qos\diffserv\VOIP_CLASS>>add ?
add command parameters:
accesslist <access list name>
dscp
<dscp value>
prec
<prec value>
ATOS\qos\diffserv\VOIP_CLASS>>add accesslist VOIP
Command executed

In the same way add WEB_CLASS and FTP_CLASS classes and associate them to the WEB and
DATA Access Lists, as shown below:
ATOS\qos\diffserv>>add classifier WEB_CLASS
Command executed
ATOS\qos\diffserv>>WEB_CLASS
ATOS\qos\diffserv\WEB_CLASS>>add accesslist WEB

ATOS User Guide


Quality of Service - 229 / 483

Command executed
ATOS\qos\diffserv\WEB_CLASS>>up
ATOS\qos\diffserv>>add classifier FTP_CLASS
Command executed
ATOS\qos\diffserv>>FTP_CLASS
ATOS\qos\diffserv\FTP_CLASS>>add accesslist DATA
Command executed

Let's review the resulting configuration


ATOS\qos\diffserv>>show conf
VOIP_CLASS
WEB_CLASS
FTP_CLASS
No policy added
No association added
Show of ATOS qos diffserv VOIP_CLASS
Match all condition
: off
List condition
condition 1 : access list VOIP
Show of ATOS qos diffserv WEB_CLASS
Match all condition
: off
List condition
condition 1 : access list WEB
Show of ATOS qos diffserv FTP_CLASS
Match all condition
: off
List condition
condition 1 : access list DATA

Create a policy "MY_L3_POLICY" and associate


an Expedited Forwarding PHB to VOIP_CLASS traffic, marked with a DSCP = 46, a priority =
1000, and a bandwidth limit = 500 kbps;
an Assured Forwarding 4 PHB to WEB_CLASS class, marked with DSCP = 34, with a bandwidth
usage percentage = 70%;
an Assured Forwarding 4 PHB to FTP_CLASS class, marked with a DSCP = 10, with a bandwidth
usage percentage = 30%;
a Best Effort PHB to the remaining traffic.
ATOS\qos\diffserv>>add policy level-3 MY_L3_POLICY
Command executed
ATOS\qos\diffserv>>MY_L3_POLICY
Command executed
ATOS\qos\diffserv\MY_L3_POLICY>>add VOIP_CLASS mark 46
Command executed
ATOS\qos\diffserv\MY_L3_POLICY>>add VOIP_CLASS queuing-priority 1000
Command executed
ATOS\qos\diffserv\MY_L3_POLICY>>add VOIP_CLASS band-limit-meter 500
Command executed
ATOS\qos\diffserv\MY_L3_POLICY>>add WEB_CLASS mark 34

ATOS User Guide


Quality of Service - 230 / 483

Command executed
ATOS\qos\diffserv\MY_L3_POLICY>>add WEB_CLASS queuing-band 70
Command executed
ATOS\qos\diffserv\MY_L3_POLICY>>add WEB_CLASS red 40 60 100 100 100
Command executed
ATOS\qos\diffserv\MY_L3_POLICY>>add FTP_CLASS mark 10
Command executed
ATOS\ qos\diffserv\MY_L3_POLICY>>add FTP_CLASS queuing-band 30
Command executed
ATOS\qos\diffserv\MY_L3_POLICY>>add FTP_CLASS red 40 60 100 100 100
Command executed

Build MY_L3_ASSOCIATION and bind it to MY_L3_POLICY on the ATM_VC0 outgoing


interface.

ATOS\qos\diffserv>>add association MY_L3_ASSOCIATION level-3


MY_L3_POLICY atm_vc0 out

QoS DiffServ Level 3 is running, statistics and status are now available:
ATOS\qos\diffserv\MY_L3_ASSOCIATION>>show statistics
Policy : MY_L3_POLICY
Packet Processed : 0
*****************************
Prio Queue (prio=1000)
Packet Enqueued : 0
Packet Out
: 0
Discarded Packets : 0
Meter colored:
- green: 0
- yellow: 0
- red:
0
*****************************
Band Queue WFQ (band=70%)
Prio Queue (prio=100)
Packet Enqueued : 0
Packet Out
: 0
Discarded Packets : 0
RED discarded:
- green: 0 over 0 analyzed
- yellow: 0 over 0 analyzed
- red:
0 over 0 analyzed
*****************************
Band Queue WFQ (band=30%)
Prio Queue (prio=100)
Packet Enqueued : 0
Packet Out
: 0
Discarded Packets : 0
RED discarded:
- green: 0 over 0 analyzed
- yellow: 0 over 0 analyzed
- red:
0 over 0 analyzed
*****************************

ATOS User Guide


Quality of Service - 231 / 483

Prio Queue (prio=0)


Packet Enqueued : 0
Packet Out
: 0
Discarded Packets : 0
*****************************

ATOS\qos\diffserv\MY_L3_POLICY>>show status
Policy : MY_L3_POLICY
Packet To Deliver: 0
Prio Queue (prio=1000)
Packet Queued: 0
Queue Size
: 63
Meter Enabled
*****************************
Band Queue WFQ (band=70%)
Not ActivePrio Queue (prio=100)
Packet Queued: 0
Queue Size
: 63
Red Enabled
*****************************
Band Queue WFQ (band=30%)
Not ActivePrio Queue (prio=100)
Packet Queued: 0
Queue Size
: 63
Red Enabled
*****************************
Prio Queue (prio=0)
Packet Queued: 0
Queue Size
: 63
*****************************

A DiffServ level 2 configuration example


This paragraph shows a level 2 QoS configuration example using the CLI.
Start from the node ATOS\qos\diffserv>>. Initially classifiers, policies and associations are
not defined.
ATOS>>qos
ATOS\qos>>diffserv
ATOS\qos\diffserv>>show conf
No classifier added
No policy added
No association added
Command executed

The first step is to configure two classes:


a VLAN1 class for the traffic tagged with VLAN ID value as 1;
a VLAN2 class for the traffic tagged with VLAN ID value as 2.

ATOS User Guide


Quality of Service - 232 / 483

ATOS>>qos diffserv
ATOS\QoS\DiffServ>>add classifier VLAN1 level-2
Command executed
ATOS\QoS\DiffServ>>add classifier VLAN2 level-2
Command executed

Lets associate to each class one of the level 2 available condition.


ATOS\QoS\DiffServ\VLAN1>>add vlan-id 1
Command executed
ATOS\QoS\DiffServ\VLAN1>>up
ATOS\QoS\DiffServ>>VLAN2
ATOS\QoS\DiffServ\VLAN2>>add vlan-id 2
Command executed

Lets build a level 2 policy that privileges traffic belonging to VLAN1 instead of traffic belonging
to VLAN2; the remainig traffic will be classified as best effort and will be send only if the other
queues are empty.
ATOS\QoS\DiffServ>>add policy MY_L2_POLICY level-2
Command executed
ATOS\QoS\DiffServ>>MY_L2_POLICY
ATOS\QoS\DiffServ\MY_L2_POLICY>>add VLAN1 queuing-priority 1000
Command executed
ATOS\QoS\DiffServ\MY_L2_POLICY>>add VLAN2 queuing-priority 900
Command executed

Build MY_L2_ASSOCIATION and bind it to MY_L2_POLICY on the ATM_VC0 outgoing


interface.

ATOS\qos\diffserv>>add association MY_L2_ASSOCIATION level-2


MY_L2_POLICY atm_vc0

QoS DiffServ Level 2 is running, statistics and status are now available:
ATOS\QoS\DiffServ>>MY_L2_ASSOCIATION
ATOS\QoS\DiffServ\MY_L2_ASSOCIATION>>show statistics
Policy : MY_L2_POLICY
Packet Processed : 0
*****************************
Prio Queue (prio=1000)
Packet Enqueued : 0
Packet Out
: 0
Discarded Packets : 0
*****************************
Prio Queue (prio=900)
Packet Enqueued : 0
Packet Out
: 0
Discarded Packets : 0
*****************************

ATOS User Guide


Quality of Service - 233 / 483

Prio Queue (prio=0)


Packet Enqueued : 0
Packet Out
: 0
Discarded Packets : 0
*****************************

ATOS\QoS\DiffServ\MY_L2_ASSOCIATION>>show status
Policy : MY_L2_ASSOCIATION
Packet To Deliver: 0
Prio Queue (prio=1000)
Packet Queued: 0
Queue Size
: 63
*****************************
Prio Queue (prio=900)
Packet Queued: 0
Queue Size
: 63
*****************************
Prio Queue (prio=0)
Packet Queued: 0
Queue Size
: 63
*****************************

Configuring ATMCLP
The user defines an ATMCLP policy and then assigns relative priorities in the range 0 (highest) to
63 (lowest priority) to traffic packets, based on their DSCP values.
The policy is then associated to an interface and a direction.

ATMCLP Node
ATOS\qos\atmclp>>add ?
add command parameters:
policy
<policy name>
association <association name> <policy name> <interface name>

Table 194: add policy


Syntax

Description

policy name

The name of the policy being created is identified by an


alphanumeric string with a maximum of 20 characters.

Table 195: add association


Sintax

Description

association name

The name of the association being created is identified by an


alphanumeric string with a maximum of 20 characters.

ATOS User Guide


Quality of Service - 234 / 483

policy name

Name of an already configured policy.

interface name

Name of the interface to bind to the policy.

ATMCLP policy Commands


ATOS\qos\atmclp\MY_ATM_POLICY>>add ?
add command parameters:
<dscp value> <precedence value> <marking value>

Table 196: add


Sintax

Description

dscp value

A value that identifies the DiffServ code point, the range is between
0 and 63 included

precedence value

Value associated to a data flow precedence level, the range is


included between 0 (highest precedence) and 63 (lowest
precedence).
Traffic flow with precedence value = 0 will be never marked.

marking value

Value used to mark a packet, the range is between 0 and 63


included. For ATM interfaces only the value 1 is allowed.

ATOS\qos\atmclp\MY_ATM_POLICY>>set ?
Nodes not available.
Set command parameters:
mcr <value>
mbs <value>

Table 197: set


Sintax

Description

mcr <value>

Configure the MCR (Maximum Cell Rate) value, in cells/sec, in the


range 0 to 65535. Default 100 cell/sec

mbs <value>

Configure the MBS (Maximum Burst Size) value, in cells/sec, in


the range 0 to 65535. Default 100/sec

ATOS\qos\atmclp\MY_ATM_POLICY>>del ?
del command parameters:
<dscp value>

ATOS User Guide


Quality of Service - 235 / 483

An ATMCLP configuration example


This paragraph shows an example of a Level 2 QoS configuration.
ATOS>>qos atmclp
ATOS\qos\atmclp>>show conf
No level 2 policy added
No level 2 association added

Start at the ATOS\qos\atmclp>> node. Initially there are neither policies nor associations
added;

ATOS\qos\atmclp>>add policy MY_ATM_POLICY

the MY_ATM_POLICY is now created;


ATOS\qos\atmclp\MY_ATM_POLICY>>show conf
Show of ATOS qos level2 MY_ATM_POLICY
Max rate (Kbps) : 0
No condition list

set the MCR to 500 cells/s and MBS to 250 cell/s;

ATOS\qos\atmclp\MY_ATM_POLICY>>set mcr 500


ATOS\qos\atmclp\MY_ATM_POLICY>>set mbs 250

add a privileged class for DSCP = 46 (priority = 0, mark value = 1);

ATOS\qos\atmclp\MY_ATM_POLICY>>add 46 0 1

add other classes for DSCP 26 (priority 1), 20 (priority 2) and 14 (priority 3).

ATOS User Guide


Quality of Service - 236 / 483

ATOS\qos\atmclp\MY_ATM_POLICY>>add 26 1 1
ATOS\qos\atmclp\MY_ATM_POLICY>>add 20 2 1
ATOS\qos\atmclp\MY_ATM_POLICY>>add 14 3 1

Now review the configuration:


ATOS\qos\atmclp\MY_ATM_POLICY>>show conf
Show of ATOS qos level2 MY_ATM_POLICY
Max Cell Rate (cell/s) : 500
Max Burst Size (cell(s) : 250
Condition list
dscp
priority marking
46
0
1
26
1
1
20
2
1
14
3
1

Finally, associate this policy to an interface (ex: ATM_VCO):

ATOS\qos\atmclp>>add association MY_ATM_ASSOCIATION MY_ATM_POLICY


atm_vc0

Level2 Qos is running, statistics and status are now available:


ATOS\qos\atmclp\MY_ATM_ASSOCIATION>>show statistics
Level2 policy : MY_ATM_ASSOCIATION
Flow DSCP=0 (prio = 64)
0 cells processed
0 cells marked with value 1
Flow DSCP=14 (prio = 3)
0 cells processed
0 cells marked with value 1
Flow DSCP=20 (prio = 2)
0 cells processed
0 cells marked with value 1
Flow DSCP=26 (prio = 1)
0 cells processed
0 cells marked with value 1
Flow DSCP=46 (prio = 0)
0 cells processed
0 cells marked with value 1

ATOS\qos\atmclp\MY_ATM_ASSOCIATION>>show status
Level2 policy : MY_ATM_ASSOCIATION
- MCR (cell/s): 500
- MBS (cell/s): 250
*****************
Bucket Prio = 64:
- Size = 0.

ATOS User Guide


Quality of Service - 237 / 483

- Penalties = 0.
*****************
Bucket Prio = 3:
- Size = 0.
- Penalties = 0.
*****************
Bucket Prio = 2:
- Size = 0.
- Penalties = 0.
*****************
Bucket Prio = 1:
- Size = 0.
- Penalties = 0.
*****************
Bucket Prio = 0:
- Size = 0.
- Penalties = 0.

ATOS User Guide


RAC - 238 / 483

RAC
The RAC (Remote Access Configuration) node is used to create profiles that allow ATOS to act as
Authentication Server. You can define groups of users (associating multiple pairs of username and
password to every group) and address ranges that can be used by a PPP module to assign them to
clients, if requested.

RAC Nodes
Account - Commands
This profile configures the system with a dynamic account list (with multiple username and
passwords for every account). If the device is configured as access server, it can authenticate the
clients identified with username and password in the list.

ATOS\rac\account>>add ?
Add command parameters:
<group name string><user name string><password string>
[<user|admin|superadmin>]
ATOS\rac\account>>del ?
Del command parameters:
<group name string><user name string>

Table 198: add - del


Syntax

Description

group name string

Enter the account group name, max 20 characters.

user name string

Enter the username, max 40 characters.

password string

Enter the user password, max 40 characters.

[<user|admin|superadmin>]

Optional parameter that indicates the access level; default =


admin.

If configured as server, the system can use one account group only.

ATOS User Guide


RAC - 239 / 483

Address Commands
This profile configures the system with a dynamic list of IP address pools (defined by the initial and
final addresses in the range). If the device is configured as access server, it can release the IP
addresses in the list to the clients.

ATOS\rac\address>>add ?
Add command parameters:
<pool name string><start address value (a.b.c.d)>
<end address value (a.b.c.d)>
ATOS\rac\address>>add
ATOS\rac\address>>del ?
del command parameters:
<pool name string>
ATOS\rac\address>>del

Table 199: add - del


Syntax

Description

pool name string

Enter the name of the IP address pool, max 20 characters.

start ip add

Enter the first IP address in the range.

end ip add

Enter the last IP address in the range.

If configured as server, the system can use only address pool only.

ATOS User Guide


SDSL - 240 / 483

SDSL
In Aethra devices with SHDSL (Single-pair High-speed Digital Subscriber Line) interfaces, ATOS
permits the configuration of some physical level parameters.
ATOS>>sdsl

SDSL Commands
The following configuration commands are available in the sdsl node:
ATOS\sdsl>>set ?
Nodes not available.
Set command parameters:
loglevel <value>
maxrate
<value>
minrate
<value>
rate2312 <on|off>
mode
<stu-r|stu-c>
4wire
<off|on>
eoc
<on|off>
dyinggasp <on|off>
annex
<a|b>
adaptive <on|off>
margin
<value>

Table 6: set
Syntax

Description

maxrate <value>

Set available SHDSL connection rate range: acceptable values are


all entire numbers between 3 (192 kbps) and 36 (2304 kbps).

minrate <value>

Default values: MINRATE = 3, MAXRATE = 36.


Adaptive function (PMMS) is NOT available.
rate2312 <on|off>

If MAXRATE = 36 and 4WIRE = OFF, this parameter


enables/disable an SHDS connection to reach a 2312 kbps rate:
(default value = OFF).

mode <stu-r|stu-c>

Set SHDSL interface type:


STU-R = CPE;
STU-C = CO (like a DSLAM SHDSL port).
Default value: STU-R.

4wire <off|on>

Disables/enable SHDSL 4-wire mode.1 (default on)

Command available in devices with 4-wire SHDSL interface only.

ATOS User Guide


SDSL - 241 / 483

eoc <on|off>

Enable/disable EOC messages management (Embedded Operation


Channel); default value = ON.

dyinggasp <on|off>

Enable/disable EOC message sending when power supply is


switched off; default value = ON.

annex <a|b>

Set ITU G.991.2 Annex type:


a = Annex A (American standard);
b = Annex B (European standard).
Default value = b.

adaptive

<on|off>

Enable/disable the shdsl Rate Adaptive mode

margin

<value>

If the Rate Adaptive mode is enable, a noise margin value can be


defined that is the minimum accettable margin for that link.
(0 10 db, default 0 db)

SDSL Diagnostic Commands


The following diagnostic commands are available in the sdsl node:
Table 7: diagnostics commands
Syntax

Description

loopb <speed>

Activate a sham SHDSL connection of speed rate: upstream data


will not be sent towards the network, but will be sent back towards
the user (local loop).
Speed is in kbps: acceptable values are all entire numbers
between and including 192 and 2304 (by step of 64) or 2312.
If speed = 0, loopb will be disabled.

loopc <on|off>

Enable/disable, if SHDSL connection is up, a digital loop:


downstream data will be forwarded towards the user and it will
send back towards the network too (remote loop).
User upstream data will not sent towards the network.

ATOS User Guide


Security - 242 / 483

Security
Introduction
IPSec is a suite of protocols used to create secure VPNs on the public network (tunnel mode) or
to provide secure end-to-end connections (transport mode) between pairs of hosts.
IPSec provides security services to the set of IP protocols, including all the higher level protocols,
by offering the following services:
data integrity;
data origin authentication;
replay protection;
confidentiality.
A number of information structures are necessary for IPSec to operate.
A Security Association (SA) defines an IPSec connection. An SA is a kind of contract between the
two endpoints, which contains the security policy that applies to some specific type of traffic sent
or received by either endpoint. SAs are unidirectional in nature, so different SAs may apply in
either direction.
An IPSEC implementation manages a Security Association Database (SAD). Each entry in the
SAD contains the information necessary to describe a specific SA (the encapsulation protocol to be
used, a number of fields used to provide protection to anti-replay attacks, the authentication and the
encryption algorithms used with the relevant cryptographic keys and initialization vectors). Each
SA is identified with a Security Parameter Index (SPI).
An IPSec entity also manages a Security Policy Database (SPD). An entry in the SPD describes a
specific traffic flow using a number of Selector Fields (source and destination address, source
destination protocol, protocol type, etc.) and points to an entry in the SDB.
Each individual outbound packet is checked against the SPD. A matching SPD entry contains a
pointer to the SA that must be applied to that packet.
The SPI field is always transmitted in the clear and it is used to identify the SA applicable to
incoming packets. Once the SA is identified, the packet can be properly processed (removal of
security encapsulation, decryption, authentication and integrity checks, etc.).
An SA can be either manually configured or, if a matching SPD entry does not contain a valid SA
pointer, the applicable SA can be automatically negotiated between the two peers using the IKE1
protocols.
IPSec encapsulates traffic using the Authentication Header Protocol (AH)2 or the Encapsulating
Security Payload Protocol (ESP)3.
These two encapsulations can be cascaded in order to have IPSec connections with a combination
of security features.

Internet Key Exchange Protocol, rfc. 2409.

IP Authentication Header, rfc. 2402.

IP Encapsulating Security Payload, rfc. 2406.

ATOS User Guide


Security - 243 / 483

IPSec operating modes


The IPSec "Transport" mode is typically used to provide a secure end-to-end connection between
two hosts. Each packet is encapsulated based on the security protocol (AH or ESP) indicated in the
relevant SP.

Figure 1 Transport mode

The AH protocol inserts an AH header after the existing IP header. The AH header contains an SPI,
and the information used to authenticate the whole packet. The existing IP payload and some fields
in the IP header are not modified. However, a number of fields in the IP header may change during
the packet transport. These "mutable" fields cannot be included in the authentication process.
The ESP encapsulation inserts an ESP header after the existing IP header, with an SPI. The IP
payload may be encrypted and is followed by an ESP trailer, that contains information used to
authenticate the whole packet.
The Tunnel mode is typically configured between two gateways, named security gateways. The
original packet generated by a host behind a gateway is encapsulated with an "outer" IP header
containing the addresses the two security gateways. The AH and the ESP headers are inserted after
the "outer" IP header. An optional ESP trailer may follow the IP payload.
In the tunnel mode with ESP the whole "inner" IP packet is encrypted, thus also hiding any
information contained in the IP header of the original packet.

Figure 2 Tunnel mode

Starting from version 2.0, ATOS provides support to the "tunnel" mode only.

ATOS User Guide


Security - 244 / 483

Security protocols: AH and ESP


The AH protocol guarantees:
integrity by detecting unauthorized changes in the packet header and independently from packets
ordering in the message;
authentication by verifying the sender identity.
The ESP protocol operates in three distinct modes: authentication and encryption, authentication
only, encryption only.
Table 200 summarizes the configurations allowed for AH and ESP protocols:
Table 200: ATOS modes and algorithms for AH and ESP protocols
Protocol
AH
ESP

Mode

Hash Algorithm
4

tunnel
tunnel

Cipher Algorithm

MD5 , SHA-1

MD5, SHA-1, NULL

DES , 3DES8, NULL9

Security Associations
A Security Association (SA) is a unidirectional logical connection that provides security to traffic.
Each peer must define two SAs for each IPSec connection, one for the incoming packets (inbound
SA) and one for the outgoing ones (outbound SA). Thus, an IPSec connection has a total of four
SAs.
The most significant parameters in an SA are:
security protocol (AH or ESP);
hash algorithm;
cipher algorithm (for ESP only);
keys used for authentication and encryption;
time to live;
IP addresses of the two peers (in the tunnel mode, the public IP addresses of the two security
gateways);
the SPI (Security Parameter Index), a 32-bit number that, together with the authentication protocol
and the destination IP address is used to unambiguously identify an SA.
These parameters can be either manually configured or automatically negotiated between the peers.
IKE is used in ATOS to implement the automatic mode.

The Use of HMAC-MD5-96 within ESP and AH, rfc. 2403.

The Use of HMAC-SHA-1-96 within ESP and AH, rfc. 2404.

In the ESP protocol the authentication attribute may be 0 (NULL). In this case the ESP protocol only provides integrity
and confidentiality services (rfc 2406, paragrafo 2.7).
7

The ESP DES-CBC Chiper Algorithm With Explicit IV, rfc. 2405.

The ESP CBC-Mode Cipher Algorithms, rfc. 2451.

The NULL Encryption Algorithm and Its Use With Ipsec, rfc. 2410.

ATOS User Guide


Security - 245 / 483

Security Policy
A Security Policy (SP) describes how IPSec processes a specific packets.
Selector fields10 in each packet are used to select an SP. The selected SP determines if the packet
must be discarded, transparently forwarded or if a Security Association in the SAD applies to this
packet. If the selected SP does not refer to an existing SA, then IKE comes into play to negotiate an
SA for this policy.

IKE protocol
ATOS uses the IKE protocol to exchange keys and to configure the SA between the peers in
automatic mode.
IKE has its own policy settings (a set of "protection suites" in order of preference) which is used to
build an IKE Security Association. An IKE protection suite includes encryption and authentication
algorithms, Diffie-Hellman group, a method of authentication and an optional lifetime.
During Phase 1, the two peers negotiate a protection suite to build the IKE SA, then create a
common secret using a Diffie-Hellman exchange, and finally authenticate each other's material and
identity using the hash algorithm and the authentication method determined during the IKE SA
negotiation.
During phase 2, the two peers use the IKE SA to negotiate IPSEC SAs. Multiple Phase 2
negotiations can use the "underlying" IKE SA to establish the required IPSEC SAs. The IKE SA
remains active and is used to exchange connection management messages (SA time-to-live, SA
cancellation, etc.) until its lifetime expires or an external event causes its termination.

IKE Operation
IKE it is an hybrid protocol that supports 3 standards: ISAKMP, Oakley and Skeme.
ATOS uses the following algorithms and methods in its IKE implementation:
symmetric ("bulk") coding algorithms
DES/3DES in CBC11 mode
asymmetric ("public key") coding algorithms
Diffie-Hellman12
authentication methods
pre-shared key (PSK): the two peers share a secret key for received messages authentication

10

Selector fields include source/destination IP address, transport protocol type, etc., as extracted from the IP packet during
the routing process.

11
12

Schneier, B., "Applied Cryptography Second Edition", John Wiley & Sons, New York, NY, 1996. ISBN 0-471- 12845-7.

Diffie, W., and Hellman M., "New Directions in Cryptography", IEEE Transactions on Information Theory, V. IT-22, n.
6, June 1977.

ATOS User Guide


Security - 246 / 483

hash algorithms
MD513 in H-MAC14 version
SHA15 in H-MAC version
The IKE protocol operates in two phases.
During phase 1 the two peers establish a secure channel to communicate with, for which they agree
upon cipher algorithm, hash algorithm, keys, etc. This set of negotiated algorithms and keys is
named IKE Security Association (IKE SA).
Phase 1 can be realized in two Main and in Aggressive Mode, according to the required security
level. Both modes can use preshared keys, digital signatures or Public Key Encryption. ATOS
supports Main Mode and Aggressive modes with Pre-Shared Keys (PSK).
Phase 2 is used to negotiate parameters for an IPSEC SA. Phase 2 only supports a Quick Mode.

Phase 1 Main Mode with Preshared Keys


This mode (implemented from version 2.0) consists of a 6 message exchange between the initiator
(the peer which starts the session and sends the first message) and the responder (the peer which
receives a request for starting IKE traffic).
A description of messages for a main mode phase 1 exchange with pre-shared keys is included
below.
Message 1: the initiator proposes one or more protections suites for the IKE SA which is being
established. When Pre-Shared Keys are used, either peer knows in advance a piece of information
related to the other peer. This is usually associated to the peers IP address, as this is the only
known information on the peer when the phase1 exchange is started.
Message 2: the responder selects a protection suite for the IKE SA.
Messages 3-4: the two peer exchange their Diffie-Hellman public keys and NONCEs (random
numbers). Either peer then computes keying material using the NONCEs, the DH keys and the preshared secret. These keys are used for encrypting and authenticating messages in this IKE SA and
to generate further keying material on subsequent IPSEC SA
Messages 5-6 are exchanged to mutually verify the peer identity. These messages contain an
encrypted peer's ID and a hash built using the preshared key, the D-H keys, and the a part of the
content of previously exchanged messages. These messages authenticates the remote peer's identity
by proofing that it knows the pre-shared key, has correctly derived the DH key, and implicitly
confirms that the correct hash and encryption algorithms are known.
At this point the IKE SA is established and can be used for Phase 2 exchanges to establish IPSEC
SAs to carry the user's traffic.

13

The MD5 Message-Digest Algorithm, rfc. 1321.

14

HMAC: Keyed- Hashing forMessage Authentication, rfc. 2104.

15

NIST, "Secure Hash Standard", FIPS 180-1, National Institue of Standards and Technology, U.S. Department of
Commerce, May 1994.

ATOS User Guide


Security - 247 / 483

Phase 2 Aggressive Mode


This mode (implemented from version 2.2) consists of a 3-message exchange. This greater
efficiency is traded-off with less security, as the peers identity are not protected as when using a
main mode phase1 exchange.
As the initiatior's ID is transmitted in the initial message, the responder has the capability to select a
PSK based on the initiator's ID, and not only on the remote IP address, as in the main mode.
For this reason, the aggressive mode is applicable in a scenario where the initiator ("road warrior")
attempts to establish IPSec connections from different locations and may be using different
(dynamically assigned) IP addresses.
A description of messages for an aggressive mode phase 1 exchange with pre-shared keys is
included below.
Message 1: the initiator indicates the proposed protections suites for the IKE SA being built,
followed by a public DH key, a random NONCE value and its ID value (note that, opposite to the
Main Mode, the ID is sent as cleartext)
Message 2: the responder selects a protection suite for the IKE SA and transmits a DH public key,
a NONCE, its ID value and a hash value to authenticate the negotiation.
Message 3: the initiator validates the negotiation sending its hash value.

Phase 3 Quick Mode


The Quick mode is the used for phase 2 exchanges, after an IKE SA has been successfully
established. It consists of 3 messages encrypted using the IKE SA. Either peers can start a Quick
Mode negotiation.
A description of the messages used in a Quick Mode Phase 2 exchange is included below.
Message 1: the initiator sends a list of proposed IPSEC SAs, a hash value to authenticate the
message and a NONCE. Additional information can be optionally added to this message, such an
ID value and a new public DH key (otherwise the DH keys from phase 1 are used in the IPSEC SA
being created).
Message 2: the responder selects an IPSec SA among those proposed by the initiator, then it sends
its NONCE value and authenticates the message with a hash. If message 1 contains extra
information, the responder adds the corresponding information to this message (e.g. a new public
DH key).
Message 3: the initiator sends a new hash to the responder to confirm that the negotiation has been
successfully completed.

IKE-based Connection Maintenance


IKE allows two peers to exchange messages to signal incorrect or strange behaviours, by the use of
asynchronous ISAKMP messages, either encrypted with Phase 1 IKE SA or sent as cleartext if
phase 1 has not completed yet.

ATOS User Guide


Security - 248 / 483

Starting from version 2.0, ATOS implements the Delete Informational Exchange message: this
message it sent when an ISAKMP session (and consequently all the IPSec channels active on this
session) is removed.

Security - Nodes
ATOS\security>>?
Nodes available:
ike
ipsec
crypto
The security node has 3 subnodes: ike, ipsec, crypto.
The ike node defines policies ("protection suites") used by IKE and establishes Pre-Shared Keys.
The ipsec node creates and configures abstract IPSec policies (security protocol, authentication
and encryption algorithm, lifetime). These policy "templates" are then used to create a database of
policies in the crypto node.
The crypto node instantiates IPSEC Policies by creating associations between the abstract
policies defined in the ipsec node and specific traffic streams, defined in terms of an interface
and a number of traffic selectors (IP addresses, protocol type) contained in an access list. Policies
defined in this node actually represent entries in the Security Policy Database (SPD).

Ike - Commands
ATOS\security\ike>>set ?
Nodes not available16.
Set command parameters:
loglevel <value>
ATOS\security\ike>>add ?
add command parameters:
key <name><key value string><remote ip address><net mask>
key <name><key value string>all-address
policy <name><priority value>

A new PSK is added using the following command:

16

Previously created dynamic nodes may be present here.

ATOS User Guide


Security - 249 / 483

ATOS\security\ike>>add key <name> <key value string> <remote ip


address> <net mask>

Table 201: add key


Syntax

Description

name

a name for the PSK being added

key value string

the PSK

remote ip address

defines an IP address associated to this PSK

net mask

the range of addresses associated to this PSK.

The key is used to authenticate the negotiation with peers in a range of IP addresses, as specified in
the <remote IP address> and the <net mask> parameters.
For example, the use of the new key for a single IP address in the field <remote IP
address> requires a <net mask> set to 255.255.255.255.
It is possible to configure a key for any peer (independently from the IP address) using an alladdress clause, as shown here:
ATOS\security\ike>>add key <name><key value string>all-address
Table 202: add keyall-address policy
Syntax

Description

name

New key name.

key value string

Sting for key value.

A single key must be configured for a specific address or address range .


Only one ALL-ADDRESS key type is configurable.
If an ALL-ADDRESS key is present, that key will be applied to all peer.

PSKs can be added or deleted but never modified. To delete a key, use the command:
ATOS\security\IKE>>del key <name>
Table 203: del key
Syntax

Description

name

Name of the key to remove.

ATOS User Guide


Security - 250 / 483

A key in use cannot be deleted. This happens if an existing IPSec connection exists on top of the
IKE connection that uses this key.

The following command creates an IKE policy and assigns a name and a priority to it:
ATOS\security\ike>>add policy <name> <priority value>

Table 204: add policy


Syntax

Description

name

New policy name.

priority value

Priority associated to the new policy.

The initiator will list the proposed IKE SAs in the initial Phase 1 message in decreasing order of
<priority value>. The value 1 indicates here the highest priority. The responder will then
pick up the first IKE SA supported in the list proposed by the initiator.
To delete an IKE policy, use the command:
ATOS\security\ike>>del policy <name>
Table 205: del policy
Syntax

Description

name

Name of the policy to be deleted.

The following command shows all the active IKE sessions, displaying sessions status and the name
of associated crypto:
ATOS\security\ike>>show status
An IPSec tunnel can be removed from configuration using command
ATOS\security\ike>>remove-session <name>

ATOS User Guide


Security - 251 / 483

Table 206: remove-session


Syntax

Description

name

Name of the session to be removed.

MY_IKEPOLICY Commands
After creating an IKE policy named MY_IKEPOLICY with priority 1:
ATOS\security\ike>>add policy MY_IKEPOLICY 1
then you can define a "protection suite" for this IKE policy:
ATOS\security\ike\MY_IKEPOLICY>>set ?
Nodes not available.
Set command parameters:
authentication <pre-share>
group
<1|2|5>
hash
<md5|sha1>
encryption
<des|3des|aes|aes-192|aes-256 >
life-time
<value>

Table 207: set


Syntax

Description

authentication <pre-share>

The authentication method.

group <1|2|5>

The Diffie-Hellman group used to DH keys, default value: 5.

hash <md5|sha1>

The HMAC authentication algorithm, MD-5 (default) or


SHA-1.

Encryption

the bulk encryption algorithm: DES, 3DES (default), aes


(128), aes-192, aes-256. The aes encryption algorithm are
available only if the encryprion HW component is present and
enabled by the appropriate license file.

<des|3des|aes|aes-192|aes-256>
life-time <value>

The time to live, in seconds, for an IKE SA associated to this


policy. The default value is 28800 sec.

Two or more policies cannot be configured with the same name or the same priority level.

ATOS User Guide


Security - 252 / 483

IPSec - Commands
ATOS\security\ipsec>>set ?
Nodes not available.
Set command parameters:
loglevel <value>
ATOS\security\ipsec>>add(/del) ?
add command parameters:
<policy name>

Table 208: add/del policy


Syntax

Description

policy name

IPSec policy name.

A running policy (in use by an active IPSec connection) cannot be deleted or modified

MY_IPSECPOLICY - Commands
An example of adding an IPSec policy called MY_IPSECPOLICY:
ATOS\security\ipsec>>add MY_IPSECPOLICY
ATOS\security\ipsec\MY_IPSECPOLICY>> set ?
Nodes not available.
Set command parameters:
protocol
<ah|esp>
authentication <md5|sha1|none>
encryption
<des|3des|aes|aes-192|aes-256|none>
life-value
<value>

ATOS User Guide


Security - 253 / 483

Table 209: set


Syntax

Description

protocol <ah|esp>

The security protocol associated to this policy. ESP default.

authentication <md5|sha1|none>

The HMAC authentication algorithm: MD-5 (default), SHA-1


or none.

Encryption

the bulk encryption algorithm: DES, 3DES (default), aes


(128), aes-192, aes-256 or none. The aes encryption algorithm
are available only if the encryprion HW component is present
and enabled by the appropriate license file.

<des|3des|aes|aes-192|aes-256>
life-time <value>

The time to live, in seconds, for an SA associated to this


policy. Default value is 28800 sec.

Two or more policies cannot have the same name.


When AH is selected as the security protocol, the encryption parameter disappears from the node,
and the only the md5 or sha1 can be assigned to the authentication parameter.
When ESP is selected as the security protocol, it is not allowed to specify none for both the
authentication and the encryption parameter.

Crypto Commands
The crypto node instantiates IPSEC policies based on the template policies created in the IPSEC
node.
ATOS\security\crypto>>add(/del) ?
add command parameters:
<crypto profile_name>

Table 210: add/del policy


Syntax

Description

crypto profile_name

Crypto name.

MY-CRYPTOPOLICY - Commands
ATOS\security\crypto>>add MY-CRYPTOPOLICY

Opposite to IKE and IPSec policies, no default parameter is specified in a newly created profile.

ATOS User Guide


Security - 254 / 483

ATOS\security\ipsec\MY-CRYPTOPOLICY>>add(/del) ?
add command parameters:
add command parameters:
<policy name><peer ip addr><Access List name>[<local ip addr>][<PFSparam>]
<policy name> LIST:
policy-ipsec
<Access List name> LIST:
Acl-ipsec
<PFS-param> LIST:
disable
PFS-group1
PFS-group2
PFS-group5

Table 211: add/del


Syntax

Description

policy name

Identify IPSec policy name previously configured.

peer ip addr

Configure the peer IP address for the IPSec connection (a valid key
with the same IP address should be previously configured).

Access List name

Identify Access List name (previously configured) that defines


which traffic, from/to a peer specified in <ip addr peer> field,
encapsulate with IPSec. Until now it was named security policy.

Local ip address

Configure the Ip address used as source/destination for outgoing


and ingoing packets.
The IP address must be present on one of the interface available,
created before (i.e. loopback).

PFS-param

PSF-param allows to select the type of Diffie-Hellman exchange to


use during the first phase of IKE-MainMode, or in the second
phase of IKE-QuickMode:
None = disable
PFS-group1
PFS-group2
PFS-group5

ATOS\security\ipsec\MY-CRYPTOPOLICY>>set ?
Nodes not available.
Set command parameters:
interface
<string: no-ifc-associated|LAN0|ATM_VC0|
ATM_VC1|ATM_VC2|ATM_VC3|ATM_VC4|ATM_VC5|
ATM_VC6|ATM_VC7|ATM_VC8|ATM_VC9|LOOPBK0>

ATOS User Guide


Security - 255 / 483

alternative-local-id <ip addr>

Table 212: set


Syntax

Description

interface

Identify the interface name for the crypto profile. This is the last
parameter because once it is associated to an interface, all the traffic
through that interface will be processed by crypto. Default value is
no-ifc-associated.

<string: no-ifcassociated|LAN0|ATM_VC0|
ATM_VC1|ATM_VC2|ATM_VC3|
ATM_VC4|ATM_VC5|ATM_VC6|
ATM_VC7|ATM_VC8|ATM_VC9|
LOOPBK0>
alternative-local-id
<ip addr>

Parameter used to create IPSec connection on interfaces behind


NAT application. When an interface associated to crypto has an IP
address replaced by NAT, this parameter has to be the NAT
address. Vice versa, when the interface has a public IP address,
alternative-local-id <ip addr> must be 0.0.0.0
(default value).

Once the interface_name parameter has been configured, all the traffic on the specified
interface will be processed by crypto MY-CRYPTOPOLICY.
Before to modify a key, an IPSec policy or an access list it is necessary to disable the connection
into MY-CRYPTOPOLICY node, assigning to interface name parameter the no-ifcassociated value. The same to add or remove connections. If the Crypto control is already
runnig (that is at least an IPSec tunnel is active) It is necessary to close tunnels (with removesession command on ike node) before disable the connection.

Example
Suppose we want to create an IPSec tunnel between the local system and a remote gateway with
address 1.2.3.4, and to use this tunnel to carry all the traffic between a "local" network
10.0.0.0/2417 and a remote network 11.0.0.0/24.
The tunnel will be locally terminated at the ATM_VC0 interface, which has the public address
5.6.7.8. The ATM_VC0 interface is the default gateway, and both 1.2.3.4 and 11.0.0.0/24 are
reachable (based on the content of the routing table) through that interface.
Use two IKE and IPSec policies with values different from defaults, use the pre-shared key prova.
First configure an access list defining the traffic between 10.0.0.0/24 and 11.0.0.0/24

17

this notation is used to represent the address range 10.0.0.0 through 10.0.0.255

ATOS User Guide


Security - 256 / 483

ATOS>>accesslist
ATOS\accesslist>>add MY-ACL permit anyprot 10.0.0.0 0.255.255.255
11.0.0.0 0.255.255.255

Then, from within ike, create an IKE policy named IKEPOLICY-1 and define a Pre-Shared Key
(t&rHf%9y) to be used for connections to the remote gateway (1.2.3.4)
ATOS\security>>ike
ATOS\security\ike>>
ATOS\security\ike>>add policy IKEPOLICY-1
ATOS\security\ike>>
ATOS\security\ike>>add key KEYname t&rHf%9y 1.2.3.4 255.255.255.255

Then configure the authentication protocol, the DH group, the hash and the encryption algorithm
and lifetime used for IKEPOLICY-1.
In the ipsec node create an abstract IPSEC policy, MY-IPSECPOLICY:

ATOS\security\ipsec>>add MY-IPSECPOLICY

and then configure a security protocol, an authentication and an encryption algorithm and the
lifetime for this policy.
Finally in the cripto node, build a IPSEC policy by connecting MY-IPSECPOLICY to an
interface and to an access list, specifying the traffic selectors for this policy:
ATOS\security\ipsec>>up
ATOS\security>>
ATOS\security>>cripto
ATOS\security\cripto>>add MY-CRYPTO
ATOS\security\cripto>> MY-CRYPTO
ATOS\security\cripto\MY-CRYPTO>>add MY-IPSECPOLICY 1.2.3.4 MY-ACL
ATOS\security\cripto\MY-CRYPTO>>set interface ATM_VC0

The MY-CRYPTOPOLICY crypto is now active.


Any traffic originated from network 10.0.0.0/24 and destined to 11.0.0.0 /24 will invoke IKE.
IKE will use the IKEPOLICY-1 to create a an IPSEC SA (actually an IPSEC "tunnel") between the
remote gateway (1.2.3.4) and the local gateway (5.6.7.8). that will securely transport the traffic
between the two subnets.

ATOS User Guide


SDSL - 257 / 483

SNMP
The SNMP (Simple Network Management Protocol) permits management of Aethra devices
through a remote SNMP manager. The SNMP agent software allows to monitor some statistic
parameters and change the device configuration according to the results. Aethra devices implement
SNMPv11 and SNMPv2C2, which allow the remote manager to manage the objects represented in
the structures defined in the MIB-23.

SNMP Commands
ATOS\snmp>>set ?
Nodes not available.
Set command parameters:
<ON|OFF>
AUTHENTICATION_TRAP
MANAGER
ALTERNATIVEMANAGER
LOCAL IP ADDRESS
SYSCONTACT
SYSLOCATION
ENABLE_WRITE_MESSAGE
LOGLEVEL

<ON|OFF>
<ip addr>
<ip addr>
<ip addr>
<string>
<string>
<ON|OFF>
<value> [-s]

Table 213: set


Syntax

Description

<on|off>

Activate/deactivate the SNMP service. Default: off.

authentication_trap
<on|off>

Activate/deactivate the TRAP authentication messages sent to the


Manager by the Agent when the authentication procedure fails
(default: on).

manager <ip addr>

IP address of the SNMP Manager (default: 0.0.0.0).

alternativemanager
<ip addr>

IP address of the alternative SNMP Manager (default: 0.0.0.0).

local-ipaddress <ip addr>

Configure the SNMP-agent IP address. This address can be view


by sending trap only (default: 0.0.0.0).

syscontact <string>

Set the contact of the device manager. You can use an e-mail
address, IP address or Internet site (default: null), max 64
characters.

syslocation <string>

Set the geographical location of the Aethra device (default: null),


max 64 characters.

Rfc.1157.

Rfc1901.

Rfc.1155, rfc.1213.

ATOS User Guide


SNMP - 258 / 483

enable_write_message
<on|off>

Enable / disable snmp messages processing (default off)

loglevel <value> [-s]

Set the detail level used by ATOS to record SNMP events (default
1).

ATOS\snmp>>add ?
add command parameters:
<community name> [RO|RW (RO=default)]
ATOS\Snmp>>del ?
del command parameters:
<community name>

Table 214: add - del


Syntax

Description

community_name

Set the name of the community enabled to read or read/write the


management parameters of the device, depending og the RO/RW
configuration. (max 32 characters)

RO|RW

RO = Read only
RW = Read and Write.

ATOS User Guide


Syslog - 259 / 483

Syslog
The increasing complexity of operating systems and applications suggested the development of
real-time monitoring systems that transmit and receive log messages from different processes
running on a host and subdivide them into categories. In this way a network administrator can
manage messages which have been already selected according to predefinite parameters.
Most operating systems adopt syslog as a monitoring system.
Syslog is an application that sends notification messages produced by running applications to a
syslog server. ATOS allows to display these messages also locally. The remote syslog server
typically stores messages in a database and/or forwards them to another server. the remote. The
syslog client does not receive any confirmation from the server about message reception.
Syslog uses the UDP protocol at port 514 as a transport layer.
Syslog messages includes the information described below.

Facility
This parameter indicates the facility that generated the message. ATOS manages the following
values:
Kernel messages;
User-level messages.

Severity
This parameter indicates the severity of the message. Allowed values for this parameter are:
Error : fatal errors for a correct system behaviour;
Warning : warning conditions that could cause a partial incorrect behaviour;
Notice : normal but significant conditions that do not affect the correct system behaviour;
Informational : informational messages;
Debug : debug-level messages.
Mapping between syslog severity levels and ATOS Severity values is shown here :
Error

E!

Warning

W1

Notice

W2

Informational

L1

Debug

L2

ATOS User Guide


Syslog - 260 / 483

Timestamp
This parameter indicates the local time referred to message creation.

Hostname
This parameter indicates the name of the device which generated the log.

Tag
This parameter indicates the name of the programm or application that genetated the message.

Content
This parameter contains the details of the message.

Syslog Commands
ATOS\syslog>>set ?
Nodes not available.
Set command parameters:
<on|off>
echo
<on|off>
server
<string>
loglevel
<value>
Nodes not available.
Set command parameters:
<on|off>
echo
<on|off>
server
<string>
syslog-port
<value>
facility
<kernel|user|mail|daemon|auth|syslog|lpr|news|
uucp|cron|system0|system1|system2|system3|
system4|system5|local0|local1|local2|local3|
local4|local5|local6|local7>
severity
<error|warning|notice|informational|debug>
local-ipaddress
<ip addr>
loglevel
<value>

ATOS User Guide


Syslog - 261 / 483

Table 215: set


Syntax

Description

on|off

Enable/disable the syslog client, default value: off

echo <on|off>

Enable/disable messages to be displayed on the console, default


value: off.

server [ip addr|name]

The IP address or the name of the receiving syslog server (default


null).

syslog-port <value>

Identify the udp port used to receive the syslog message (default
514).

facility
<kernel|user|mail|daemon|
auth|syslog|lpr|news|uucp|
cron|system0|system1|
sytem2|system3|system4|
system5|local0|local1|
local2|local3|local4|
local5|local6|local7>

Configure the facility assigned to all the log messages generated by


the system. The defaul value is local4.

severity1
<error|warning|notice|
informational|debug>

Create a filter on the log severity. Starting from the one configured,
all the messages having an higher severity level are sent to the
server. The default value is debug; it means that all the log
messages generated by the system are forwarded to the server.

local-ipaddress <ip addr>

Configure the Syslog IP address (default 0.0.0.0).

loglevel <0-5>

Set the detail level used by ATOS to log the syslog events, default
value: 1.

An example for show conf command:


ATOS>>syslog
ATOS\syslog>>show conf
Show of ATOS syslog
SysLog enable : off
Local echo
: off
Syslog server : 192.168.110.233
Level of log
: 5

When local echo is off and syslog client is active, display of log messages on the console is forced
if the syslog server address is not configured or if the dsn client did not resolve its name.

Severity levels start from the lowest (debug) to the highest (error).

ATOS User Guide


LAN Interfaces - 262 / 483

PTM0 interface
The name Packet Transfer Mode (PTM) indicates its similarity with Asynchronous Transfer Mode
(ATM). VDSL2 provide an ethernet interface that is used as WAN
Within ATOS, a PTM0 interface is a communication interface, supporting bridging and routing
operation.
A logical interface is an abstract interface built on top an a LAN interface. All the traffic from and
to this logical LAN interface is actually transferred over the underlying PTM interface. The traffic
flows related to the different logical interfaces are differentiated at the IP level (i.e. different IP
subnets) or at the MAC level (using VLAN tagging). Creating logical interfaces does not prevent
direct access to the underlying PTM0 interface.

Bridging and Routing Engines

Logical Interface

Logical Interface
PTM0 Interface

xDSL

PTM0 interface can be configured also in PPPoE encapsulation.

PTM0 Commands
ATOS\ptm0>>set ?
Nodes available:
ip
bridgepar
Set command parameters:
<on|off>
loglevel
<value>
acl-in
<None>
acl-out
<None>
multicast-limit
<None>
bridging
<on|off>
prio-id-extension <on|off>
encapsulation
<None|PPPoE>

ATOS User Guide


LAN Interfaces - 263 / 483

StarVoice\ptm0>>add ?
add command parameters:
<logic LAN name string> [<vid> [<priority>]]
vid = 1-4094
priority = 0-7
Table 216: set
Syntax

Description

<on|off>

Enable/disable the LAN interface (default on).

loglevel <value>

Set the detail level <0-5> used by ATOS to log the events of the
PTM0 node. If you select the [-s] option, the configuration extends
to all subnodes of the current node.
Range: 1-5, default: 1.

bridging <on|off>

Activate/deactivate the bridging mode. [default: off]

multicast-limit <string>

Associate an access list previously created to outgoing multicast


traffic.

Acl-in

Name of the Access List created in the accesslist node for


incoming PTM0 packets.

Acl-out

<string>
<string>

Name of the Access List created in the accesslist node for


outgoing PTM0 packets.

prio-id-extension <on|off>

If this parameter is enabled, a vlan is identified by both VID and


priority values. [default: off]

encapsulation

Change the used encapsulation into PTM0 interface.:

<None|PPPoE>

None: no encapsulation is applied (the 802.3 ethernet


interface);

PPPoE: set the Point-to-Point over Ethernet encapsulation


mode. The public IP address is not static and is negotiated
every time you establish the connection with the ISP

PTM0 Nodes
IP - Commands
The IP parameters of the PTM0 (address and net mask) are configured in this subnode.
ATOS\ptm0\ip>>set ?
Nodes available:
rip
1

An access list can be associated to each interface to delimit traffic on that interface.

ATOS User Guide


LAN Interfaces - 264 / 483

nat
Set command parameters:
address
<ip addr>[/value]
netmask
<ip addr>
defaultrouter <ip addr>
napt
<on|off>
dhcp-client
<on|off>

Table 217: set


Syntax

Description

address
<ip addr>[/value]

Set IP the PTM0 IP address (default 0.0.0.0).

netmask <ip addr>

Set the PTM0 net mask (default: 0.0.0.0).

defaultrouter <ip addr>

Set the deafult router IP address (deafult 0.0.0.0)

napt <on|off>

Enable/disable napt on PTM0 interface. If this parameter is on, the


HTTP and Telnet management are not available from the PTM0
interface. To enable the management it is mandatory to open the
service HHTP and Telnet on the Napt\Proxy node [default: on]

dhcp-client <on|off>

Enable/disable dhcp-client on LANx interface. [default: off]

BridgePar Commands
The following commands can be used to configure the bridging parameters of the interface
(available only if bringing has been enabled into PTM0 node).
ATOS\ptm0\bridgepar>>set ?
Nodes not available.
Set command parameters:
<bridge1|bridge2|bridge3|bridge4>
priority
<value>
cost
<value>
flow-direction
<tx|rx|tx-rx|off>
vlan-out-mode2
<tag|transparent|untag>
vlan-in-mode
<tag|transparent|untag>
Table 218: set

Syntax

Description

<bridge1|bridge2|bridge3|
bridge4>

Set the bridging class associated with the interface. Configurable


values: bridge1 / bridge2 / bridge3 / bridge4.
Default: bridge1.

Command available in L2LogicLAN/BridgePar node only.

ATOS User Guide


LAN Interfaces - 265 / 483

priority <value>

Set the priority associated to the port. Range: 0~255, default: 128.

cost <value>

Set the cost associated to the bridge port. Range: 0~65535, default:
1000/line rate.

flow-direction

Set flow direction:

<tx|rx|tx-rx|off>

tx enable PTM0 interface to transmit bridge traffic,


rx enable PTM0 interface to receive bridge traffic,
tx-rx enable PTM0 interface to transmit and receive bridge
traffic,
off disable PTM0 interface to transmit and receive bridge traffic.
[default: tx-rx]

vlan-out-mode
<tag|transparent|untag>

Define the level 2 action to perform on outgoing packets:


tag option add the 802.1Q encapsulation,
transparent option forward packets without any change,
untag option remove, if present, the 802.1Q encapsulation.
[default: tag]

vlan-in-mode
<tag|transparent|untag>

Define the level 2 action to perform on incoming packets:


tag option add the 802.1Q encapsulation,
transparent option forward packets without any change,
untag option remove, if present, the 802.1Q encapsulation.
[default: untag]

LogicLANname - Commands
Logical LANs are dynamically created under the relevant PTM0 interface node. It is possible to
create up to 16 logic LAN.
If the optional vid3 parameter is present in the command line, the logical LAN interface acts as a
layer 2 Virtual LAN (VLAN) interface that can be connected across a Layer 2 bridge to other LAN,
VLAN or WAN interfaces.
Independently from the vid parameter, a Logical LAN interface can also operate as a network
interface for the routing engine. Once the logical LAN interface has an IP address and a network
mask configured, the routing engine will use this interface to forward IP packets destined to the
connected IP subnets, as it would for a physical PTM0 interface. If a null IP address is configured
(0.0.0.0) for this interface, then this interface will not receive or forward IP traffic.
ATOS\PTM0>>add ?
add command parameters:
<logic LAN name string> [<vid> [<priority>]]
vid = 1-4094

VLAN ID.

ATOS User Guide


LAN Interfaces - 266 / 483

priority = 0-7

Table 219: add LogicLAN


Syntax

Description

LogicLAN_name

Name of the subinterface to create.

vid

802.1Q vlan id; range: 1 - 4094

priority

802.1p bits, range: 0 - 7

Next, an example:
ATOS\PTM0>>add L2_LogicLAN 1 0
Command executed
ATOS\PTM0>>add L3_LogicLAN
Command executed

LANx L3_LogicLAN - Commands


ATOS\PTM0\L3_LogicLAN >>set ?
Nodes available:
ip
Set command parameters:
loglevel
<value>
acl-in
<string>
acl-out
<string>
The loglevel, acl-in and acl-out commands are similar to the equivalent commands in PTM0
interface.

PTM0 L3_LogicLAN Nodes


ATOS\PTM0\L3_LogicLAN>>tree
L3_LogicLAN
ip
rip
nat

The ip, rip and nat nodes are similar to the equivalent nodes in a PTM0 interface.

ATOS User Guide


LAN Interfaces - 267 / 483

PTM0 L2_LogicLAN - Commands


ATOS\PTM0\L2_LogicLAN >>set ?
Nodes available:
ip
bridgepar
vlan
Set command parameters:
<on|off>
loglevel
<value>
acl-in
<string>
acl-out
<string>
multicast-limit <string>
bridging
<on|off>
The loglevel, acl-in, acl-out, multicast-limit and bridging commands are similar to
the equivalent commands in PTM0 interface.

PTM0 L2_LogicLAN Nodes


ATOS\PTM0\L2_LogicLAN>>tree
L2_LogicLAN
ip
rip
nat
bridgepar
vlan

The ip, rip , nat and bridgepar nodes are similar to the equivalent nodes in a PTM0
interface.
The vlan node is used to display the current values of the 802.1q VLAN ID and the 802.1p
priority bits (e.g. using the show conf command) or to modify them.

ATOS\PTM0\L2_LogicLAN\vlan>>show conf
Show of ATOS Lan0 vlan1 vlan
vlan id
: 1
vlan priority : 0

ATOS\PTM0\L2_LogicLAN\vlan>>set ?
Set command parameters:

ATOS User Guide


LAN Interfaces - 268 / 483

vid
<value>
priority <value>
The vid and priority parameters use values described in table 117

PTM0 IP Nodes
Nat - Commands
The following commands are available for NAT configuration over LAN:
ATOS\PTM0\ip\nat>>set ?
Nodes not available.
Set command parameters:
address <ip addr>
alias
<string>

Table 220: set


Syntax

Description

address <ip add>

IP address for the NAT, as alternative to the IP address assigned to


the PTM0. If the parameter is configured, the source address of the
outgoing packets from the PTM0 interface is the parameter value.
[default: 0.0.0.0]

alias <string>

Alias name used in the PTM0 created in the NAPT\ALIAS node.

ATOS\PTM0\ip\nat>>add <ip add>

Table 221: add


Syntax

Description

ip add

Create a list of IP addresses that are ignored by the NAT operations.


Incoming and outgoing packets having one of the IP addresses
contained in the list in the destination and source field,
respectively, are ignored by the NAT operations.

ATOS\PTM0\ip\nat>>del <ip add>

Table 222: del


Syntax

Description

ATOS User Guide


LAN Interfaces - 269 / 483

ip add

Delete one entry from the list of IP addresses that are ignored by the
NAT operations.

RIP - Commands
ATOS uses the Routing Information Protocol (RIP) to exchange routing information with nearby
routers over WAN or LAN connections.
The following configurations are available for every WAN or LAN port:
ignore the incoming RIP traffic and avoid sending RIP datagrams (OFF);
send and receive RIP datagrams (BOTH);
receive RIP datagrams, acquiring information on the routing tables of nearby routers, without
sending the contents of the routing table (RECEIVE).
ATOS\PTM0\ip\rip>>set <off|both|receive>

RIP datagrams cannot be sent over connections with NAPT.

Table 223: set


Syntax

Description

off|both|receive

RIP operating mode (default: off):


off, the use of RIP is not enabled;
both, ATOS periodically sends the contents of its routing table
over RIP packets and uses the received RIP packets to update its
routing table (active RIP);
receive, ATOS uses the received RIP packets to update its
routing table without sending the contents of its routing table
(passive RIP).

ATOS can be configured to use version 1 or 2 of the RIP. You can select the V1-compatible mode,
where the RIP follows V2, without using multicast addresses. This allows the device to work with
routers supporting only RIP V1.
The information received from nearby routers is used to update the dynamic entries of the routing
table. If a dynamic entry of the routing table is not updated with RIP datagrams (typically after 180
seconds), the entry is deleted and the destination network is marked as not reachable.

ATOS User Guide


LAN Interfaces - 270 / 483

However, the entry is not immediately deleted from the routing table so that the next RIP datagram
sent by the device propagates the information to the other routers. The entry is deleted after a
certain time (typically 30 seconds).
ATOS\PTM0\ip\rip>>set version <v1|v2|v1compatible>

Table 224: set version


Syntax

Description

v1|v2|v1compatible

Set the RIP version:


v1, to use version 1;
v2, to use version 2;
v1compatible, to use version 2 without multicast addresses. The
device can work with routers supporting version 1 only.
[default: v1]

ATOS User Guide


System - 271 / 483

System
The system node is used to manage some general parameters.
Enter system from the root to go to the corresponding node:
ATOS>>system
ATOS\system>>

System Commands
ATOS\system>>logins
The logins command shows the last 10 accesses made by administrators and users. For each
access, it indicates the username (name), the level at which the user logged in (level), the date
and time when the login session started (time(start login)), the date and time of session
termination (time(close login)) and the used source (source); this can be via the console
port, or using a Telnet session or the Web Server (the last two being identified with the IP address
of the terminal).

list of logs
name
level
bianchi admin
rossi
admin
verdi
user

time(start
01/02/2002
01/02/2002
01/02/2002

login)
12:33:30
10:37:04
09:10:05

ATOS\system>>set ?
Nodes available:
password
timesync
Set command parameters:
name
localdomain
deftftpserver
tftp-local-ipaddress
aaa-profile
bkp-auth
date
defaults
loglevel
scroll-line
kernel-logs
crypted-passwords

<string>
<string>
<ip addr>
<ip addr>
<string>
<on|off>
<value>
<value>
<on|off>
<on|off>

time(close login)
in progress
01/02/2001 10:41:19
01/02/2001 09:40:25

source
console
(192.168.118.72)
(192.168.118.73)

ATOS User Guide


System - 272 / 483

description

<string>

Table 225: set


Syntax

Description

name <name>

Replace the system name ATOS>> with the one entered, up to 20


characters (default ATOS plus the last six digits of the serial
number).

localdomain <name>

Indicate for which domain name the system is a DNS Authority


(default LocalDomain)

deftftpserver <ip addr>

Configure the tftp server IP address that the device heads for files
download (default 0.0.0.0).

tftp-local-ipaddress
<ip addr>

Configure the TFTP client IP address (default 0.0.0.0).

aaa-profile <string>

Associate a predefined AAA authentication profile to the device


login, via serial or via Ethernet (default null).

bkp-auth <on|off>

Enable/disable the authentication using the password previously


configured with the set password command . The default
value is on.

date1 <dd mm yyyy hh mm ss>

Configure day and months (2 digits), year (4 digits), hour, minutes


and seconds (2 digits).

defaults

Restore default parameters: the device restarts loading factory


parameters.

loglevel <value> [-s]

Define the log level, from the lowest level of information (0), to the
highest level of information (5). Default is 1

scroll-line <value>

Define the number of lines the user can display at a time (1 to 255,
default 22).

kernel-logs <on|off>

Enable/disable the kernel logs of linux based applications (default


off)

crypted-passwords <on|off>

Enable/disable the encryption of the password used by the


application (e.g. PPP autenthication, Voice authenticathion user
password).
Default off

Description <string>

Up to 100 characters can be used to write a description of the


system (default null).

The bkp-auth command become active only once the authentication try by the AAA profile
doesnt have any result. Infact, in case of authetication success or failure, this parameter is
ignored.

The command date allows to visualize, in any node, the system date and time.

ATOS User Guide


System - 273 / 483

System Nodes
Password - Commands
It changes the password for accessing the super-administrator, the administrator and the user level:

ATOS\system\password>>set ?
Nodes not available.
Set command parameters:
<admin|user|superadmin>
Table 226: set password
Syntax

Description

superadmin

Super-administrator password. This level provides full control of


configuration parameters and allows some of these parameters to be
protected agains modifications by users logged in at the admin
level.

admin

Administrator password (maximum 20 characters). The field is


empty by default. This level provides control of the configuration
parameters as permitted by the super-administrator.
When you set the admin password, the system requests you to
enter the old password and then to confirm the new password.

user

User password (maximum 20 characters). By default, this field is


empty. This level allows you to read the configuration parameters,
but not to modify them.

Timesync - Commands
Starting from version 2.7, it is possible to synchronize the internal system clock to a network
provided time source by configuring an SNTP, TCP/TIME or UDP/TIME client.
The version 4 SNTP protocol2 (which is an adaptation of the NTP protocol3) and the TIME
protocol, either in a TCP and UDP versions, allow the internal clock synchronization by sending a
request to a SNTP or to a TIME server, respectively.
ATOS allows to configure different servers in a list. By enabling the timesync parameter, a
request is sent to the first server in the list. Default configuration provides two entries for the same
SNTP server, the first one in numerical format (IP address), the second in alphanumeric format
(Internet name).
The www.ntp.org web site provides a list of SNTP servers. Independently from their geographical
location, all SNTP servers provide information on the Greenwich Mean Time (GMT).

Rfc 2030

Rfc 1305

ATOS User Guide


System - 274 / 483

Table 227: SNTP server list


ISO

Area

HostName

Worldwide

pool.ntp.org

Asia

asia.pool.ntp.org

Europe

europe.pool.ntp.org

Oceania

oceania.pool.ntp.org

North America

north-america.pool.ntp.org

AT

Austria

at.pool.ntp.org

AU

Australia

au.pool.ntp.org

CA

Canada

ca.pool.ntp.org

CH

Switzerland

ch.pool.ntp.org

DE

Germany

de.pool.ntp.org

DK

Denmark

dk.pool.ntp.org

ES

Spain

es.pool.ntp.org

FI

Finland

fi.pool.ntp.org

FR

France

fr.pool.ntp.org

IT

Italy

it.pool.ntp.org

LU

Luxemburg

lu.pool.ntp.org

MX

Mexico

mx.pool.ntp.org

MY

Malaysia

my.pool.ntp.org

NL

Netherland

nl.pool.ntp.org

NO

Norway

no.pool.ntp.org

NZ

New Zealand

nz.pool.ntp.org

PH

Philippines

ph.pool.ntp.org

PL

Poland

pl.pool.ntp.org

SE

Sweden

se.pool.ntp.org

SI

Slovenia

si.pool.ntp.org

UK

Great Britain

uk.pool.ntp.org

US

USA

us.pool.ntp.org

ATOS\system\timesync>>set ?
Nodes not available.
Set command parameters:
<on|off>
frequency
gmt-offset
daylight-saving-time
local-ipaddress
loglevel

<value>
<value>
<string>
<ip addr>
<value>

ATOS User Guide


System - 275 / 483

Table 228: set timesync


Syntax

Description

on|off

Enable/disable the time synchronization client. As soon as this


parameter is enabled, a request is sent to the first server of the list
(default off).

frequency <value>

Set the frequency of synchronization requests, in seconds (default:


8600; range: 0-86400).

gmt-offset <value>

Define the offset in minutes between the local time and the GMT
time provided by the time server. The default value, is +60, the
configurable range is 720.

daylight-saving-time
<string>

Configure the summer time (or daylight saving time). Configuration


string requires the start and the end time.

local-ipaddress
<ip addr>

Set the SNTP client IP address (default 0.0.0.0).

loglevel <value>

Set the detail level used by ATOS to log the events of the timesync
node (values: 0-5, default 1).

ATOS\system\timesync>>add ?
add command parameters:
<ip addr|name> [ sntp(=default)|udp|tcp ]
ATOS\system\timesync>>del ?
del command parameters:
<ip addr|name> [ sntp(=default)|udp|tcp ]

Table 229: add - del


Syntax

Description

ip addr|name
[ (sntp=default)|utp|tcp ]

Insert/delete a time server to/from the list. A server is identify by


its IP address or its domain name. As an additional information the
protocol to be used ( UDP or TCP) can be added. If this information
is omitter, the default protocol is SNTP.

ATOS User Guide


VPN - 276 / 483

Virtual Private Network


A Virtual Private Network (VPN) tunnel is a private connection between two devices or networks
(VPN client and VPN server) over a public (Internet) or shared network.
ATOS implements three tunneling modes:
IPinIP, encapsulation of the IP packet with an additional IP header containing the public source and
destination addresses;
GREinIP, encapsulation of the IP packet with GRE transportation and IP header;
PPTP, both a PPTP client and server are necessary. It uses a TCP connection for tunnel
management. For tunneled data it emulates a point-to-point connection, encapsulating PPP
frames with GRE (Generic Routing Encapsulation) transportation and one IP header providing
routing information to reach the endpoint. It uses the PPP protocol to negotiate authentication,
encrypting and IP address assignment services.
The payload of the encapsulated PPP frames can be encrypted. The MPPE (Microsof Point to Point
Encryption) protocol guarantees data protection in VPN connections.
MPPE supports encryption schemes with 128, 56 or 40 bit keys and requires common client and
server keys, like the ones generated by the MS-CHAPv1 e MS-CHAPv2 authentication protocols.

Operating mode
VPN with IPinIP and GREinIP encapsulation become operative after configuration, since they
require no negotiation.
The situation is different for VPN with PPTP encapsulation. The PPP supports four authentication
protocols: PAP, CHAP, MS-CHAPv1 and MS-CHAPv2. When the MS-CHAPv1 or MS-CHAPv2
protocols are negotiated, you can enable the CCP (Compression Control Protocol) to negotiate the
MPPE parameters for data encryption.
MPPE operates in two different modes:
STATEFUL the transmission/reception key is changed every 256 transmitted/received packets;
STATELESS the transmission/reception key is changed every transmitted/received packet.
The use of the STATELESS mode is recommended for VPN interfaces.

VPN Commands
ATOS allows you to define up to 8 VPN interfaces. The following command is available in the
vpn node to create the interface:

ATOS User Guide


VPN - 277 / 483

ATOS\vpn>>add ?
add command parameters:
<vpn name string>[<ip|gre|pptp>]
pptp-server

ATOS\vpn>>del ?
del command parameters:
<vpn name string>

Table 230: add - del


Syntax

Description

vpn name string

Create a VPN profile with name string description in the list of


VPN interfaces. Up to 8 VPN can be added. The PPTP protocol is
used by default if the protocol type used for the VPN is not
indicated.

ip|gre|pptp

Define the protocol used for encapsulation by the VPN. Skipping


this parameter, the system assumes as default value the PPTP
protocol.

pptp-server

Create a VPN Server profile with PPTP protocol.

Examples:
to add a VPN client profile with VPNname name and PPTP protocol:
ATOS\vpn>>add VPNname
Command executed

to add a VPN server profile with PPTP protocol:


ATOS\vpn>>add pptp-server
Command executed

to add a VPN profile with VPNname name and defined protocol (ip):
ATOS\vpn>>add VPNname ip
Command executed

ATOS User Guide


VPN - 278 / 483

Being symmetric between the two end-points, the VPN using the IP or GRE protocol does not
require the establishment of a client-server profile.

The creation of the VPN interface automatically generates the VPN name string subnode used for
parameter configuration:

Parameters available in a vpn interface depend on the encapsulation protocol selected for the vpn,
ip/gre or pptp.

ATOS\vpn\VPNname>>set ?
Nodes available:

ppp1

Set command parameters:


<on|off>
server
<ip addr>
remote
<ip addr>
local-ipaddress
<ip addr>
loglevel
<value>
napt
<on|off>
address
<ip addr>[/value]
netmask
<ip addr>
pptp-echo
<on|off>

Table 231: set


Syntax

Description

on|off

Activate/deactivate the VPN interface (default: OFF). If you have


created a VPN client profile, the set on command sends a
request for TCP connection to port 1723. In case of VPN server
profile the device accepts incoming connections from the same port.

server <ip add>2


remote <ip addr>

Set the public IP address of the PPTP server.


3

local-ipaddress <ip addr>

loglevel <value>

Set the public IP address of the IP/GRE peer.


3

Set the public IP address of the local IP/GRE peer. The default
value (0.0.0.0) means that the vpn interface assumes the same
public IP address of the physical interface.
Set the detail level used by ATOS to record events of the VPN
interface. Range: 1-5, default: 1.

The ppp node is available after creating a pptpc client/server only.

For PPTP client only.

For IP/GRE peer only.

ATOS User Guide


VPN - 279 / 483

napt <on|off>

Activate/deactivate the NAPT in the VPN interface. Default: off.

address <ip addr>

Indicate the private IP address of the local interface.

netmask <ip addr>

Indicate the private network mask.

pptp-echo <on|off>

Enable/disable PPTP echo message sending2.

Differently from a pptp client or a ip/gre vpn, the pptp-server node includes server and ppp
subnodes.

ATOS\vpn>>add pptp-server
Command executed
ATOS\vpn>>pptp-server
ATOS\vpn\pptp-server>>set ?
Nodes available:
server
ppp
Set command parameters:
<on|off>
loglevel
<value>
napt
<on|off>
accesslistname
<string>
address
<ip addr>[/value]
netmask
<ip addr>
pptp-echo
<on|off>

VPN Nodes (PPTP protocol)


From the node of the VPN interface you can access the PPP library configuration. You can show
the available nodes with the tree command.
Tree visualization:
client profile
ATOS\vpn\VPNname>>tree
ppp
lcp
authentication
ccp
ipcp

echorequest
mppe

ATOS User Guide


VPN - 280 / 483

server profile
ATOS\vpn\pptp-server>>tree
server
ppp
lcp
authentication
ccp
ipcp

echorequest
mppe

The configuration of the CCP protocol for the VPN interface is illustrated below.

VPNname Server Commands


This command defines the group of accounts and pool of addresses used by the server to
authenticate and assign IP addresses.

ATOS\vpn\pptp-server\server>>set ?
Nodes not available.
Set command parameters:
aaa-profile <string>
address
<string>
Table 232: set
Syntax

Description

aaa-profile <string>

Indicate the AAA profile name (see Authentication, Authorization,


Accounting chapter).

address <string>

Indicate the IP addresses pool name in the RAC node.

VPNname PPP Commands


ATOS\Vpn\pptp-server\Ppp>>set ?
Nodes available:
lcp
authentication
ccp
ipcp

ATOS User Guide


VPN - 281 / 483

Set command parameters:


maxconfigure
<value>
maxterminate
<value>
maxfailure
<value>
restarttimer
<value>
inactivitytime <value>
loglevel
<value>

Table 233: set


Syntax

Description

maxconfigure <value>

Maximum number of requests to establish the PPP session over


WAN (CFG REQUEST) in order to consider the attempt as failure.
Range: 1- 20, default: 10.

maxterminate <value>

Maximum number of requests to clear the PPP connection


(TERMINATE REQUEST) in order to clear the connection.
Range: 1- 20, default: 2.

maxfailure <value>

Maximum number of negative acknowledgements during the


negotiation phase of the PPP session parameters (CFG NAK) before
sending the acknowledge message (CFG ACK). Range: 1- 20,
default: 5.

restarttimer <value>

Set the timeout between two attempts for the parameters above.
Range: 1- 30 secondi, default: 3 sec..

inactivitytime <value>

Indicate the time after which the PPP session is cleared in case of
no data packet transmission. The timer is not active if the value is 0.
This means that the connection is always-on , i.e. it is active as
long as the physical level is active. If the value is not 0, the
connection is on-demand , i.e. it activates with data traffic and
remains active until the set timer expires. Range: 0- 65535 seconds,
default: 0.

loglevel <value> [-s]

Set the detail level for the information generated by ATOS


following to errors on the services offered by the PPP subnode
(default: 1). The command is extended to the subnodes by selecting
the [s] option.

VPNname PPP Nodes


The PPP node contains the lcp (Link Control Protocol), authentication (configuration of
authentication parameters) ccp (use of the Compression Control Protocol) and ipcp
(configuration of compression type) subnodes.

ATOS User Guide


VPN - 282 / 483

VPNname PPP - LCP Commands


ATOS\wan1\ppp\lcp>>set ?
Nodes available:

echorequest

Set command parameters:


mru <value>
pfc <on|off>
acfc <on|off>
echo <on|off>

Table 234: set


Syntax

Description

mru <value>

Value of the MRU parameter (Max Receive Unit) in bytes. Range:


256-1500, default: 1500.

pfc <on|off>

Activate/deactivate the compression of the PID field (default: off).

acfc <on|off>

Activate/deactivate the compression of the Address and Control


field (default: off).

echo <on|off>

Activate/deactivate the sending of PPP ECHO REQUEST packets


to check the status of the PPP link (default: on).

VPNname PPP - LCP - Nodes


ATOS\wan1\ppp\lcp\echorequest>>set ?
Nodes not available.
Set command parameters:
maxretries <value>
timeout
<value>

Table 235: set


Syntax

Description

maxretries <value>

Maximum number of ECHO requests in order to terminate the PPP


link in case of no reply from the server .Range: 1-255, default: 5.

timeout <value>

Time between two ECHO requests. Range: 1-255 seconds, default:


30 sec..

ATOS User Guide


VPN - 283 / 483

VPNname PPP - Authentication Commands


The commands for the configuration of the authentication parameters are contained in the
authentication node:
ATOS\wan1\ppp\authentication>>set ?
Nodes not available.
Set command parameters:
username <string>
password <string>
pap
<on|off>
chapmd5
<on|off>
ms-chapv1 <on|off>
ms-chapv2 <on|off>

Table 236: set


Syntax

Description

username <string>

pap <on|off>

Username (typically provided by the ISP) for authentication with the


remote server.
Field with 0-25 characters, default: empty.
Password (typically provided by the ISP) for authentication with the
remote server.
Field with 0-15 characters, default: empty.
Activate/deactivate the PAP authentication mode (default: on).

chapmd5 <on|off>

Activate/deactivate the CHAPMD5 authentication mode (default: on).

ms-chapv1 <on|off>

Activate/deactivate the MS-CHAPv1 authentication mode (default: off).

ms-chapv2 <on|off>

Activate/deactivate the MS-CHAPv2 authentication mode (default: off).

password <string>

ATOS supports the PAP and CHAP MD5 authentication modes. If ATOS does not supports the
requested protocol during the negotiation phase of the authentication protocol, ATOS replies with
the safest enabled protocol. The authentication phase ends when client and server agree on the
protocol to use.

VPNname PPP - CCP Commands


From the ATOS\vpn\VPNname\ppp\ccp>> node you can activate the CCP protocol,
configure up to 3 session keys and select the synchronization mode of the MPPE protocol.

ATOS\vpn\VPNname\ppp\ccp>>set <on|off>

ATOS User Guide


VPN - 284 / 483

Table 237: set


Syntax

Description

on|off

Activate/deactivate the CCP protocol in the VPN. Default: off.

VPNname PPP - CCP Nodes


The ATOS\vpn\VPNname\ppp\ccp\mppe>> subnode is used to define the 3 session keys and
select the synchronization mode of the MPPE protocol.

ATOS\vpn\VPNname\ppp\ccp\mppe>>set ?
Nodes not available.
Set command parameters:
key40
<on|off>
key56
<on|off>
key128
<on|off>
sync-mode <stateless|stateful>

Table 238: set


Syntax

Description

key40 <on|off>

Activate/deactivate the 40 bits MPPE session key. Default: off.

key56 <on|off>

Activate/deactivate the 56 bits MPPE session key. Default: off.

key128 <on|off>

Activate/deactivate the 128 bits MPPE session key. Default: off.

sync-mode
<stateless|stateful>

Select the MPPE synchronization mode.


Default: stateless.

VPNname PPP - IPCP Commands


ATOS\wan1\ppp\ipcp>>set vjcomp <on|off>

Table 239: set vjcomp


Syntax

Description

on|off

Activate/deactivate the reception of packets compressed with the Van


Jacobson technique. Default: on.

ATOS Guida dUtente


285 / 483

Virtual Router Redundancy Protocol


Overview
The VRRP (Virtual Router Redundancy Protocol) implementation allows, on LAN interface, router
backup functionality. It selects, among virtual routers running with VRRP on the same LAN, a
router MASTER that controls the IP address(es) associated with a virtual router and forwards
packets sent to these IP addresses.
Backup functionality among routers follows RFC2338.
VRRP application is similar to a Cisco Systems, Inc. proprietary protocol named Hot Standby
Router Protocol (HSRP) and to a Digital Equipment Corporation, Inc. proprietary protocol named
IP Standby Protocol.

VRRP - Commands
ATOS\vrrp>>add ?
add command parameters:
[<name><id value>]
ATOS\vrrp>>del ?
del command parameters:
<name>

Table 240: add - del


Syntax

Description

name

Add/del a VRRP instance called name. Its allowed to add up to 8


VRRP instances. The add command without name creates a
VRRPn instance where n = 1-8 and vrid = 1-255.

id value

Configure the vrid value used by the vrrp instance. The add
command without vrid creates a VRRP instance where id value
(vrid) = 1-255.

ATOS\vrrp>>set ?
set command parameters:
loglevel <value>

ATOS User Guide


VRRP - 286 / 483

Table 241: set


Syntax

Description

loglevel <value>

Set the detail level used by ATOS to log the events of the VRRP
node. Range: 1-5. Default: 1.

VRRP - Nodes
VRRPname - Commands
ATOS\vrrp\VRRPname>>add ?
add command parameters:
<ip addr>
ATOS\vrrp\VRRPname>>del ?
del command parameters:
<ip addr>
Table 3: add - del
Syntax

Description

ip addr

Add/del an IP address from the list of addresses controlled by the


MASTER router.

ATOS\vrrp\VRRPname>>set ?
set command parameters:
<on|off>
loglevel
<value>
vrrp-interface
<name>
vrid
<value>
priority
<value>
preemption
<true|false>
advertisement-interval
<value>
handle-virtual-mac-address <true|false>
gateway-interface
<LAN0|ATM_VC0|ATM_VC1|ATM_VC2|ATM_VC3|
ATM_VC4|ATM_VC5|ATM_VC6|ATM_VC7|loopbk0>

ATOS User Guide


VRRP - 287 / 483

Table 4: set
Syntax

Description

on|off

Enable/disable the VRRP instance. Default: off.

loglevel <value>

Set the detail level used by ATOS to log the events of the VRRP
instance. Range: 1-5, default: 1.

vrrp-interface <name>

Configure the interface having the VRRP protocol active. Default:


no interface.

vrid <value>

Configure the virtual router identifier. Range: 1-255. Default: a


progressive value from 1 up to 8.

priority <value>

Configure a priority value for the router; the highest priority value
identifies the MASTER router. Range: 1-255. Default: 100.

preemption <true|false>

Enable/disable the preemption condition in the election mechanism


for the MASTER router. True value for preemption means that a
router having the highert priority has the precedence on routers
having lower priority. False value for preemption means that the
preemption is always allowed, independently from the router
priority.Default value: true.

advertisement-interval
<value>

Time, in seconds, between two ADVERTISEMENT messagges.


Range: 1-255 sec.; default: 1 sec..

handle-virtual-mac-address
<true|false>

True value means that the virtual MASTER router uses the virtual
MAC address router 00-00-5E-00-00-{VRID} defined by IEEE 802
MAC Address. Default value: true.

Gateway-interface <name>

Set the gateway interface that define the router behaviour in the
netrwork: as MASTER router if this interface is UP, as BACKUP
router if this interface is DOWN.

ATOS\vrrp\VRRPname>>show conf
Show of ATOS vrrp VRRPname
Mode
:
Level of log
:
VRRP interface
:
VRId
:
Priority
:
Preemption
:
Advertisement interval (sec):
Handle Virtual MAC Address :
Gateway interface
:

off
1
---1
100
true
1
true
----

NO ADDRESSES ADDED
Show of ATOS vrrp VRRPname authentication
Type
: no
Command executed

ATOS User Guide


VRRP - 288 / 483

VRRPname Nodes
Authentication - Commands
ATOS\vrrp\VRRPname\authentication>>show conf
Show of ATOS vrrp VRRPname authentication
Type
: no
Command executed
ATOS\vrrp\VRRPname\authentication>>set ?
set command parameters:
type
<no|password>
password
<string>
Table 5: set
Syntax

Description

type <no|password>

Authentication type used in the Authentication Data field for the


ADVERTISEMENT. Default: no.

password <string>

String used for a password authentication type. Default: null string.

Next, for example, a VRRPname instance is created enabling the VRRP protocol on the LAN0
interface with VRID = 1. It manages the LAN0 IP address and the IP address 1.2.3.4. The VRRP
instance, in order to evaluate if the router is a MASTER or a BACKUP one, uses the default
gateway interface defined in the router configuration.

ATOS\vrrp>>add
ATOS\vrrp\vrrp1>>set vrrp-interface
ATOS\vrrp\vrrp1>>add 1.2.3.4
ATOS\vrrp\vrrp1>>set on

LAN0

ATOS Guida dUtente


289 / 483

WAN Interfaces
ATOS permits the configuration of multiple remote data connections. If you have subscribed
multiple ATM virtual circuits with the service provider, you can establish simultaneous connections
to different destination, with each destination identified with VPI/VCI value.
For example, you can use one connection to reach your Internet Service Provider and another
connection to reach the corporate LAN from a peripheral site. The name assigned to the connections
is WANx, where x can have a value from 1 (Wan1) up to 16 (Wan16).
Moreover it is possible the use of VC bundling.

WANx Commands
ATOS\wan1>>set ?
Nodes available:
ppp
ip
atm
bundle
service
bridgepar
Set command parameters:
<on|off>
bridging
<on|off>
remoteadmin
<on|off>
loglevel
<value>
acl-in
<None>
acl-out
<None>
multicast
<on|off>
multicast-limit
<None>
open-mode
<always-on|on-traffic|on-command>

Table 242: set


Syntax

Description

on|off

Activate/deactivate the WANx interface (default: off).

bridging <on|off>

Activate/deactivate the bridging mode over the WANx interface


(default off).

remoteadmin <on|off>

Enable/disable the WANx interface to remote management of the


device. Default wanx:on.

loglevel <value>

Set the detail level used by ATOS to log the events of the WANx
(default 1)

Acl-in <string>

Name of the Access List created in the accesslist node to be


associated with the WAN in ingress direction (default none).

ATOS User Guide


VRRP - 290 / 483

Acl-out <string>

Name of the Access List created in the accesslist node to be


associated with the WAN in egress direction (default none).

multicast <on|off>

Enable/disable the WANx interface to multicast (default: off).

Multicast limit <string>

Name of the Access List created in the accesslist node to be


associated with the WAN for multicast traffic (default: null).

open-mode

Configure WANx session modes:


<always-on|

the session is always open (default);

on-traffic|

the session is opened in case of traffic over the interface;

on-command>

the session is opened and closed with the connect and


disconnect commands.

Connect and Disconnect


ATOS\wan1>>connect
ATOS\wan1>>disconnect

Table 243: connect - disconnect


Syntax

Description

connect

Open the session for the enabled WAN interface. The command is
valid in on-command mode. The command is invalid in always
mode. The session is forced open in on-traffic mode (the
session is closed in case of no traffic over the interface).

disconnect

Close the session for the enabled WAN interface. The command is
valid in on-command mode. The command is invalid in always
mode. The session is forced closed in on-traffic mode (the
sessions is opened in case of traffic over the interface).

WANx - Nodes
You can show the structure of the WANx node with the tree command:
wan1

ppp
lcp
authentication
ipcp
ccp
server
ip
rip
nat
atm
bundle
service
pppoe

echorequest
mppe

ATOS User Guide


VRRP - 291 / 483

bridgepar

Service Commands
Encapsulation
ATOS manages three types of encapsulation for data transmission: IP over ATM Routed / Bridged
(RFC 2684, ex 1483), PPP over ATM (PPPoA, RFC2364) and PPP over Ethernet (PPPoE,
RFC2516). The selection depends on the type of protocol supported by the system you are
connecting to (information provided by the ISP).
ATOS\wan1\service>>set encapsulation
<rfc1483rfc1483bridged|pppoa|pppoe>

Table 244: set encapsulation


Syntax

Description

rfc1483

Set the IP over ATM encapsulation mode. The public address is


static (default).

rfc1483bridged

Configure bridged over ATM encapsulation mode.

Pppoa

Set the Point-to-Point over ATM encapsulation mode. The public


address is not static and is negotiated every time you establish the
connection with the ISP.

Pppoe

Set the Point-to-Point over Ethernet encapsulation mode. The public


address is not static and is negotiated every time you establish the
connection with the ISP.

LLC SNAP
You can include a header indicating the encapsulation mode of the payload when you transmit data
packets. The parameter value must be selected according to the operating mode of the server
connected to the device.
ATOS\wan1\service>>set llcsnap <on|off>

Table 245: set llcsnap


Syntax

Description

on|off

The default value is off. If you change to on, the encapsulation


mode is added to the payload (default on).

Once you have selected the encapsulation mode, three subnodes are available for parameter
configuration.

ATOS User Guide


VRRP - 292 / 483

Service - Nodes
PPPoE
Some ISPs use the PPP over Ethernet protocol for client access. This protocol makes account
management and traffic monitoring easier. The technique provides for the transmission of PPP
packets inside Ethernet frames.
To configure the PPP over Ethernet parameters you can use the PPPoE subnode:
ATOS\wan1\service\pppoe>>set ?
Nodes not available.
Set command parameters:
fcspreserved <on|off>
restarttimer <value>
maxretry
<value>
servicename
<string>
acname
<string>
loglevel
<value> [-s]

Table 246: set


Syntax

Description

fcspreserved <on|off>

Activate/deactivate the "Preserved CRC" option. This option


maintains the error detection code (CRC-32) of the Ethernet frames
in incoming and outgoing packets (default: off).

restarttimer <value>

Initial value of the timer used in the Discovery phase when ATOS is
trying to reach the PPPoE server. The timer is used for the first retransmission of the PADI and "PADR" packets in case of no
reply. The value doubles at every re-transmission.
Range: 1-65535 msec., default: 200 msec..

maxretry <value>

Maximum number of re-transmission attempts of PADI and


PADR packets. Range: 1-255, default: 5.

servicename <string>

Name of the service requested to listening servers. Maximum 32


characters (default: empty). ATOS accepts the first one proposed by
the Access Concentrator.

acname <string>

Name of the Access Concentrator with the requested service.


Maximum 32 characters (default: empty). ATOS accepts the first
one.

loglevel <value>

Log level generated by ATOS for errors in the services offered by


the PPPoE subnode. Default: 1.

You can leave the fields empty if you have no information on the Access Concentrators or services
offered by the remote system. ATOS includes the first Access Concentrator and the first service in

ATOS User Guide


VRRP - 293 / 483

the negotiation messages of the PPPoE session. You can use the query command to get
information on the parameters offered by the remote service:
ATOS\wan1\service\pppoe>>query

PPP Commands
The PPP subnode is used to configure the PPP protocol.
ATOS\wan1\ppp>>set ?
Nodes available:

lcp
authentication
ipcp
ccp
server

Set command parameters:


type
<ppp-client|ppp-server>
maxconfigure
<value>
maxterminate
<value>
maxfailure
<value>
restarttimer
<value>
inactivitytime <value>
loglevel
<value>
Table 247: set
Syntax

Description

maxconfigure <value>

Maximum number of requests to establish the PPP session over


WAN (CFG REQUEST) in order to consider the attempt as failure.
Range: 1- 20, default: 10.

maxterminate <value>

Maximum number of requests to clear the PPP connection


(TERMINATE REQUEST) in order to clear the connection.
Range: 1- 20, default: 2.

maxfailure <value>

Maximum number of negative acknowledgements during the


negotiation phase of the PPP session parameters (CFG NAK) before
sending the acknowledge message (CFG ACK). Range: 1- 20,
default: 5.

restarttimer <value>

Set the timeout between two attempts for the parameters above.
Range: 1- 30 secondi, default: 3 sec..

Inactivitytime <value>

Indicate the time after which the PPP session is cleared in case of
no data packet transmission. The timer is not active if the value is 0.
This means that the connection is always-on , i.e. it is active as
long as the physical level is active. If the value is not 0, the
connection is on-demand , i.e. it activates with data traffic and
remains active until the set timer expires. Range: 0- 65535 seconds,
default: 0.

ATOS User Guide


VRRP - 294 / 483

loglevel <value> [-s]

Set the detail level for the information generated by ATOS


following to errors on the services offered by the PPP subnode
(default: 1). The command is extended to the subnodes by selecting
the [s] option (default 1).

PPP Nodes
The PPP node contains the lcp (Link Control Protocol), authentication (configuration of
authentication parameters), ipcp (configuration of compression type), ccp (use of the
Compression Control Protocol) and server subnodes.

LCP Commands
ATOS\wan1\ppp\lcp>>set ?
Nodes available:
echorequest
Set command parameters:
mru <value>
pfc <on|off>
acfc <on|off>
echo <on|off>
Table 248: set
Syntax

Description

mru <value>

Value of the MRU parameter (Max Receive Unit) in bytes. Range:


256-1500, default: 1500.

pfc <on|off>

Activate/deactivate the compression of the PID field (default: off).

acfc <on|off>

Activate/deactivate the compression of the Address and Control


field (default: off).

echo <on|off>

Activate/deactivate the sending of PPP ECHO REQUEST packets


to check the status of the PPP link (default: on).

LCP - Nodes
ATOS\wan1\ppp\lcp\echorequest>>set ?
Nodes not available.
Set command parameters:
maxretries <value>
timeout
<value>

ATOS User Guide


VRRP - 295 / 483

Table 249: set


Syntax

Description

maxretries <value>

Maximum number of ECHO requests in order to terminate the PPP


link in case of no reply from the server .Range: 1-255, default: 5.

timeout <value>

Time between two ECHO requests. Range: 1-255 seconds, default:


30 sec..

Authentication Commands
The commands for the configuration of the authentication parameters are contained in the
authentication node:
ATOS\wan1\ppp\authentication>>set ?
Nodes not available.
Set command parameters:
username <string>
password <string>
pap
<on|off>
chapmd5
<on|off>
ms-chapv1 <on|off>
ms-chapv2 <on|off>
Table 250: set
Syntax

Description

username <string>

pap <on|off>

Username (typically provided by the ISP) for authentication with the


remote server.
Field with 0-25 characters, default: empty.
Password (typically provided by the ISP) for authentication with the
remote server.
Field with 0-15 characters, default: empty.
Activate/deactivate the PAP authentication mode (default: on).

chapmd5 <on|off>

Activate/deactivate the CHAPMD5 authentication mode (default: on).

ms-chapv1 <on|off>

Activate/deactivate the MS-CHAPv1 authentication mode (default: off).

ms-chapv2 <on|off>

Activate/deactivate the MS-CHAPv2 authentication mode (default: off).

password <string>

ATOS supports the PAP and CHAP MD5 authentication modes. If ATOS does not supports the
requested protocol during the negotiation phase of the authentication protocol, ATOS replies with
the safest enabled protocol. The authentication phase ends when client and server agree on the
protocol to use.

ATOS User Guide


VRRP - 296 / 483

IPCP Commands
ATOS\wan1\ppp\ipcp>>set vjcomp <on|off>
Table 251: set vjcomp
Syntax

Description

on|off

Activate/deactivate the reception of packets compressed with the Van


Jacobson technique. Default: on.

CCP Commands
From the ATOS\wan1\ppp\ccp>> node you can activate the CCP protocol, configure up to 3
session keys and select the synchronization mode of the MPPE protocol.

ATOS\wan1\ppp\ccp>>set ?
Nodes available:

mppe

Set command parameters:


<on|off>

Table 252: set


Syntax

Description

on|off

Activate/deactivate the CCP protocol in the VPN. Default: off.

CCP Nodes
The ATOS\vpn\VPNname\ppp\ccp\mppe>> subnode is used to define the 3 session keys and
select the synchronization mode of the MPPE protocol.

ATOS\wan1\ppp\ccp\mppe>>set ?
Nodes not available.
Set command parameters:
key40
<on|off>
key56
<on|off>
key128
<on|off>

ATOS User Guide


VRRP - 297 / 483

sync-mode <stateless|stateful>

Table 253: set


Syntax

Description

key40 <on|off>

Activate/deactivate the 40 bits MPPE session key. Default: off.

key56 <on|off>

Activate/deactivate the 56 bits MPPE session key. Default: off.

key128 <on|off>

Activate/deactivate the 128 bits MPPE session key. Default: off.

sync-mode
<stateless|stateful>

Select the MPPE synchronization mode.


Default: stateless.

IP Commands
This node is used to configure the IP protocol parameters over the WAN. The device offers eight
WAN ports to establish multiple connections with multiple remote networks (by subscribing the
service with the telecom provider).

ATOS\wan1\ip>>set ?
Nodes available:
rip
nat
Set command parameters:
address
<ip addr>[/value]
netmask
<ip addr>
remoteaddress
<ip addr>
defaultrouter
<ip addr>
addressvalidation <on|off>
napt
<on|off>
mtu
<value>
loglevel
<value>

Table 254: set

Syntax

Description

address <ip add>

IP address of the WANx port1 (default: 0.0.0.0).

The value must correspond to the public IP address assigned to the port in case of IpoA encapsulation. In case of PPPoA
and PPPoE encapsulation, the address is negotiated with the server during the configuration phase of the PPP session.,
when the address can be dynamically assigned by the PPP server. If the IP address is modified by the access server in the
PPP configuration phase, the subnet mask is changed into the subnet mask of the class of the assigned address.

ATOS User Guide


VRRP - 298 / 483

netmask <ip add>

WAN subnet mask (default: 0.0.0.0, i.e. the implicit subnet mask of
the IP address class is assigned).

Remoteaddress <ip add>

IP address of the system connected to the remote side of the WAN2


(default: 0.0.0.0).

defaultrouter <ip add>

IP address of the default gateway connected to the remote side of the


WAN3 (default: 0.0.0.0). It is raccomanded to configure in
RFC1883Brided encapsulation.

addressvalidation <on|off>

Activate/deactivate the function used to check if the source IP address


contained in every packet received from the WAN port is included in
the routing tables as address that can be reached from the WAN port.
The packet is accepted if the address is present, otherwise it is
rejected. Default: off.

napt <on|off>

Activate/deactivate the NAPT function (configured in the NAPT


node) in the WAN. Default: on.

mtu <value>

MTU (Maximum Transmission Unit) parameter. Range: 576-2048,


default: 1500.

loglevel <value> [-s]

Detail level for the information generated by ATOS on the services


offered by the IP subnode (default: 1).The command is extended to
the subnodes by selecting the [s] option (default 1).

IP Nodes
RIP
The configurable parameters for the Routing Information Protocol (RIP) over the WANx interface
are the same as the parameters for the LAN interface. The only difference between the two
interfaces for the RIP refers to the default value: OFF for LANx and BOTH for WANx.
ATOS\wan1\ip\rip>>set ?
Nodes not available.
Set command parameters:
<off|both|receive>
version <v1|v2|v1compatible>

NAT
The following commands are available for NAT configuration over WAN:
ATOS\wan1\ip\nat>>set ?

In case of connection over the PPP, the address is informed during the session configuration phase.

In case of connection over the PPP, the address is informed during the session configuration phase.

ATOS User Guide


VRRP - 299 / 483

Nodes not available.


Set command parameters:
address <ip addr>
alias
<string>
Table 255: set
Syntax

Description

address <ip add>

IP address for the NAT, as alternative to the public IP address assigned to the WAN.
If the parameter is configured, the source address of the outgoing packets from the
WANx interface is the parameter value. (default 0.0.0.0)

alias <string>

Alias name used in the WAN created in the NAPT\ALIAS node. (default: empty)

ATOS\wan1\ip\nat>>add <ip add>[/netmask]


Table 256: add
Syntax

Description

ip add [/netmask]

Create a list of IP addresses/netmask that are ignored by the NAT operations.


Incoming and outgoing packets having one of the IP addresses contained in the
list in the destination and source field, respectively, are ignored by the NAT
operations.

ATOS\wan1\ip\nat>>del <ip add>


Table257: del
Syntax

Description

ip del

Delete one entry from the list of IP addresses that are ignored by the NAT operations.

ATM (AAL5) Commands


This node is used to configure the parameters of the ATM connection in the WAN. It must request
the VPI and VCI values for the data connection to the service provider.

ATOS\Wan1\atm>>set ?
Nodes not available.
Set command parameters:
traffic-type <CBR>
traffic-type <VBR-RT>
traffic-type <VBR-NRT>
traffic-type <UBR+>

<PCR
<PCR
<PCR
<PCR

value>
value><SCR value><MBS value>
value><SCR value><MBS value>
value><MCR value>

ATOS User Guide


VRRP - 300 / 483

traffic-type <UBR>
<PCR value>
loglevel
<value>
vpi
<value>
vci
<value>
keep_alive
<OFF|LOOPBACK-REQ>
polling_time
<value>
retry_time
<value>
up_retry_cnt
<value>
down_retry_cnt <value>
Table 258: set
Syntax

Description

traffic-type

Set ATM class of service, fixing values as:

<cbr> <pcr value>

PCR: Peak Cell Rate (kbps);

<vbr-rt> <pcr value><scr


value><mbs value>

SCR: Sustainable Cell Rate (kbps);

<vbr-nrt> <pcr value><scr


value><mbs value>

MBS: Maximum Burst Size (ATM cell).


Default value is ubr 1000

<ubr+> <pcr value><mbs value>


<ubr> <pcr value>
vci <value>

Value of the "virtual path" associated with the port. Range: 1


- 255, default: 8.

vpi <value>

Value of the "virtual circuit" associated with the port. Range:


32 - 65535, default: 35 for WAN1, 36 for WAN2, up to 51
for WAN16

Keep_alive <OFF|LOOPBACK-REQ>

Enable (LOOPBACK-REQ), disable (OFF) the ATM keep


alive. If active ATM ping request are sent to the ATM
network. (default off)

polling_time

Set the time between each sending loopback request.

<value>

[5 - 300 seconds, default 10 sec.]


retry_time

<value>

Set the waitjng time related to the loopback request.


[1 - 60 seconds, default 1 sec.]

Up_retry_cnt

<value>

Configure the number of received loopback answer to wait


to declare the logic ATM link UP
[1 60, default 3]

Down_retry_cnt <value>

Configure the number of failure loopback answer to wait to


declare the logic ATM link DOWN
[1 60, default 5]

loglevel <value> [-s]

Log level generated by ATOS for errors on the services


offered by the ATM subnode.
Default: 1.

The following command enables loopback on ATM VC Interface:


ATOS\wan1\atm>>vc-loop ?

ATOS User Guide


VRRP - 301 / 483

vc-loop command parameters:


<on|off>
Setting VC-LOOP to ON all data received from ATM VC is looped.

VC bundling
VC bundling functionality allows to define several VC ATM associated to the same level 3
interface, to transport different services (voice, internet data, etc.) using the same IP address. In this
mode it is possible to configure for each VC bundling different bandwidth, traffic class (e.g. UBR,
CBR, VBR-RT), for different service type.
VC bundling can be used also in bridge mode to address traffic coming from the same Ethernet
interface into different VC. Level 2 traffic policy can be done for example, either basing on priority
field fot tagged traffic or basing on source/destination MAC address.
To activate VC bundling functionality the subnode bundle is available on each ATM WAN
interface. On it new VC can be added where the ATM parameters can be configured.
Moreover the QoS node must be used to add classifier, policy and association to address the
interesting traffic into relative VC bundling.
No mark data traffic is transmitted into default VC that is the WANx\ATM VC.

Bundle - Commands

ATOS\Wan1\bundle>>add ?
add command parameters:
<VC><vpi value><vci value>[<portid value>]
ATOS\Wan1\bundle>>del ?
del command parameters:
<VC><vpi value><vci value>[<portid value>]

Table 259: add/del VC


Syntax

Description

<VC>

Keyword

<vpi value>

Set the virtual path value associated to the selected port.


(range 1-255)

<vci value>

Set the virtual circuit value associated to the selected port.


(range 32-65535)

ATOS User Guide


VRRP - 302 / 483

<portid value>

ATM port identify value (available only for VDSL device).

ATOS\Wan1\bundle>>add vc 10 45
Command executed
ATOS\Wan1\bundle>>add vc 10 46
Command executed
ATOS\Wan1\bundle>>show conf
LIST OF VC IN BUNDLE ADDED
vc10_45
vc10_46
Show of ATOS Wan1 bundle vc10_45
Level of log
: 1
Keep alive
: OFF
Polling time
: 10
Retry time
: 1
Up retry count
: 3
Down retry count
: 5
Traffic
: Type=UBR PCR=1000
Show of ATOS Wan1 bundle vc10_46
Level of log
: 1
Keep alive
: OFF
Polling time
: 10
Retry time
: 1
Up retry count
: 3
Down retry count
: 5
Traffic
: Type=UBR PCR=1000

The following setting can be done on the created subnode:


ATOS\Wan1\bundle\vc10_45>>set ?
Nodes not available.
Set command parameters:
traffic-type <CBR>
<PCR value>
traffic-type <VBR-RT> <PCR value><SCR value><MBS value>
traffic-type <VBR-NRT> <PCR value><SCR value><MBS value>
traffic-type <UBR+>
<PCR value><MCR value>
traffic-type <UBR>
<PCR value>
loglevel
<value>
keep_alive
<OFF|LOOPBACK-REQ>
polling_time
<value>
retry_time
<value>
up_retry_cnt
<value>
down_retry_cnt <value>

ATOS User Guide


VRRP - 303 / 483

Table 260: set


Syntax

Description

traffic-type

Set ATM class of service, fixing values as:

<cbr> <pcr value>

PCR: Peak Cell Rate (kbps);

<vbr-rt> <pcr value><scr


value><mbs value>

SCR: Sustainable Cell Rate (kbps);


MBS: Maximum Burst Size (ATM cell).

<vbr-nrt> <pcr value><scr


value><mbs value>
<ubr+> <pcr value><mbs value>
<ubr> <pcr value>
Keep_alive <OFF|LOOPBACK-REQ>

Enable (LOOPBACK-REQ), disable (OFF) the ATM keep


alive. If active ATM ping request are sent to the ATM
network.

polling_time

Set the time between each sending loopback request.

<value>

[5 - 300 seconds, default 10 sec.]


retry_time

<value>

Up_retry_cnt

<value>

Set the waitjng time related to the loopback request.


[1 - 60 seconds, default 1 sec.]
Configure the number of received loopback answer to wait
to declare the logic ATM link UP
[1 60, default 3]

Down_retry_cnt <value>

Configure the number of failure loopback answer to wait to


declare the logic ATM link DOWN
[1 60, default 5]

loglevel <value> [-s]

Log level generated by ATOS for errors on the services


offered by the VC bundling subnode.
Default: 1.

Example: create a new VC bundling for voice traffic and set the QoS priority for that traffic.

WAN configuration:
ATOS\Wan1\Atm\Bundle>>add vc 8 36
ATOS\Wan1\Atm\Bundle\vc8_36>>set traffic-type CBR 1000

QoS configuration:
ATOS\AccessList>>add a1 PERMIT UDP <voice src-address> any anyport
anyport
ATOS\QoS\DiffServ>>add classifier classevoice LEVEL-3
ATOS\QoS\DiffServ\classevoice>>add ACCESSLIST a1
ATOS\QoS\DiffServ>>add policy pol3 level-3
ATOS\QoS\DiffServ\pol3>>add classevoice queuing-priority 1000
ATOS\QoS\DiffServ\pol3>>add classevoice mark-vc 8 36
ATOS\QoS\DiffServ>> add association ass3 level-3 pol3 ATM_VC0 OUT

ATOS User Guide


VRRP - 304 / 483

Example: create a bridge between WAN1 interface and LAN0. Traffic coming from LAN0 with
Vlan id 1 and priority 5 must be sent into VC 8 36. Other LAN0 traffic must be sent into default
VC.

WAN configuration:
ATOS\Wan1\Atm\Bundle>>add vc 8 36
ATOS\Wan1\Atm\Bundle\vc-8-36>>set traffic-type CBR 1000
ATOS\Wan1>>set bridging on
ATOS\Wan1\Atm\Bundle>>add vc 8 36

LAN0 configuration:
ATOS\Lan0>>add vlan1 1
ATOS\Lan0\vlan1\vlan>>set priority 5
ATOS\Lan0\vlan1>>set bridging on

QoS configuration:
ATOS\QoS\DiffServ>>add classifier classevlanid LEVEL-2
ATOS\QoS\DiffServ\classevlanid>>add VLAN-ID 1
ATOS\QoS\DiffServ\classevlanid>>add VLAN-PRIO 5
ATOS\QoS\DiffServ\classevlanid>>set match-all on
ATOS\QoS\DiffServ>>add policy pol2 level-2
ATOS\QoS\DiffServ\pol3>>add classevlanid queuing-priority 1000
ATOS\QoS\DiffServ\pol3>>add classevlanid mark-vc 8 36
ATOS\QoS\DiffServ>> add association ass2 level-2 pol2 ATM_VC0

BridgePar Commands
The bridging parameters for the WANx interface are the same as the parameters illustrated for the
LANx interface.
ATOS\wan1\bridgepar>>set ?
Nodes not available.
Set command parameters:
<bridge1|bridge2|bridge3|bridge4>
priority
<value>
cost
<value>

ATOS User Guide


Wireless LAN 305 / 483

Wireless LAN
Wireless LAN technology (WLAN, IEEE 802.11 standard) is used to realize an inexpensive and
scalable local area network that uses high-frequency radio waves rather than wires. Pratically, an
Ethernet card is replaced by a Wireless card, a RJ45 port is replaced by an antenna. ATOS1,
starting from 2.9 version, can be configured as an AP2 , implements IEEE 802.11b (1999) and
IEEE 802.11g (2003) standards.
Both 802.11b and 802.11g standards use the DSSS3 modulation, a transmission technology where
each bit is trasmitted as a redundant sequence of bits (called chip).
From 802.11, 802.11b and 802.11g standars inherit AP access and authentication methods and data
cryptography with either WEP4 or WAP5.
Like traditional networks, the maximum number of contemporary customers a single AP can
support depends on amount and type of data to transfer.

Max connection
Modulation
coverage

Speed rate
(Mbps)

# max
contemporary
channels without
interference

Standard

Frequency

802.11b

2.4GHz

DSSS

100m

1, 2, 5.5, 11

802.11g

2.4GHz

DSSS

100m

1, 2, 5.5, 11; 6, 9,
12, 18, 24, 36, 48,
54

Wireless Commands
ATOS\lan1\wireless>>set ?
Nodes available:
security
ap
Set command parameters:
operation-mode <ap>
radio-enable
<on|off>
ssid
<string>
nick
<string>
rx-antenna
<diversity|antenna1|antenna2>
1

In Aethra devices with wireless card.

Access Point.

Direct Sequence Spread Spectrum.

Wired Equivalent Privacy, protocol that uses the RC4 cypher algorithm for security and the CRC-32 for data integrity
check.
5

Wireless Application Protocol

ATOS User Guide


Wireless LAN - 306 / 483

tx-power
<20dbm|18dbm|17dbm|16dbm|15dbm|13dbm|10dbm|7dbm|3dbm>
rts-threshold <value>
frag-threshold <value>
atheros-xr
<on|off>
atheros-burst <on|off>

Table 261: set


Syntax

Description

operation-mode <ap>

Indicate the device working as access point.

radio-enable <on|off>

Enable/disable the wireless interface.

ssid6 <string>

Configure the network name, it is used to identify cells belonging to


the same net (max 32 characters). Default ssid value is lan17ap.

nick <string>

Configure the nickname or the work station name (max 32


characters). Default nick value is lan17-nick.

rx-antenna <divesity|
antenna1|antenna2>

Define the antenna receiving mode; the divesity option (default


value) selects, in real time, the antenna to use based on the better
signal / noise ratio. This functionality allows to solve the reflection
problem selecting quickly and automatically the antenna that
receive the signal of the better quality.

tx-power
<20dbm|18dbm|17dbm|16dbm|
15dbm|13dbm|10dbm|7dbm|3d
bm>

Define the antenna transmitting power (20dbm = max power).

rts-threshold <value>

Define the packet size (02347 byte) after which an RTS8/CTS9


packet is sent. The default value is 2347 bytes.

frag10-threshold <value>

Define the packet fragmentation threshold (256 2346 byte)


to improve performances in case of RF interference. This option
allows to split big size files before sending and to reassemble them
at the access point. The default value is 2346 bytes.

atheros-xr

<on|off>

Enable/disable Atheros xr feature. If on, the AP uses both standard


and special frequency used by Atheros chipset devices.

atheros-burst

<on|off>

Default off.
Enable/disable Atheros burst feature. If on, packets are sent in burst
mode in order to be more efficient during the transmission phase.
Default on.

Service Set IDentifier.

Where lan1 is the wireless interface.

Request To Send.

Clear To Send.

10

Short for fragmentation.

ATOS User Guide


Wireless LAN - 307 / 483

ATOS\lan1\wireless>>show conf
Show of ATOS000006 Lan1 wireless
Mode
: ap
Radio enable
: on
SSID
: VOIPTEST
Nick
: LAN1-NICK
Antenna
: diversity
Tx power (dBm)
: 18dbm
RTS threshold (byte) : 2347
Frag threshold (byte) : 2346
Atheros XR
: off
Atheros SuperAG-Burst : on

Wireless Nodes
AP - Commands
ATOS\lan1\wireless\ap>>set ?
Nodes available:
mac-filter
Set command parameters:
bc-ssid
<on|off>
mode
<b-only|g-only|mixed>
rf-channel
<value>
beacon-period <value>
dtim-period
<value>

Table 262: set


Syntax

Description

bc-ssid11 <on|off>

Default value (on) allows clients to use the access point without the
SSID configuration.

mode
<b-only|g-only|mixed>

Select the standard to use


bonly, 802.11b;
g-only, 802.11g (estension of the previous standard, 802.11b);
mixed, use both the standards. It is the default value.

12

rf -channel <value>

Configure the radiofrequency channel. Admitted values are: 0-13,


default: 6.

beacon-period <value>

A beacon is a special packet sent from the AP to notify its


availability. The beacon-period indicates the time (sent in the
beacon packet) between each beacon. Admitted values are 20-1000
ms, default is 100 ms.

11

BroadCast- Service Set IDentifier.

12

Radio Frequency.

ATOS User Guide


Wireless LAN - 308 / 483

dtim13-period <value>

13

Delivery Traffic Indication Map.

Indicate, in beacon packet unit, the activation time of the stations in


standby. Default value is 1ms, admittes values are 1-255.

ATOS User Guide


Wireless LAN - 309 / 483

AP - Nodes
Mac-filter - Commands
ATOS\lan1\wireless\ap\mac-filter>>set ?
Nodes not available.
Set command parameters:
association-control <on|off>

Table 263: set


Syntax

Description

association-control
<on|off>

Enable/disable the association control defined by the mac addresses


list.

ATOS\lan1\wireless\ap\mac-filter>>add ?
add command parameters:
Add <mac address>[permit|deny]

Table 264: add


Syntax

Description

<mac address>[permit|deny]

Define the mac address allowed or denied in the AP MAC Address


List.

Security - Commands
ATOS\lan1\wireless\security>>set ?
Nodes not available.
Set command parameters:
mode <disable|wep|wep-dot1x|wpa-psk|wpa-dot1x>

ATOS User Guide


Wireless LAN - 310 / 483

Table 265: set


Syntax

Description

mode <disable|wep|
wep-dot1x|wpa-psk|wpadot1x>

Disable: disable the security protocol (default value);


wep: create the wep subnode dinamically;
wep-dot1x: create the dot1x subnode dinamically;
wpa-psk: create the wpa subnode dinamically;
wpa-dot1x: create wpa and dot1x subnodes dinamically.

Security Nodes
Wep Commands
The Wired Equivalent Privacy, that belongs to the 802.11b standard, is a ciphering protocol used to
protect wireless communications. It uses the stream cipher algorithm named RC414. Thanks to a
combination of 64 or 128 bit keys, the WEP provides to network access control and to trasmission
data ciphering. To decode a transmission, Inot the net, each wireless client needs to use the same
64, 128 or 256 bit key to decode a trasmission.
Enabling the WEP protocol, the wep subnode will be dinamiccaly created from security node.
WEP weaknesses are that the protocol uses a static key to initiate encrytpion and that it lasks a
means of authentication.

ATOS\lan1\wireless\security>>set mode wep


Command executed
ATOS\lan1\wireless\security>>wep
ATOS\lan1\wireless\security\wep>>set ?
Nodes not available.
Set command parameters:
authentication <open-system|shared-key|both>
tx-key
<key1|key2|key3|key4>
key1
<string hex character>
key2
<string hex character>
key3
<string hex character>
key4
<string hex character>

Table 266: set


Syntax

14

Description

Rivests Code, from Ron Rivest, the inventor of the algorithm used.

ATOS User Guide


Wireless LAN - 311 / 483

authentication

Tree options are available for the authentication:

<open-system|

open system , where the Access Point accepts connecctions


from any station, wihtout a check identity;

shared-key|both>

shared key, that uses a shared key auhtentication;


both.
tx-key
<key1|key2|key3|key4>

Select one of the four keys used for the transmission.

key1/4
<string hex character>

Define the key value in string of 26 or 10 characters (hexadecimal


format), that uses a 128 or 64 bits protection system respectively.
Each key has a default value (see example below).

The MAC address is the only parameter used to filter the open system authentication.

ATOS\lan1\wireless\security>>wep
ATOS\lan1\wireless\security\wep>>show conf
Show of ATOS lan1 wireless security wep
authentication
: open-system
tx key
: key1
key 1 value (hex) : 11111111111111111111111111
key 2 value (hex) : 22222222222222222222222222
key 3 value (hex) : 33333333333333333333333333
key 4 value (hex) : 44444444444444444444444444

Wep-dot1x Commands
In Wep-dot1X mode WEP enhances security using the 802.1X standard authentication with
EAP15. 802.1X is a network access control method that supplies an authentication framework using
a RADIUS server.
ATOS\lan1\wireless\security>>set mode wep-dot1x
Command executed
ATOS\lan1\wireless\security>>dot1x
ATOS\lan1\wireless\security\dot1x>>set ?
Nodes not available.
Set command parameters:
aaa-profile <string>

15

Extensible Authentication Protocol.

ATOS User Guide


Wireless LAN - 312 / 483

Table 267: set


Syntax

Description

aaa-profile <string>

Name of the AAA profile previously created (see Authentication,


Authorization, Accounting chapter), max 64 digits.

AAA-profile configuration must include a RADIUS group with a predefined RADIUS server .

Wpa-psk Commands
The Wireless Protected Acces, compatible with the previous WEP standard, belongs to the IEEE
802.11i standard 16 and it is implemented in 802.11g devices.
The WPA-psk (Pre Shared Key) uses a psk that a devices will give to each equipment in the
network. This mode guarantee an high security level, cause of the lack of an authentication server;
everyone, discovering the psk, can access the network. WPA encryption protocols are:
TKIP17, that uses an encryption algorithm with a 128 bit dynamic key (instead of a 40 bit static key
used by WEP);
AES18, that uses a block encryption algorithm.
Both algorithms can be enabled in the same device.
ATOS\lan1\wireless\security>>set mode wpa-psk
Command executed
ATOS\lan1\wireless\security>>wpa
ATOS\lan1\wireless\security\wpa>>set ?
Nodes not available.
Set command parameters:
version
<v1|v2|both>
encryption <tkip|aes|both>
key-type
<pass-phrase|hex>
key-value <string>

Table 268: set


Syntax

Description

version <v1|v2|both>

Select the wpa version to use: v1, v2 or both.

encryption
<tkip|aes|both>

Select the encryption protocol: tkip, aes (not implemented yet)


or both.

16

Temporal Key Integrity Protocol.

17

Temporal Key Integrity Protocol.

18

Advanced Encryption Standard.

ATOS User Guide


Wireless LAN - 313 / 483

key-type
<pass-phrase|hex>

Indicate the insert mode for the key:


pass-phrase, with a max of 32 digits;
hex, with 64 digits in hexadecimal notation.

key-value <string>

Configure the key value, that can include from 8 to 63 digits. Each
devices in the same network must use the same key.

WPA and AES version 2 are available if a specific hardware/software includes these features.

Wpa-dot1x Commands
In WPA-dot1X mode WPA enhances security using the 802.1X standard authentication with EAP.
802.1X is a network access control method that supplies an authentication framework using a
RADIUS server.
ATOS\lan1\wireless\security>>set mode wpa-dot1x
Command executed
ATOS\lan1\wireless\security>>set ?
Nodes available:

dot1x
wpa

Set command parameters:


mode <disable|wep|wep-dot1x|wpa-psk|wpa-dot1x>

Dot1x Nodes

ATOS\lan1\wireless\security>>dot1x
ATOS\lan1\wireless\security\dot1x>>set ?
Nodes not available.
Set command parameters:
aaa-profile <string>
Table 269: set
Syntax

Description

aaa-profile

Name of the AAA profile previously created (see Authentication,


Authorization, Accounting chapter), max 64 digits.

ATOS User Guide


Wireless LAN - 314 / 483

AAA-profile configuration must include a RADIUS group with a predefined RADIUS server .

WPA Nodes

ATOS\lan1\wireless\security>>wpa
ATOS\lan1\wireless\security\wpa>>set ?
Nodes not available.
Set command parameters:
version
<v1|v2|both>
encryption <tkip|aes|both>

Table 270: set


Syntax

Description

version <v1|v2|both>

Select the wpa version to use: v1, v2 or both.

encryption <tkip|aes|both>

Select the encryption protocol: tkip, aes or both.

WPA version 2 and AES are available if a specific hardware/software includes these features.

ATOS User Guide


ADSL 1 / 483

XDSL VDSL2, ADSL2+


In case of Aethra devices with VDSL2/ADSL2+ interface, such as SV6044V model, ATOS permits
the configuration of some physical level parameters.
Infact, the xDSL chipset used by this kind of models can operate either in VDSL2 mode or
ADSL2+ mode.

XDSL0 Commands
ATOS\xdsl0>>set ?
Nodes not available.
Set command parameters:
<on|off>
loglevel
<value>
mode
<adsl_auto_xa|adsl_xa|adsl_g_dmt_xa|adsl_t1_413|adsl2_xa|
adsl2plus_xa|adsl2plus_xm|adsl_auto_xb|adsl_xb|adsl2_xb|
adsl2plus_xb|auto_over_pots|auto_over_isdn|
vdsl2_over_pots|vdsl2_over_isdn>
Table 1: set adslmode
Syntax

Description

<on|off>

Enable/disable the xdsl chipset modem.


[default on]

Loglevel <value>

It sets the detail level used by ATOS to record the xDSL events

Adsl_auto_xa

Select the (ANSI | ITU) parameter automatically


(ADSL2+/ADSL2/ReADSL/ADSL) according to the DSLAM
configuration, for annex A standard .

adsl_xa

Select the (ANSI | ITU) parameter automatically (ADSL1),


according to the DSLAM configuration, for annex A standard

adsl_g_dmt_xa

Select the ITU G.DMT ADSL1 parameter for annex A standard

adsl_t1_413

Select the ANSI T1.413 ADSL1 parameter for annex A standard

adsl2_xa

Select the (ANSI | ITU) parameter automatically (ADSL2),


according to the DSLAM configuration, for annex A standard

adsl2plus_xa

Select the (ANSI | ITU) parameter automatically (ADSL2+),


according to the DSLAM configuration, for annex A standard

adsl2plus_xm

Select the (ANSI | ITU) parameter automatically (ADSL2+ annex


M/ADSL2+/ADSL2/ReADSL/ADSL) according to the DSLAM
configuration, for annex A standard

adsl_auto_xb

Select the (ANSI | ITU) parameter automatically


(ADSL2+/ADSL2/ADSL according to the DSLAM configuration,
for annex B standard

adsl_xb

Select the (ANSI | ITU) parameter automatically (ADSL),


according to the DSLAM configuration, for annex B standard

adsl2_xb

Select the (ANSI | ITU) parameter automatically (ADSL2),

ATOS User Guide


ADSL - Page 316 / 483

according to the DSLAM configuration, for annex B standard


adsl2plus_xb

Select the (ANSI | ITU) parameter automatically (ADSL2+),


according to the DSLAM configuration, for annex B standard

auto_over_pots

Select the (ANSI | ITU) parameter automatically


(VDSL2/ADSL2+/ADSL2/ReADSL/ADSL) according to the
DSLAM configuration, for annex over pots standard

auto_over_isdn

Select the (ANSI | ITU) parameter automatically


(VDSL2/ADSL2+/ADSL2/ReADSL/ADSL) according to the
DSLAM configuration, for annex over isdn standard

vdsl2_over_pots

Select the VDSL2 parameter according to ITU-T G.993.2 over


pots standard.

vdsl2_over_isdn

Select the VDSL2 parameter according to ITU-T G.993.2 over


isdn standard.

How to check the xDSL status


In the xDSL0 node the show status command is available:
Example for VDSL2 interface down
ATOS\xdsl0>>show status

**************** xdsl0 status ****************


link status
: down
line up count
: 0

Example for VDSL2 interface up


ATOS\xdsl0>>show status

**************** xdsl0 status ****************


link status
: up
line up count
: 1
line up time
: 0h 00m 39s
operational mode: VDSL2 G.993.2 Annex B
profile type
: 17a
band plan type : TC layer
: EFM
peer id
: 0xB500 'IFTN' 0xA4B2 (Siemens Infineon)
power state
: L0
bitrate ch B0-L0:
attain. bitrate :
delay
ch B0-L0:
INP
path L0:
noise margin
:

upstream
40312
44057
8.0
2.0
8.8

downstream
83400 kbps
128856 kbps
4.0
ms
2.0
DMTSymbols
14.2
dB

ATOS User Guide


ADSL - Page 317 / 483

band0:
band1:
band2:
line attenuation:
band0:
band1:
band2:
signal attenuat.:
band0:
band1:
band2:
tx power
:
tx power density:

6.1
8.7
9.0
0.1
2.8
5.4
0.1
2.8
5.4
9.6
-

12.5
14.8
14.8
4.0
2.2
3.6
6.0
3.1
2.2
3.5
6.0
11.5
-

dB
dB
dB
dB
dB
dB
dB
dB
dB
dB
dB
dBm
dBm/Hz

How to check the xDSL statistics


In the xDSL0 node the show statistics command is available:
Example for VDSL2 statistics when the interface is up
ATOS\xdsl0>>show statistics

******************* xdsl0 statistics ******************


far-end
near-end
FEC events B0-L0:
19228
0
CRC errors B0-L0:
0
0
errored seconds :
0
0
LOS ES
:
0
0
LOF ES
:
0
0
severely ES
:
0
0
unavailable ES :
69
63
------------------- PTM
far-end
CRC_n err.B0-L0:
0
CRC_np err.B0-L0:
0
CV_p
B0-L0:
0
CV_np
B0-L0:
0

counters ------------------near-end
0
0
0
0

----------------- line path counters ----------------tx


rx
frames ok
:
37
74
octets ok
:
3235
6475
FCS errors
:
0
alignment errors:
0
frames int.err. :
0
0
pause frames
:
0
0
frames too long :
0
frames too short:
0
---------------- system ifc counters -----------------

ATOS User Guide


ADSL - Page 318 / 483

frames ok
:
octets ok
:
single coll.fr. :
multi coll.fr. :
FCS errors
:
alignment errors:
frames int.err. :
pause frames
:
frames too long :
frames too short:
802.3ah CRC err.:
802.3ah align er:

tx
74
6475
0
0
0
0
0
0

rx
37
3235
0
0
0
0
0
0
-

ATOS User Guide


Appendix A : private MIB - 319 / 483

Appendix A : private MIB


--- ATOS-MIB.mib
-- Tuesday, June 19, 2007 at 10:29:03
--

Aethra-MIB DEFINITIONS ::= BEGIN

IMPORTS
OBJECT-TYPE
FROM RFC-1212
TRAP-TYPE
FROM RFC-1215
enterprises, IpAddress, Counter
FROM RFC1155-SMI
DisplayString
FROM RFC1213-MIB;

--- Node definitions


--

aethra OBJECT IDENTIFIER ::= { enterprises 7745 }

atos OBJECT IDENTIFIER ::= { aethra 4 }

genericMib OBJECT IDENTIFIER ::= { atos 1 }

remoteAdminStatus OBJECT IDENTIFIER ::= { genericMib 1 }

remoteAdminTable OBJECT-TYPE
SYNTAX SEQUENCE OF RemoteAdminEntry

ATOS User Guide


Appendix A : private MIB - 320 / 483

ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"This table allows to read the value of RemoteAdminStatus
variable for each interface. There is an entry for each
interface."
::= { remoteAdminStatus 1 }

remoteAdminEntry OBJECT-TYPE
SYNTAX RemoteAdminEntry
ACCESS not-accessible
STATUS mandatory
INDEX { remoteIfcIndex }
::= { remoteAdminTable 1 }

RemoteAdminEntry ::=
SEQUENCE {
remoteIfcIndex
INTEGER,
remoteIfcDescr
DisplayString,
remoteIfcAdminStatusValue
DisplayString
}

remoteIfcIndex OBJECT-TYPE
SYNTAX INTEGER (1..1000)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"A unique value for each interface. Its value ranges
between 1 and the value of ifNumber (ifTable). This value
is the same of ifIndex (ifTable)."
::= { remoteAdminEntry 1 }

ATOS User Guide


Appendix A : private MIB - 321 / 483

remoteIfcDescr OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..255))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"A textual string containing information about the
interface. This value is the same of ifDescr (ifTable)."
::= { remoteAdminEntry 2 }

remoteIfcAdminStatusValue OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..255))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The RemoteAdminStatus of the selected interface. If 'on',
a remote manager can manages (via SNMP, HTTP, Telnet) the
CPE through the selected interface. If 'off', a remote
manager can't do it."
::= { remoteAdminEntry 3 }

performance OBJECT IDENTIFIER ::= { genericMib 2 }

cpePerformance OBJECT IDENTIFIER ::= { performance 1 }

cpuUsage OBJECT IDENTIFIER ::= { cpePerformance 1 }

cpuMinIdle OBJECT-TYPE
SYNTAX INTEGER (0..100)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The min. percentage of CPU idle."
::= { cpuUsage 1 }

cpuMaxIdle OBJECT-TYPE

ATOS User Guide


Appendix A : private MIB - 322 / 483

SYNTAX INTEGER (0..100)


ACCESS read-only
STATUS mandatory
DESCRIPTION
"The max. percentage of CPU idle."
::= { cpuUsage 2 }

cpuCurrentIdle OBJECT-TYPE
SYNTAX INTEGER (0..100)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The current percentage of CPU idle."
::= { cpuUsage 3 }

memoryUsage OBJECT IDENTIFIER ::= { cpePerformance 2 }

heapMemoryFree OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The amount of heap memory (in bytes) that is free. This memory
is used by the control processes."
::= { memoryUsage 1 }

packetDeliveryMemoryFree OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The amount of packet delivery memory (in bytes) that is free.
This memory is used by the network delivering and routing
processes."
::= { memoryUsage 2 }

ATOS User Guide


Appendix A : private MIB - 323 / 483

systemMemoryFree OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The amount of system memory (in bytes) that is free. This
memory is used by the operating system for allocate contextual
objects."
::= { memoryUsage 3 }

heapMemoryTotal OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The amount of heap memory (in bytes) that is available. This
memory
is used by the control processes."
::= { memoryUsage 4 }

packetDeliveryMemoryTotal OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The amount of packet delivery memory (in bytes) that is available.
This memory is used by the network delivering and routing
processes."
::= { memoryUsage 5 }

systemMemoryTotal OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory

ATOS User Guide


Appendix A : private MIB - 324 / 483

DESCRIPTION
"The amount of system memory (in bytes) that is available. This
memory is used by the operating system for allocate contextual
objects."
::= { memoryUsage 6 }

ifcPerformance OBJECT IDENTIFIER ::= { performance 2 }

ifcSpeedPerformanceTable OBJECT-TYPE
SYNTAX SEQUENCE OF IfcSpeedPerformanceEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"This table allows to read the throughput of the
interfaces. There is an entry for each interface."
::= { ifcPerformance 1 }

ifcSpeedPerformanceEntry OBJECT-TYPE
SYNTAX IfcSpeedPerformanceEntry
ACCESS not-accessible
STATUS mandatory
INDEX { ifcSpeedPerformanceIndex }
::= { ifcSpeedPerformanceTable 1 }

IfcSpeedPerformanceEntry ::=
SEQUENCE {
ifcSpeedPerformanceIndex
INTEGER,
ifcSpeedPerformanceDescr
DisplayString,
ifcSpeedPerformanceTxBit
INTEGER,
ifcSpeedPerformanceRxBit
INTEGER
}

ATOS User Guide


Appendix A : private MIB - 325 / 483

ifcSpeedPerformanceIndex OBJECT-TYPE
SYNTAX INTEGER (1..1000)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"A unique value for each interface. Its value ranges
between 1 and the value of ifNumber (ifTable). This value
is the same of ifIndex (ifTable)."
::= { ifcSpeedPerformanceEntry 1 }

ifcSpeedPerformanceDescr OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..255))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"A textual string containing information about the
interface. This value is the same of ifDescr (ifTable)."
::= { ifcSpeedPerformanceEntry 2 }

ifcSpeedPerformanceTxBit OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The current transmitted througthput, in bits per second."
::= { ifcSpeedPerformanceEntry 3 }

ifcSpeedPerformanceRxBit OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The current received througthput, in bits per second."
::= { ifcSpeedPerformanceEntry 4 }

ATOS User Guide


Appendix A : private MIB - 326 / 483

pingFromCpeToGenericIp OBJECT IDENTIFIER ::= { genericMib 3 }

pingParameters OBJECT IDENTIFIER ::= { pingFromCpeToGenericIp 1 }

pingToIp OBJECT-TYPE
SYNTAX IpAddress
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The ip address of the ip node that the CPE has to ping.
This object contains the last ip address which the CPE has
made the ping."
::= { pingParameters 1 }

pingPacketNumbers OBJECT-TYPE
SYNTAX INTEGER (0..10)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"Number of icmp echo request packets (max. 10) that the CPE
has to send to pingToIp. This object contains the number
of icmp echo requests that the CPE has send during the
last ping."
::= { pingParameters 2 }

pingStatistics OBJECT IDENTIFIER ::= { pingFromCpeToGenericIp 2 }

pingTransmittedPackets OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Number of icmp echo requests transmitted to the ip node
specified in pingToIp (pingParameters). When a manager

ATOS User Guide


Appendix A : private MIB - 327 / 483

sends a GET for this object, the CPE will start the ping
procedure (with the parameters specified in
pingParameters) and return the value."
::= { pingStatistics 1 }

pingReceivedPackets OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Number of icmp echo replay packets received from the ip
node specified in pingToIp (pingParameters). When a
manager sends a GET for this object, the CPE will start
the ping procedure (with the parameters specified in
pingParameters) and return the value."
::= { pingStatistics 2 }

pingLostPackets OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Number of lost packets during the ping procedure. When a
manager sends a GET for this object, the CPE will start
the ping procedure (with the parameters specified in
pingParameters) and return the value."
::= { pingStatistics 3 }

tftpServices OBJECT IDENTIFIER ::= { genericMib 4 }

tftpRemoteServerAddress OBJECT-TYPE
SYNTAX IpAddress
ACCESS read-write
STATUS mandatory
DESCRIPTION

ATOS User Guide


Appendix A : private MIB - 328 / 483

"The IP address of the remote TFTP server."


::= { tftpServices 1 }

tftpRemoteFileName OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..32))
ACCESS read-write
STATUS mandatory
DESCRIPTION
"In download operations, it is the name of the remote image
file that will be downloaded when the download procedure
starts. If necessary, the name should include the full
directory path where the file is stored on the TFTP server.
In upload operations, it is the name of the file image that
will be uploaded in the TFTP server when the upload procedure
starts."
::= { tftpServices 2 }

tftpLocalFileName OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..32))
ACCESS read-write
STATUS mandatory
DESCRIPTION
"In download operations, this object make sense if the
tftpFileType value is 'generic': it is the full local
directory pathname where the generic file will be stored
when a download procedure starts.
In upload operations, it is the name of the local file that
will be transmitted when an upload procedure stars."
::= { tftpServices 3 }

tftpFileType OBJECT-TYPE
SYNTAX INTEGER
{
code(1),
conf(2),

ATOS User Guide


Appendix A : private MIB - 329 / 483

boot(3),
generic(4)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The type of the file that will be download/upload when the
procedure starts. 'code' is the ATOS firmware, 'conf' is the
configuration file, 'boot' is the boot file, 'generic' is a
generic file. In upload procedures, we can use only 'conf' or
'generic' values."
::= { tftpServices 4 }

tftpStartDownload OBJECT-TYPE
SYNTAX INTEGER
{
noAction(1),
start(2)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The value 'noAction' is always reported in a GET message.
The value 'start' in a SET message will cause the CPE to
initiate a TFTP session with the IP address of the TFTP
server identified in 'tftpRemoteServerAddress'. The
CPE will request from the specified server the file
identified in 'tftpRemoteFileName'."
::= { tftpServices 5 }

tftpStartUpload OBJECT-TYPE
SYNTAX INTEGER
{
noAction(1),
start(2)

ATOS User Guide


Appendix A : private MIB - 330 / 483

}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The value 'noAction' is always reported in a GET message.
The value 'start' in a SET message will cause the CPE to
initiate a TFTP session with the IP address of the TFTP
server identified in 'tftpRemoteServerAddress'. The
CPE will upload the file identified in 'tftpLocalFileName'."
::= { tftpServices 6 }

tftpSessionStatus OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..64))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object reports the status of the last TFTP session. If a
TFTP session has never been active since the CPE has booted,
a null string is reported."
::= { tftpServices 7 }

atosGenericAlarm OBJECT-TYPE
SYNTAX DisplayString
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object is used to send generic string alarm messages
through private traps, when a particular condition occurs.
This value makes sense only in a generic private trap: if
a manager sends a GET for read this object, the CPE
responds with a 'no such name' message."
::= { genericMib 5 }

atosReboot OBJECT-TYPE
SYNTAX INTEGER

ATOS User Guide


Appendix A : private MIB - 331 / 483

{
noAction(1),
rebootCPE(2)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The value 'noAction' is always reported in a GET. The value
'rebootCPE' in a SET will cause the CPE to reboot."
::= { genericMib 11 }

lesMib OBJECT IDENTIFIER ::= { atos 2 }

cpIwfParameters OBJECT IDENTIFIER ::= { lesMib 1 }

cpIwfTimingReference OBJECT-TYPE
SYNTAX INTEGER
{
ntr(1),
adaptive(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The system clock mode for all CP-IWFs."
::= { cpIwfParameters 1 }

cpIwfTable OBJECT-TYPE
SYNTAX SEQUENCE OF CpIwfEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"CP-IWF generic parameters. There is an entry for each
CP-IWF configured in the CPE."
::= { cpIwfParameters 2 }

ATOS User Guide


Appendix A : private MIB - 332 / 483

cpIwfEntry OBJECT-TYPE
SYNTAX CpIwfEntry
ACCESS not-accessible
STATUS mandatory
INDEX { cpIwfIndex }
::= { cpIwfTable 1 }

CpIwfEntry ::=
SEQUENCE {
cpIwfIndex
INTEGER,
cpIwfEchoCancellationSupport
INTEGER,
cpIwfSignalingProtocol
INTEGER,
cpIwfVoiceGateway
INTEGER,
cpIwfElcpandPstnChannelBandwidth
INTEGER,
cpIwfPlayoutBufferDelay
INTEGER,
cpIwfImpairmentInterval
INTEGER,
cpIwfImpairmentThreshold
INTEGER,
cpIwfMwdForRestart
INTEGER,
cpIwfEocBandwidth
INTEGER,
cpIwfTrapGeneration
INTEGER
}

cpIwfIndex OBJECT-TYPE

ATOS User Guide


Appendix A : private MIB - 333 / 483

SYNTAX INTEGER (1..100)


ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number that identify the CP-IWF, a unique value for
each CP-IWF."
::= { cpIwfEntry 1 }

cpIwfEchoCancellationSupport OBJECT-TYPE
SYNTAX INTEGER
{
no(1),
yes(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Specifies whether or not the echo cancellation facility is
supported or not supported at the CP-IWF."
::= { cpIwfEntry 2 }

cpIwfSignalingProtocol OBJECT-TYPE
SYNTAX INTEGER
{
elcp(1),
voiceband(2),
cas(3),
none(4)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Signaling protocol for the cpiwf, according to ATM Forum
AF-0145.000. elcp(1) enables the CCS/ELCP protocol, cas(2)
enables the CAS protocol, voiceband(3) enables the Paradyne-

ATOS User Guide


Appendix A : private MIB - 334 / 483

Jetstream proprietary protocol, and none(4) enables the CCS


protocol (static CIDs association)."
::= { cpIwfEntry 3 }

cpIwfVoiceGateway OBJECT-TYPE
SYNTAX INTEGER
{
generic(1),
tdsoft(2),
zhone(3),
paradyne(4),
alcatel(5)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The Voice Gateway on the CO-side."
::= { cpIwfEntry 4 }

cpIwfElcpandPstnChannelBandwidth OBJECT-TYPE
SYNTAX INTEGER (0..128000)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The approximate maximum bandwidth of the aal2 connection
with CID=8 used to transport ELCP and PSTN signalling
messages specified in bits per second at the physical
layer."
DEFVAL { 64000 }
::= { cpIwfEntry 5 }

cpIwfPlayoutBufferDelay OBJECT-TYPE
SYNTAX INTEGER (0..200)
ACCESS read-only
STATUS mandatory

ATOS User Guide


Appendix A : private MIB - 335 / 483

DESCRIPTION
"The amount of packet delay variation to be accommodated on
all ports of the CP-IWF, in milliseconds."
DEFVAL { 20 }
::= { cpIwfEntry 6 }

cpIwfImpairmentInterval OBJECT-TYPE
SYNTAX INTEGER (0..720)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The period over which voice impairments should be counted
to determine whether a threshold-crossing event has
occurred, in minutes."
DEFVAL { 15 }
::= { cpIwfEntry 7 }

cpIwfImpairmentThreshold OBJECT-TYPE
SYNTAX INTEGER (0..2147483647)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"If the number of impairment octets, calculated as the sum
of fillerOctets and droppedOctets, that is observed on any
individual POTS port or ISDN BRI port/channel during any
interval of length cpIwfImpairmentInterval minutes is
equal to or greater than cpIwfImpairmentThreshold, then
the trap cpIwfExcessImpairment will be sent to the CO-IWF.
A value of zero will disable the reporting of excess
impairments."
DEFVAL { 0 }
::= { cpIwfEntry 8 }

cpIwfMwdForRestart OBJECT-TYPE
SYNTAX INTEGER

ATOS User Guide


Appendix A : private MIB - 336 / 483

ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object defines the maximum waiting delay (MWD) in
seconds used during restart. When this CP-IWF is powered
on, it shall initiate a restart timer to a random value,
uniformly distributed between 0 and the value of this
object. Upon expiry of this timer or when activity is
detected this CP-IWF shall send a coldStart Trap to its
peer CO-IWF and initiate the restart procedure."
DEFVAL { 600 }
::= { cpIwfEntry 9 }

cpIwfEocBandwidth OBJECT-TYPE
SYNTAX INTEGER (300..640000)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Provides the approximate maximum bandwidth of the EOC in
bits per second at the physical layer."
DEFVAL { 32000 }
::= { cpIwfEntry 10 }

cpIwfTrapGeneration OBJECT-TYPE
SYNTAX INTEGER
{
enabled(1),
disabled(2),
coldStartOnly(3)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The Trap 'LES-specific' types enabled on the CPE."
::= { cpIwfEntry 11 }

ATOS User Guide


Appendix A : private MIB - 337 / 483

cpIwfAtmTable OBJECT-TYPE
SYNTAX SEQUENCE OF CpIwfAtmEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"CP-IWF Atm parameters. There is an entry for each CP-IWF
configured in the CPE."
::= { cpIwfParameters 3 }

cpIwfAtmEntry OBJECT-TYPE
SYNTAX CpIwfAtmEntry
ACCESS not-accessible
STATUS mandatory
INDEX { cpIwfAtmIndex }
::= { cpIwfAtmTable 1 }

CpIwfAtmEntry ::=
SEQUENCE {
cpIwfAtmIndex
INTEGER,
cpIwfAtmVpi
INTEGER,
cpIwfAtmVci
INTEGER,
cpIwfAtmTrafficType
INTEGER,
cpIwfAtmPCR
INTEGER,
cpIwfAtmSCR
INTEGER,
cpIwfAtmMBS
INTEGER
}

ATOS User Guide


Appendix A : private MIB - 338 / 483

cpIwfAtmIndex OBJECT-TYPE
SYNTAX INTEGER (1..100)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number that identify the ATM parameters group of a
CP-IWF, a unique value for each CP-IWF."
::= { cpIwfAtmEntry 1 }

cpIwfAtmVpi OBJECT-TYPE
SYNTAX INTEGER (0..255)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The VPI of the AAL2 VCC to which the CP-IWF is associated."
::= { cpIwfAtmEntry 2 }

cpIwfAtmVci OBJECT-TYPE
SYNTAX INTEGER (32..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The VCI of the AAL2 VCC to which the CP-IWF is associated."
::= { cpIwfAtmEntry 3 }

cpIwfAtmTrafficType OBJECT-TYPE
SYNTAX INTEGER
{
cbr(1),
vbr-rt(4),
vbr-nrt(5)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION

ATOS User Guide


Appendix A : private MIB - 339 / 483

"The traffic type on the selected CP-IWF."


::= { cpIwfAtmEntry 4 }

cpIwfAtmPCR OBJECT-TYPE
SYNTAX INTEGER (0..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Peak Cell Rate, in Kbit/sec."
::= { cpIwfAtmEntry 5 }

cpIwfAtmSCR OBJECT-TYPE
SYNTAX INTEGER (0..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Sustainable Cell Rate, in Kbit/sec (only for vbr-rt and
vbr-nrt traffic type)."
::= { cpIwfAtmEntry 6 }

cpIwfAtmMBS OBJECT-TYPE
SYNTAX INTEGER (0..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Maximum Burst Size, in ATM cell (only for vbr-rt and
vbr-nrt traffic type)."
::= { cpIwfAtmEntry 7 }

cpIwfAAL2Table OBJECT-TYPE
SYNTAX SEQUENCE OF CpIwfAAL2Entry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"CP-IWF AAL2 parameters. There is an entry for each CP-IWF

ATOS User Guide


Appendix A : private MIB - 340 / 483

configured in the CPE."


::= { cpIwfParameters 4 }

cpIwfAAL2Entry OBJECT-TYPE
SYNTAX CpIwfAAL2Entry
ACCESS not-accessible
STATUS mandatory
INDEX { cpIwfAAL2Index }
::= { cpIwfAAL2Table 1 }

CpIwfAAL2Entry ::=
SEQUENCE {
cpIwfAAL2Index
INTEGER,
cpIwfAAL2DefaultProfile
INTEGER,
cpIwfAAL2CpsMaxSDULen
INTEGER,
cpIwfAAL2CpsOptimisation
INTEGER,
cpIwfAAL2TimerCU
INTEGER,
cpIwfAAL2SSCSPcmEncoding
INTEGER,
cpIwfAAL2SscsSsSarAssemblyTimerValue
INTEGER
}

cpIwfAAL2Index OBJECT-TYPE
SYNTAX INTEGER (1..100)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number that identify the AAL2 parameters group of a
CP-IWF, a unique value for each CP-IWF."

ATOS User Guide


Appendix A : private MIB - 341 / 483

::= { cpIwfAAL2Entry 1 }

cpIwfAAL2DefaultProfile OBJECT-TYPE
SYNTAX INTEGER
{
itu-prof1(1),
itu-prof2(2),
atm-prof7(3),
atm-prof8(4),
atm-prof9(5),
atm-prof10(6),
atm-prof11(7),
atm-prof12(8)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"When a new (POTS or ISDN) port is added to a CP-IWF, this
is the default profile for the CP-IWF ports.
ITU Prof.1: PCM-64, 40 octet packets, without silence.
ITU Prof.2: PCM-64, 40 octet packets, with silence.
ATM Prof.7: PCM-64, ADPCM-32, 44 octet packets, silence.
ATM Prof.8: PCM-64, 44 octet packets, silence.
ATM Prof.9: PCM-64, 44 octet packets, without silence.
ATM Prof.10: PCM-64, ADPCM-32, 44 octet packets, without silence.
ATM Prof.11: PCM-64, ADPCM-32, 40 octet packets, without silence.
ATM Prof.12: PCM-64, ADPCM-32, 44 octet packets, with silence."
::= { cpIwfAAL2Entry 2 }

cpIwfAAL2CpsMaxSDULen OBJECT-TYPE
SYNTAX INTEGER (45..64)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Maximum CPS-SDU size given in octets. Permitted values are

ATOS User Guide


Appendix A : private MIB - 342 / 483

45 and 64."
DEFVAL { 45 }
::= { cpIwfAAL2Entry 3 }

cpIwfAAL2CpsOptimisation OBJECT-TYPE
SYNTAX INTEGER
{
on(1),
off(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The status (on/off) of the CPS optimisation."
::= { cpIwfAAL2Entry 4 }

cpIwfAAL2TimerCU OBJECT-TYPE
SYNTAX INTEGER (0..2147483647)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This parameter specifies the value of the Timer_CU, in
msec, for this AAL2 entry. "
DEFVAL { 0 }
::= { cpIwfAAL2Entry 5 }

cpIwfAAL2SSCSPcmEncoding OBJECT-TYPE
SYNTAX INTEGER
{
aLaw(1),
uLaw(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION

ATOS User Guide


Appendix A : private MIB - 343 / 483

"This attribute describes the type of PCM encoding used."


DEFVAL { aLaw }
::= { cpIwfAAL2Entry 6 }

cpIwfAAL2SscsSsSarAssemblyTimerValue OBJECT-TYPE
SYNTAX INTEGER (0..2147483647)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object specifies the value of the segmentation
reassembly timer, in msec, for I.366.1 SAR. The default
value specified for this timer is effectively an infinite
value per I.366.1."
DEFVAL { 2147483647 }
::= { cpIwfAAL2Entry 7 }

cpIwfPotsTable OBJECT-TYPE
SYNTAX SEQUENCE OF CpIwfPotsEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"CP-IWF POTS port parameters. There are two objects to
address an entry in the table: cpIwfPotsLineIndex (that
identify the CP-IWF) and cpIwfPotsLineNumber (that
identify the POTS port line)."
::= { cpIwfParameters 5 }

cpIwfPotsEntry OBJECT-TYPE
SYNTAX CpIwfPotsEntry
ACCESS not-accessible
STATUS mandatory
INDEX { cpIwfPotsPortIndex, cpIwfPotsPortNumber }
::= { cpIwfPotsTable 1 }

CpIwfPotsEntry ::=

ATOS User Guide


Appendix A : private MIB - 344 / 483

SEQUENCE {
cpIwfPotsPortIndex
INTEGER,
cpIwfPotsPortNumber
INTEGER,
cpIwfPotsDescription
OCTET STRING,
cpIwfPotsPhysicalPort
INTEGER,
cpIwfPotsPortEchoCancellation
INTEGER,
cpIwfPotsPortProfileId
INTEGER,
cpIwfPotsEmergencyStatus
INTEGER,
cpIwfPotsPortTxLoopGain
INTEGER,
cpIwfPotsPortRxLoopGain
INTEGER,
cpIwfPotsPortStatus
INTEGER,
cpIwfPotsPortMeasuredCapacity
INTEGER,
cpIwfPotsPortRingStatus
INTEGER
}

cpIwfPotsPortIndex OBJECT-TYPE
SYNTAX INTEGER (1..100)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number that identify the CP-IWF, a unique value for
each CP-IWF."
::= { cpIwfPotsEntry 1 }

ATOS User Guide


Appendix A : private MIB - 345 / 483

cpIwfPotsPortNumber OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Identify a POTS port of a particular CP-IWF."
::= { cpIwfPotsEntry 2 }

cpIwfPotsDescription OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-only
STATUS mandatory
DESCRIPTION
"A textual description of the specified POTS port."
::= { cpIwfPotsEntry 3 }

cpIwfPotsPhysicalPort OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The physical where the selected POTS port is mapped. The
value of zero (0) means that this POTS port isn't
connected to any physical port on the LES device."
::= { cpIwfPotsEntry 4 }

cpIwfPotsPortEchoCancellation OBJECT-TYPE
SYNTAX INTEGER
{
off(1),
on(2)
}
ACCESS read-only
STATUS mandatory

ATOS User Guide


Appendix A : private MIB - 346 / 483

DESCRIPTION
"This object specifies if the echo cancellation is off(1)
or on(2) on the specified POTS port. This object makes
sense only if the cpIwfEchoCancellationSupport value for
the CP-IWF where the POTS port relais is yes(2)."
::= { cpIwfPotsEntry 5 }

cpIwfPotsPortProfileId OBJECT-TYPE
SYNTAX INTEGER
{
itu-prof1(1),
itu-prof2(2),
atm-prof7(3),
atm-prof8(4),
atm-prof9(5),
atm-prof10(6),
atm-prof11(7),
atm-prof12(8)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Describe the voice profile for the selected POTS port.
ITU Prof.1: PCM-64, 40 octet packets, without silence.
ITU Prof.2: PCM-64, 40 octet packets, with silence.
ATM Prof.7: PCM-64, ADPCM-32, 44 octet packets, silence.
ATM Prof.8: PCM-64, 44 octet packets, silence.
ATM Prof.9: PCM-64, 44 octet packets, without silence.
ATM Prof.10: PCM-64, ADPCM-32, 44 octet packets, without silence.
ATM Prof.11: PCM-64, ADPCM-32, 40 octet packets, without silence.
ATM Prof.12: PCM-64, ADPCM-32, 44 octet packets, with silence."
::= { cpIwfPotsEntry 6 }

cpIwfPotsEmergencyStatus OBJECT-TYPE
SYNTAX INTEGER

ATOS User Guide


Appendix A : private MIB - 347 / 483

{
off(1),
on(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This parameter specifies if the selected POTS port is
off(1) or on(2) when the CPE will be powered by a backup
power supply system (named UPS module)."
::= { cpIwfPotsEntry 7 }

cpIwfPotsPortTxLoopGain OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Transmit level (in dBr) on the specific POTS port. Its
value ranges between -12 to 4."
::= { cpIwfPotsEntry 8 }

cpIwfPotsPortRxLoopGain OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Receive level (in dBr) on the specific POTS port. Its
value ranges between -12 to 4."
::= { cpIwfPotsEntry 9 }

cpIwfPotsPortStatus OBJECT-TYPE
SYNTAX INTEGER
{
idle(1),
busy(2)

ATOS User Guide


Appendix A : private MIB - 348 / 483

}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The status of the POTS port."
::= { cpIwfPotsEntry 10 }

cpIwfPotsPortMeasuredCapacity OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The capacity (in nF) of the POTS port. This object makes
sense only if cpIwfPotsPortStatus value is 2 (idle)."
::= { cpIwfPotsEntry 11 }

cpIwfPotsPortRingStatus OBJECT-TYPE
SYNTAX INTEGER
{
ok(1),
fault(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The status of the ring voltage battery on the POTS port.
This object makes sense only if cpIwfPotsPortStatus value
is 2 (idle)."
::= { cpIwfPotsEntry 12 }

cpIwfIsdnTable OBJECT-TYPE
SYNTAX SEQUENCE OF CpIwfIsdnEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION

ATOS User Guide


Appendix A : private MIB - 349 / 483

"CP-IWF ISDN port parameters. There are two objects to


address an entry in the table: cpIwfIsdnLineIndex (that
identify the CP-IWF) and cpIwfIsdnLineNumber (that
identify the ISDN port line)."
::= { cpIwfParameters 6 }

cpIwfIsdnEntry OBJECT-TYPE
SYNTAX CpIwfIsdnEntry
ACCESS not-accessible
STATUS mandatory
INDEX { cpIwfIsdnPortIndex, cpIwfIsdnPortNumber }
::= { cpIwfIsdnTable 1 }

CpIwfIsdnEntry ::=
SEQUENCE {
cpIwfIsdnPortIndex
INTEGER,
cpIwfIsdnPortNumber
INTEGER,
cpIwfIsdnDescription
OCTET STRING,
cpIwfIsdnPhysicalPort
INTEGER,
cpIwfIsdnPortEchoCancellation
INTEGER,
cpIwfIsdnPortProfileId
INTEGER,
cpIwfIsdnEmergencyStatus
INTEGER,
cpIwfIsdnPortPermanentActivation
INTEGER
}

cpIwfIsdnPortIndex OBJECT-TYPE
SYNTAX INTEGER (1..100)

ATOS User Guide


Appendix A : private MIB - 350 / 483

ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number that identify the CP-IWF, a unique value for
each CP-IWF."
::= { cpIwfIsdnEntry 1 }

cpIwfIsdnPortNumber OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Identify a ISDN port of a particular CP-IWF."
::= { cpIwfIsdnEntry 2 }

cpIwfIsdnDescription OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-only
STATUS mandatory
DESCRIPTION
"A textual description of the specified ISDN port."
::= { cpIwfIsdnEntry 3 }

cpIwfIsdnPhysicalPort OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The physical where the selected ISDN port is mapped. The
value of zero (0) means that this ISDN port isn't
connected to any physical port on the LES device."
::= { cpIwfIsdnEntry 4 }

cpIwfIsdnPortEchoCancellation OBJECT-TYPE
SYNTAX INTEGER

ATOS User Guide


Appendix A : private MIB - 351 / 483

{
off(1),
on(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object specifies if the echo cancellation is off(1)
or on(2) on the specified ISDN port. This object makes
sense only if the cpIwfEchoCancellationSupport value for
the CP-IWF where the ISDN port relais is yes(2)."
::= { cpIwfIsdnEntry 5 }

cpIwfIsdnPortProfileId OBJECT-TYPE
SYNTAX INTEGER
{
itu-prof1(1),
itu-prof2(2),
atm-prof7(3),
atm-prof8(4),
atm-prof9(5),
atm-prof10(6),
atm-prof11(7),
atm-prof12(8)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Describe the voice profile for the selected ISDN port.
ITU Prof.1: PCM-64, 40 octet packets, without silence.
ITU Prof.2: PCM-64, 40 octet packets, with silence.
ATM Prof.7: PCM-64, ADPCM-32, 44 octet packets, silence.
ATM Prof.8: PCM-64, 44 octet packets, silence.
ATM Prof.9: PCM-64, 44 octet packets, without silence.
ATM Prof.10: PCM-64, ADPCM-32, 44 octet packets, without silence.

ATOS User Guide


Appendix A : private MIB - 352 / 483

ATM Prof.11: PCM-64, ADPCM-32, 40 octet packets, without silence.


ATM Prof.12: PCM-64, ADPCM-32, 44 octet packets, with silence."
::= { cpIwfIsdnEntry 6 }

cpIwfIsdnEmergencyStatus OBJECT-TYPE
SYNTAX INTEGER
{
off(1),
on(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This parameter specifies if the selected ISDN port is
off(1) or on(2) when the CPE will be powered by a backup
power supply system (named UPS module)."
::= { cpIwfIsdnEntry 7 }

cpIwfIsdnPortPermanentActivation OBJECT-TYPE
SYNTAX INTEGER
{
off(1),
on(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object specifies if the permanent actiovation of the
layer 1 on the selected ISDN port is off(1) or on(2)."
::= { cpIwfIsdnEntry 8 }

upsMib OBJECT IDENTIFIER ::= { atos 3 }

isNetworkPresent OBJECT-TYPE
SYNTAX INTEGER

ATOS User Guide


Appendix A : private MIB - 353 / 483

{
unknowStatus(48),
pd(68),
pu(85)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This node states if the network is present (pu) or not
present (pd)."
::= { upsMib 1 }

batteryLoadPercentage OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The load percentage of the battery."
::= { upsMib 2 }

batteryDegradationPercentage OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The degradation percentage of the battery,"
::= { upsMib 3 }

batteryVoltage OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..5))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The current charge (in volts) of the battery."
::= { upsMib 4 }

ATOS User Guide


Appendix A : private MIB - 354 / 483

batteryCurrentStatus OBJECT-TYPE
SYNTAX INTEGER
{
unknowBatteryStatus(48),
bd(68),
bf(70),
bm(77),
bs(83)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The current status of the battery: bd for 'battery discharging',
bf for 'battery out of service', bm for 'battery charging',
bs for 'battery stand-by'."
::= { upsMib 5 }

upsTrapsEnable OBJECT IDENTIFIER ::= { upsMib 6 }

networkTrapEnable OBJECT-TYPE
SYNTAX INTEGER
{
on(1),
off(2)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"Enable/disable the specific trap for network status."
::= { upsTrapsEnable 1 }

batteryChargeLowTrapEnable OBJECT-TYPE
SYNTAX INTEGER
{

ATOS User Guide


Appendix A : private MIB - 355 / 483

on(1),
off(2)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"Enable/disable the specific trap for battery discharging."
::= { upsTrapsEnable 2 }

batteryDecayTrapEnable OBJECT-TYPE
SYNTAX INTEGER
{
on(1),
off(2)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"Enable/disable the specific trap for battery degradating."
::= { upsTrapsEnable 3 }

batteryOutOfServiceTrapEnable OBJECT-TYPE
SYNTAX INTEGER
{
on(1),
off(2)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"Enable/disable the specific trap for battery out of service."
::= { upsTrapsEnable 4 }

ntpMib OBJECT IDENTIFIER ::= { atos 4 }

ATOS User Guide


Appendix A : private MIB - 356 / 483

ntpE1 OBJECT IDENTIFIER ::= { ntpMib 1 }

ntpE1Table OBJECT-TYPE
SYNTAX SEQUENCE OF NtpE1Entry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"The E1 interfaces parameter table."
::= { ntpE1 1 }

ntpE1Entry OBJECT-TYPE
SYNTAX NtpE1Entry
ACCESS not-accessible
STATUS mandatory
INDEX { ntpE1UserIndex, ntpE1IfcIndex }
::= { ntpE1Table 1 }

NtpE1Entry ::=
SEQUENCE {
ntpE1UserIndex
INTEGER,
ntpE1IfcIndex
INTEGER,
ntpE1Crc4
INTEGER,
ntpE1ClockMode
INTEGER
}

ntpE1UserIndex OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The CPE can have up to 4 multiservice units."

ATOS User Guide


Appendix A : private MIB - 357 / 483

::= {
ntpE1Entry 1 }

ntpE1IfcIndex OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This value identifies an E1 interface index."
::= { ntpE1Entry 2 }

ntpE1Crc4 OBJECT-TYPE
SYNTAX INTEGER
{
off(1),
on(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Describe if the CRC4 mode is in use."
::= { ntpE1Entry 3 }

ntpE1ClockMode OBJECT-TYPE
SYNTAX INTEGER
{
master(1),
slave(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The clock mode for this E1 interface."
::= { ntpE1Entry 4 }

ATOS User Guide


Appendix A : private MIB - 358 / 483

ntpE1BundleTable OBJECT-TYPE
SYNTAX SEQUENCE OF NtpE1BundleEntry
ACCESS not-accessible
STATUS mandatory
::= { ntpE1 2 }

ntpE1BundleEntry OBJECT-TYPE
SYNTAX NtpE1BundleEntry
ACCESS not-accessible
STATUS mandatory
INDEX { ntpE1BundleUserIndex, ntpE1BundleIfcIndex, ntpE1BundleIndex }
::= { ntpE1BundleTable 1 }

NtpE1BundleEntry ::=
SEQUENCE {
ntpE1BundleUserIndex
INTEGER,
ntpE1BundleIfcIndex
INTEGER,
ntpE1BundleIndex
INTEGER,
ntpE1BundleTimeSlot
OCTET STRING
}

ntpE1BundleUserIndex OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The CPE can have up to 4 multiservice units."
::= { ntpE1BundleEntry 1 }

ntpE1BundleIfcIndex OBJECT-TYPE
SYNTAX INTEGER (1..4)

ATOS User Guide


Appendix A : private MIB - 359 / 483

ACCESS read-only
STATUS mandatory
DESCRIPTION
"This value identifies an E1 interface interface."
::= { ntpE1BundleEntry 2 }

ntpE1BundleIndex OBJECT-TYPE
SYNTAX INTEGER (1..32)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The index which identifies a specific bundle."
::= { ntpE1BundleEntry 3 }

ntpE1BundleTimeSlot OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..255))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The Time Slot list of the bundle."
::= { ntpE1BundleEntry 4 }

ntpSerial OBJECT IDENTIFIER ::= { ntpMib 2 }

ntpSerialTable OBJECT-TYPE
SYNTAX SEQUENCE OF NtpSerialEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"The Serial interfaces parameters table."
::= { ntpSerial 1 }

ntpSerialEntry OBJECT-TYPE
SYNTAX NtpSerialEntry
ACCESS not-accessible

ATOS User Guide


Appendix A : private MIB - 360 / 483

STATUS mandatory
INDEX { ntpSerialUserIndex, ntpSerialIfcIndex }
::= { ntpSerialTable 1 }

NtpSerialEntry ::=
SEQUENCE {
ntpSerialUserIndex
INTEGER,
ntpSerialIfcIndex
INTEGER,
ntpSerialSpeed
INTEGER,
ntpSerialType
INTEGER
}

ntpSerialUserIndex OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The CPE can have up to 4 multiservice units."
::= { ntpSerialEntry 1 }

ntpSerialIfcIndex OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This value identifies a serial
::= { ntpSerialEntry 2 }

ntpSerialSpeed OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only

interface index."

ATOS User Guide


Appendix A : private MIB - 361 / 483

STATUS mandatory
DESCRIPTION
"The speed for the selected serial interface, in Kbit/sec."
::= { ntpSerialEntry 3 }

ntpSerialType OBJECT-TYPE
SYNTAX INTEGER
{
v11(1),
v35(2),
v36(3)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The type of the selected serial interface."
::= { ntpSerialEntry 4 }

ntpAtm OBJECT IDENTIFIER ::= { ntpMib 3 }

ntpAtmTable OBJECT-TYPE
SYNTAX SEQUENCE OF NtpAtmEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"The ATM interfaces parameters table."
::= { ntpAtm 1 }

ntpAtmEntry OBJECT-TYPE
SYNTAX NtpAtmEntry
ACCESS not-accessible
STATUS mandatory
INDEX { ntpAtmUserIndex, ntpAtmIfcIndex }
::= { ntpAtmTable 1 }

ATOS User Guide


Appendix A : private MIB - 362 / 483

NtpAtmEntry ::=
SEQUENCE {
ntpAtmUserIndex
INTEGER,
ntpAtmIfcIndex
INTEGER,
ntpAtmVpi
INTEGER,
ntpAtmVci
INTEGER,
ntpAtmTrafficType
INTEGER,
ntpAtmPCR
INTEGER,
ntpAtmSCR
INTEGER,
ntpAtmMBS
INTEGER
}

ntpAtmUserIndex OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The CPE can have up to 4 multiservice units."
::= { ntpAtmEntry 1 }

ntpAtmIfcIndex OBJECT-TYPE
SYNTAX INTEGER (1..128)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Within a multiservice unit, this is a unique value for
each ATM interface that will be used in the interworking

ATOS User Guide


Appendix A : private MIB - 363 / 483

functions."
::= { ntpAtmEntry 2 }

ntpAtmVpi OBJECT-TYPE
SYNTAX INTEGER (0..255)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The VPI for this ATM channel."
::= { ntpAtmEntry 3 }

ntpAtmVci OBJECT-TYPE
SYNTAX INTEGER (0..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The VCI for this ATM channel."
::= { ntpAtmEntry 4 }

ntpAtmTrafficType OBJECT-TYPE
SYNTAX INTEGER
{
cbr(1),
vbrRt(2),
vbrNrt(3),
abr(4),
ubrPlus(5),
ubr(6)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The traffic type for this ATM channel."
::= { ntpAtmEntry 5 }

ATOS User Guide


Appendix A : private MIB - 364 / 483

ntpAtmPCR OBJECT-TYPE
SYNTAX INTEGER (0..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Peak Cell Rate, in Kbit/sec."
::= { ntpAtmEntry 6 }

ntpAtmSCR OBJECT-TYPE
SYNTAX INTEGER (0..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Sustainable Cell Rate, in Kbit/sec (only for VBR-rt and
VBR-nrt traffic type)."
::= { ntpAtmEntry 7 }

ntpAtmMBS OBJECT-TYPE
SYNTAX INTEGER (0..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Maximum Burst Size, in ATM cell (only for VBR-rt and
VBR-nrt traffic type)."
::= { ntpAtmEntry 8 }

ntpFrAtmIwf OBJECT IDENTIFIER ::= { ntpMib 4 }

ntpFrTable OBJECT-TYPE
SYNTAX SEQUENCE OF NtpFrEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"The Frame Relay parameters table."
::= { ntpFrAtmIwf 1 }

ATOS User Guide


Appendix A : private MIB - 365 / 483

ntpFrEntry OBJECT-TYPE
SYNTAX NtpFrEntry
ACCESS not-accessible
STATUS mandatory
INDEX { ntpFrUserIndex, ntpFrIfcIndex }
::= { ntpFrTable 1 }

NtpFrEntry ::=
SEQUENCE {
ntpFrUserIndex
INTEGER,
ntpFrIfcIndex
INTEGER,
ntpFrPortType
INTEGER,
ntpFrPortIdx
OCTET STRING,
ntpFrPortSubIdx
INTEGER,
ntpFrHdrBytes
INTEGER,
ntpFrLmiEnabled
INTEGER,
ntpFrLmiType
INTEGER,
ntpFrLmiBidirect
INTEGER,
ntpFrLmiFullStatusPolling
INTEGER,
ntpFrLmiErrorThreshold
INTEGER,
ntpFrLmiMonitoredEvent
INTEGER,
ntpFrLmiLinkIntegrityTimer

ATOS User Guide


Appendix A : private MIB - 366 / 483

INTEGER,
ntpFrLmiPollingTimer
INTEGER
}

ntpFrUserIndex OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The CPE can have up to 4 multiservice units."
::= { ntpFrEntry 1 }

ntpFrIfcIndex OBJECT-TYPE
SYNTAX INTEGER (1..32)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Within a multiservice unit, this is a unique value for
each Frame Relay interface that will be used in the
interworking functions."
::= { ntpFrEntry 2 }

ntpFrPortType OBJECT-TYPE
SYNTAX INTEGER
{
serial(1),
e1(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The type of the physical interface where this Frame Relay
is mapped. Serial parameters are in ntpSerial node and E1
bundle parameters are in ntpE1 node."

ATOS User Guide


Appendix A : private MIB - 367 / 483

::= { ntpFrEntry 3 }

ntpFrPortIdx OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The index of the physical interface where this Frame Relay
is mapped. If the ntpFrPortType value is 'serial', you can
use this index in the ntpSerialTable (ntpSerialIfcIndex).
If the ntpFrPortType value is 'e1', you can use it in the
ntpE1Table (ntpE1IfcIndex)."
::= { ntpFrEntry 4 }

ntpFrPortSubIdx OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"If ntpFrPortType value is 'e1', this object contains the
bundle index (ntpE1BundleIndex in the ntpE1BundleTable).
If ntpFrPortType value is 'serial', a GET to this object
return 0."
::= { ntpFrEntry 5 }

ntpFrHdrBytes OBJECT-TYPE
SYNTAX INTEGER (2..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of header bytes on this Frame Relay interface."
::= { ntpFrEntry 6 }

ntpFrLmiEnabled OBJECT-TYPE
SYNTAX INTEGER

ATOS User Guide


Appendix A : private MIB - 368 / 483

{
enabled(1),
disabled(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The attribute indicates whether LMI is enabled for this
Frame Relay interface."
DEFVAL { disabled }
::= { ntpFrEntry 7 }

ntpFrLmiType OBJECT-TYPE
SYNTAX INTEGER
{
ituLmiType(1),
ansiLmiType(2),
ciscoLmiType(3)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The LMI type for this Frame Relay interface. If the LMI is
disabled, the CPE responds with a 'no such name' message."
::= { ntpFrEntry 8 }

ntpFrLmiBidirect OBJECT-TYPE
SYNTAX INTEGER
{
off(1),
on(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION

ATOS User Guide


Appendix A : private MIB - 369 / 483

"The attribute indicates whether LMI bidirect is 'on' for


this Frame Relay interface. If the LMI is disabled, the
CPE responds with a 'no such name' message."
::= { ntpFrEntry 9 }

ntpFrLmiFullStatusPolling OBJECT-TYPE
SYNTAX INTEGER (1..255)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of full status polling counter for this Frame
Relay interface. If the LMI is disabled, the CPE responds
with a 'no such name' message."
DEFVAL { 6 }
::= { ntpFrEntry 10 }

ntpFrLmiErrorThreshold OBJECT-TYPE
SYNTAX INTEGER (1..10)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of the error threshold for this Frame Relay
interface. If the LMI is disabled, the CPE responds with a
'no such name' message."
DEFVAL { 3 }
::= { ntpFrEntry 11 }

ntpFrLmiMonitoredEvent OBJECT-TYPE
SYNTAX INTEGER (1..10)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of monitored event counter for this Frame Relay
interface. If the LMI is disabled, the CPE responds with a
'no such name' message."

ATOS User Guide


Appendix A : private MIB - 370 / 483

DEFVAL { 4 }
::= { ntpFrEntry 12 }

ntpFrLmiLinkIntegrityTimer OBJECT-TYPE
SYNTAX INTEGER (5..30)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The value (in seconds) of the link integrity verification
polling timer for this Frame Relay interface. If the LMI
is disabled, the CPE responds with a 'no such name'
message."
DEFVAL { 10 }
::= { ntpFrEntry 13 }

ntpFrLmiPollingTimer OBJECT-TYPE
SYNTAX INTEGER (5..30)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The value (in seconds) of the polling verification timer
for this frame Relay interface. If the LMI is disabled,
the CPE responds with a 'no such name' message."
DEFVAL { 15 }
::= { ntpFrEntry 14 }

ntpFrAtmIwfSiwConnTable OBJECT-TYPE
SYNTAX SEQUENCE OF NtpFrAtmIwfSiwConnEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"The Frame Relay/ATM PVC Service Interworking Function for
SIW connections. There is an entry for each SIW connection
configured in the CPE."
::= { ntpFrAtmIwf 2 }

ATOS User Guide


Appendix A : private MIB - 371 / 483

ntpFrAtmIwfSiwConnEntry OBJECT-TYPE
SYNTAX NtpFrAtmIwfSiwConnEntry
ACCESS not-accessible
STATUS mandatory
INDEX { ntpFrAtmIwfSiwConnUserIndex, ntpFrAtmIwfSiwConnIndex }
::= { ntpFrAtmIwfSiwConnTable 1 }

NtpFrAtmIwfSiwConnEntry ::=
SEQUENCE {
ntpFrAtmIwfSiwConnUserIndex
INTEGER,
ntpFrAtmIwfSiwConnIndex
INTEGER,
ntpFrAtmIwfSiwConnAtmPort
INTEGER,
ntpFrAtmIwfSiwConnFrPort
INTEGER,
ntpFrAtmIwfSiwConnDLCI
INTEGER,
ntpFrAtmIwfSiwConnAdminStatus
INTEGER,
ntpFrAtmIwfSiwConnAtmToFrOperStatus
INTEGER,
ntpFrAtmIwfSiwConnFrToAtmOperStatus
INTEGER,
ntpFrAtmIwfSiwConnDescriptor
INTEGER,
ntpFrAtmIwfSiwConnInvalidNLPID
Counter,
ntpFrAtmIwfSiwConnFrTooLongFrame
Counter,
ntpFrAtmIwfSiwConnInvalidLLC
Counter,
ntpFrAtmIwfSiwConnAtmTooLongFrame

ATOS User Guide


Appendix A : private MIB - 372 / 483

Counter,
ntpFrAtmIwfSiwConnCrcErrors
Counter
}

ntpFrAtmIwfSiwConnUserIndex OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The CPE can have up to 4 multiservice units."
::= { ntpFrAtmIwfSiwConnEntry 1 }

ntpFrAtmIwfSiwConnIndex OBJECT-TYPE
SYNTAX INTEGER (1..128)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Within a multiservice unit, this is a unique value for
each SIW connection."
::= { ntpFrAtmIwfSiwConnEntry 2 }

ntpFrAtmIwfSiwConnAtmPort OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The index in the ntpAtmTable that identifies the ATM port
for this interworking connection. If not configured, this
object value will be 0."
::= { ntpFrAtmIwfSiwConnEntry 3 }

ntpFrAtmIwfSiwConnFrPort OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only

ATOS User Guide


Appendix A : private MIB - 373 / 483

STATUS mandatory
DESCRIPTION
"The index in the ntpFrTable that identifies the Frame
Relay port for this interworking connection. If not
configured, this object value will be 0."
::= { ntpFrAtmIwfSiwConnEntry 4 }

ntpFrAtmIwfSiwConnDLCI OBJECT-TYPE
SYNTAX INTEGER (16..4194303)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The DLCI that identifies the frame relay PVC endpoint for
this SIW connection.

If not configured, this object value

will be 0."
::= { ntpFrAtmIwfSiwConnEntry 5 }

ntpFrAtmIwfSiwConnAdminStatus OBJECT-TYPE
SYNTAX INTEGER
{
up(1),
down(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The desired operational state for this Frame Relay/ATM
interworked connection.
"
::= { ntpFrAtmIwfSiwConnEntry 6 }

ntpFrAtmIwfSiwConnAtmToFrOperStatus OBJECT-TYPE
SYNTAX INTEGER
{
up(1),

ATOS User Guide


Appendix A : private MIB - 374 / 483

down(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The current operational state of this interworking
connection in the ATM to Frame Relay direction."
::= { ntpFrAtmIwfSiwConnEntry 7 }

ntpFrAtmIwfSiwConnFrToAtmOperStatus OBJECT-TYPE
SYNTAX INTEGER
{
up(1),
down(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The current operational state of this interworking
connection in the Frame Relay to ATM direction."
::= { ntpFrAtmIwfSiwConnEntry 8 }

ntpFrAtmIwfSiwConnDescriptor OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The index in the ntpFrAtmIwfSiwServiceTable that
identifies the service profile for this IWF connection."
::= { ntpFrAtmIwfSiwConnEntry 9 }

ntpFrAtmIwfSiwConnInvalidNLPID OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory

ATOS User Guide


Appendix A : private MIB - 375 / 483

DESCRIPTION
"This object counts the number of frames discarded by the
IWF because, while operating in Translation Mode, the IWF
is unable to decode the incoming Frame Relay payload
header (Frame Relay to ATM direction). When operating in
Transparent Mode, the CPE responds with a 'no such name'
message."
::= { ntpFrAtmIwfSiwConnEntry 10 }

ntpFrAtmIwfSiwConnFrTooLongFrame OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object counts the number of frames discarded by the
IWF because the frame is too large to be processed by the
AAL5 segmentation procedure (Frame Relay to ATM
direction)."
::= { ntpFrAtmIwfSiwConnEntry 11 }

ntpFrAtmIwfSiwConnInvalidLLC OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This attribute counts the number of AAL5 PDUs discarded by
the IWF because, while operating in Translation Mode, the
IWF is unable to decode the incoming AAL5 PDU payload
header (ATM to Frame Relay direction). When operating in
Transparent Mode, the CPE responds with a 'no such name'
message."
::= { ntpFrAtmIwfSiwConnEntry 12 }

ntpFrAtmIwfSiwConnAtmTooLongFrame OBJECT-TYPE
SYNTAX Counter

ATOS User Guide


Appendix A : private MIB - 376 / 483

ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object counts the number of frames discarded by the
IWF because the frame is too large to be forwarded on the
Frame Relay segment of the connection (ATM to Frame Relay
direction)."
::= { ntpFrAtmIwfSiwConnEntry 13 }

ntpFrAtmIwfSiwConnCrcErrors OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of AAL5 PDUs received with CRC-32 errors on
this AAL5 VCC at the IWF (ATM to Frame Relay direction)."
::= { ntpFrAtmIwfSiwConnEntry 14 }

ntpFrAtmIwfNiwConnTable OBJECT-TYPE
SYNTAX SEQUENCE OF NtpFrAtmIwfNiwConnEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"The Frame Relay/ATM PVC Service Interworking Function for
NIW connections."
::= { ntpFrAtmIwf 3 }

ntpFrAtmIwfNiwConnEntry OBJECT-TYPE
SYNTAX NtpFrAtmIwfNiwConnEntry
ACCESS not-accessible
STATUS mandatory
INDEX { ntpFrAtmIwfNiwConnUserIndex, ntpFrAtmIwfNiwConnIndex }
::= { ntpFrAtmIwfNiwConnTable 1 }

NtpFrAtmIwfNiwConnEntry ::=

ATOS User Guide


Appendix A : private MIB - 377 / 483

SEQUENCE {
ntpFrAtmIwfNiwConnUserIndex
INTEGER,
ntpFrAtmIwfNiwConnIndex
INTEGER,
ntpFrAtmIwfNiwConnAtmPort
INTEGER,
ntpFrAtmIwfNiwConnFrPort
INTEGER,
ntpFrAtmIwfNiwConnAdminStatus
INTEGER,
ntpFrAtmIwfNiwConnAtmToFrOperStatus
INTEGER,
ntpFrAtmIwfNiwConnFrToAtmOperStatus
INTEGER,
ntpFrAtmIwfNiwConnDescriptor
INTEGER,
ntpFrAtmIwfNiwConnFrTooLongFrame
Counter,
ntpFrAtmIwfNiwConnAtmTooLongFrame
Counter,
ntpFrAtmIwfNiwConnCrcErrors
Counter
}

ntpFrAtmIwfNiwConnUserIndex OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The CPE can have up to 4 multiservice units."
::= { ntpFrAtmIwfNiwConnEntry 1 }

ntpFrAtmIwfNiwConnIndex OBJECT-TYPE
SYNTAX INTEGER (1..128)

ATOS User Guide


Appendix A : private MIB - 378 / 483

ACCESS read-only
STATUS mandatory
DESCRIPTION
"The NIW connection index."
::= { ntpFrAtmIwfNiwConnEntry 2 }

ntpFrAtmIwfNiwConnAtmPort OBJECT-TYPE
SYNTAX INTEGER (1..128)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The index in the ntpAtmTable that identifies the ATM port
for this interworking connection."
::= { ntpFrAtmIwfNiwConnEntry 3 }

ntpFrAtmIwfNiwConnFrPort OBJECT-TYPE
SYNTAX INTEGER (1..32)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The index in the ntpFrTable that identifies the Frame
Relay port for this interworking connection."
::= { ntpFrAtmIwfNiwConnEntry 4 }

ntpFrAtmIwfNiwConnAdminStatus OBJECT-TYPE
SYNTAX INTEGER
{
up(1),
down(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The desired operational state for this Frame Relay/ATM
interworked connection.

ATOS User Guide


Appendix A : private MIB - 379 / 483

"
::= { ntpFrAtmIwfNiwConnEntry 5 }

ntpFrAtmIwfNiwConnAtmToFrOperStatus OBJECT-TYPE
SYNTAX INTEGER
{
up(1),
down(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The current operational state of this interworking
connection in the ATM to Frame Relay direction."
::= { ntpFrAtmIwfNiwConnEntry 6 }

ntpFrAtmIwfNiwConnFrToAtmOperStatus OBJECT-TYPE
SYNTAX INTEGER
{
up(1),
down(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The current operational state of this interworking
connection in the Frame Relay to ATM direction."
::= { ntpFrAtmIwfNiwConnEntry 7 }

ntpFrAtmIwfNiwConnDescriptor OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The index in the ntpFrAtmIwfNiwServiceTable that

ATOS User Guide


Appendix A : private MIB - 380 / 483

identifies the service profile for this IWF connection."


::= { ntpFrAtmIwfNiwConnEntry 8 }

ntpFrAtmIwfNiwConnFrTooLongFrame OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object counts the number of frames discarded by the
IWF because the frame is too large to be processed by the
AAL5 segmentation procedure (Frame Relay to ATM
direction)."
::= { ntpFrAtmIwfNiwConnEntry 9 }

ntpFrAtmIwfNiwConnAtmTooLongFrame OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object counts the number of frames discarded by the
IWF because the frame is too large to be forwarded on the
Frame Relay segment of the connection (ATM to Frame Relay
direction)."
::= { ntpFrAtmIwfNiwConnEntry 10 }

ntpFrAtmIwfNiwConnCrcErrors OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of AAL5 PDUs received with CRC-32 errors on
this AAL5 VCC at the IWF (ATM to Frame Relay direction)."
::= { ntpFrAtmIwfNiwConnEntry 11 }

ntpFrAtmIwfNiwDLCITable OBJECT-TYPE

ATOS User Guide


Appendix A : private MIB - 381 / 483

SYNTAX SEQUENCE OF NtpFrAtmIwfNiwDLCIEntry


ACCESS not-accessible
STATUS mandatory
::= { ntpFrAtmIwf 4 }

ntpFrAtmIwfNiwDLCIEntry OBJECT-TYPE
SYNTAX NtpFrAtmIwfNiwDLCIEntry
ACCESS not-accessible
STATUS mandatory
INDEX { ntpFrAtmIwfNiwDLCIUserIndex, ntpFrAtmIwfNiwDLCIConnIndex,
ntpFrAtmIwfNiwDLCIIndex }
::= { ntpFrAtmIwfNiwDLCITable 1 }

NtpFrAtmIwfNiwDLCIEntry ::=
SEQUENCE {
ntpFrAtmIwfNiwDLCIUserIndex
INTEGER,
ntpFrAtmIwfNiwDLCIConnIndex
INTEGER,
ntpFrAtmIwfNiwDLCIIndex
INTEGER,
ntpFrAtmIwfNiwDLCIUserSide
INTEGER,
ntpFrAtmIwfNiwDLCINetworkSide
INTEGER
}

ntpFrAtmIwfNiwDLCIUserIndex OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The CPE can have up to 4 multiservice units."
::= { ntpFrAtmIwfNiwDLCIEntry 1 }

ATOS User Guide


Appendix A : private MIB - 382 / 483

ntpFrAtmIwfNiwDLCIConnIndex OBJECT-TYPE
SYNTAX INTEGER (1..128)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The NIW connection index."
::= { ntpFrAtmIwfNiwDLCIEntry 2 }

ntpFrAtmIwfNiwDLCIIndex OBJECT-TYPE
SYNTAX INTEGER (1..16)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The DLCI NIW index."
::= { ntpFrAtmIwfNiwDLCIEntry 3 }

ntpFrAtmIwfNiwDLCIUserSide OBJECT-TYPE
SYNTAX INTEGER (16..4194303)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The User DLCI (Frame Relay side) for this DLCI NIW entry."
::= { ntpFrAtmIwfNiwDLCIEntry 4 }

ntpFrAtmIwfNiwDLCINetworkSide OBJECT-TYPE
SYNTAX INTEGER (16..4194303)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The Network DLCI (ATM side) for this DLCI NIW entry. It
may (or may not) be equal to the User DLCI."
::= { ntpFrAtmIwfNiwDLCIEntry 5 }

ntpFrAtmIwfSiwServiceTable OBJECT-TYPE
SYNTAX SEQUENCE OF NtpFrAtmIwfSiwServiceEntry

ATOS User Guide


Appendix A : private MIB - 383 / 483

ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"The Frame Relay/ATM PVC Service Interworking Function
Connection Descriptor table for SIW connections."
::= { ntpFrAtmIwf 5 }

ntpFrAtmIwfSiwServiceEntry OBJECT-TYPE
SYNTAX NtpFrAtmIwfSiwServiceEntry
ACCESS not-accessible
STATUS mandatory
INDEX { ntpFrAtmIwfSiwServiceUserIndex, ntpFrAtmIwfSiwServiceIndex }
::= { ntpFrAtmIwfSiwServiceTable 1 }

NtpFrAtmIwfSiwServiceEntry ::=
SEQUENCE {
ntpFrAtmIwfSiwServiceUserIndex
INTEGER,
ntpFrAtmIwfSiwServiceIndex
INTEGER,
ntpFrAtmIwfSiwServiceDeToClpMode
INTEGER,
ntpFrAtmIwfSiwServiceClpToDeMode
INTEGER,
ntpFrAtmIwfSiwServiceCongestionEnable
INTEGER,
ntpFrAtmIwfSiwServiceEncapsulationMode
INTEGER,
ntpFrAtmIwfSiwServiceFragReassEnabled
INTEGER,
ntpFrAtmIwfSiwServiceArpTransEnabled
INTEGER
}

ntpFrAtmIwfSiwServiceUserIndex OBJECT-TYPE

ATOS User Guide


Appendix A : private MIB - 384 / 483

SYNTAX INTEGER (1..4)


ACCESS read-only
STATUS mandatory
DESCRIPTION
"The CPE can have up to 4 multiservice units."
::= { ntpFrAtmIwfSiwServiceEntry 1 }

ntpFrAtmIwfSiwServiceIndex OBJECT-TYPE
SYNTAX INTEGER (1..128)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Within a multiservice unit, this is a unique value for
each SIW descriptor service."
::= { ntpFrAtmIwfSiwServiceEntry 2 }

ntpFrAtmIwfSiwServiceDeToClpMode OBJECT-TYPE
SYNTAX INTEGER
{
mode1(1),
mode2const0(2),
mode2const1(3)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object describes which mode of translation is in use
for loss priority mapping in the Frame Relay to ATM
direction.

mode1(1) = the DE field in the Q.922 core frame shall be


mapped to the ATM CLP field of every cell
generated by the segmentation process of the
AAL5 PDU containing the information of that
frame.

ATOS User Guide


Appendix A : private MIB - 385 / 483

mode2const0(2) = the ATM CLP field of every cell generated


by the segmentation process of the AAL5
PDU containing the information of that
frame shall be set to constant 0.

mode2const1(3) = the ATM CLP field of every cell generated


by the segmentation process of the AAL5
PDU containing the information of that
frame shall be set to constant 1."
::= { ntpFrAtmIwfSiwServiceEntry 3 }

ntpFrAtmIwfSiwServiceClpToDeMode OBJECT-TYPE
SYNTAX INTEGER
{
mode1(1),
mode2const0(2),
mode2const1(3)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object describes which mode of translation is in use
for loss priority mapping in the ATM to Frame Relay
direction.

mode1(1) = if one or more cells in a frame has its CLP


field set, the DE field of the Q.922 core frame
should be set.

mode2const0(2) = the DE field of the Q.922 core frame


should be set to the constant 0.

ATOS User Guide


Appendix A : private MIB - 386 / 483

mode2const1(3) = the DE field of the Q.922 core frame


should be set to the constant 1."
::= { ntpFrAtmIwfSiwServiceEntry 4 }

ntpFrAtmIwfSiwServiceCongestionEnable OBJECT-TYPE
SYNTAX INTEGER
{
off(1),
on(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object describes if the congestion translation is in
use when mapping the Frame Relay frames to ATM cells."
::= { ntpFrAtmIwfSiwServiceEntry 5 }

ntpFrAtmIwfSiwServiceEncapsulationMode OBJECT-TYPE
SYNTAX INTEGER
{
transparentMode(1),
translationMode(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object indicates whether the mapping of upper layer
protocol encapsulation is enabled on this interworking
connection."
::= { ntpFrAtmIwfSiwServiceEntry 6 }

ntpFrAtmIwfSiwServiceFragReassEnabled OBJECT-TYPE
SYNTAX INTEGER
{
enabled(1),

ATOS User Guide


Appendix A : private MIB - 387 / 483

disabled(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The attribute indicates whether fragmentation and
reassembly is enabled for this connection."
DEFVAL { disabled }
::= { ntpFrAtmIwfSiwServiceEntry 7 }

ntpFrAtmIwfSiwServiceArpTransEnabled OBJECT-TYPE
SYNTAX INTEGER
{
enabled(1),
disabled(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The attribute indicates whether ARP translation is enabled
for this connection. This object makes sense onlt if
'ntpFrAtmIwfSiwServiceEncapsulationMode' value is
'translationMode'."
DEFVAL { enabled }
::= { ntpFrAtmIwfSiwServiceEntry 8 }

ntpFrAtmIwfNiwServiceTable OBJECT-TYPE
SYNTAX SEQUENCE OF NtpFrAtmIwfNiwServiceEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"The Frame Relay/ATM PVC Service Interworking Function
Connection Descriptor table for NIW connections."
::= { ntpFrAtmIwf 6 }

ATOS User Guide


Appendix A : private MIB - 388 / 483

ntpFrAtmIwfNiwServiceEntry OBJECT-TYPE
SYNTAX NtpFrAtmIwfNiwServiceEntry
ACCESS not-accessible
STATUS mandatory
INDEX { ntpFrAtmIwfNiwServiceUserIndex, ntpFrAtmIwfNiwServiceIndex }
::= { ntpFrAtmIwfNiwServiceTable 1 }

NtpFrAtmIwfNiwServiceEntry ::=
SEQUENCE {
ntpFrAtmIwfNiwServiceUserIndex
INTEGER,
ntpFrAtmIwfNiwServiceIndex
INTEGER,
ntpFrAtmIwfNiwServiceDeToClpMode
INTEGER,
ntpFrAtmIwfNiwServiceClpToDeMode
INTEGER,
ntpFrAtmIwfNiwServiceLmiEnabled
INTEGER,
ntpFrAtmIwfNiwServiceLmiType
INTEGER,
ntpFrAtmIwfNiwServiceLmiBidirect
INTEGER,
ntpFrAtmIwfNiwServiceLmiFullStatusPolling
INTEGER,
ntpFrAtmIwfNiwServiceLmiErrorThreshold
INTEGER,
ntpFrAtmIwfNiwServiceLmiMonitoredEvent
INTEGER,
ntpFrAtmIwfNiwServiceLmiLinkIntegrityTimer
INTEGER,
ntpFrAtmIwfNiwServiceLmiPollingTimer
INTEGER
}

ATOS User Guide


Appendix A : private MIB - 389 / 483

ntpFrAtmIwfNiwServiceUserIndex OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The CPE can have up to 4 multiservice units."
::= { ntpFrAtmIwfNiwServiceEntry 1 }

ntpFrAtmIwfNiwServiceIndex OBJECT-TYPE
SYNTAX INTEGER (1..128)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Within a multiservice unit, this is a unique value for
each NIW descriptor service."
::= { ntpFrAtmIwfNiwServiceEntry 2 }

ntpFrAtmIwfNiwServiceDeToClpMode OBJECT-TYPE
SYNTAX INTEGER
{
mode1(1),
mode2const0(2),
mode2const1(3)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object describes which mode of translation is in use
for loss priority mapping in the Frame Relay to ATM
direction.

mode1(1) = the DE field in the Q.922 core frame shall be


mapped to the ATM CLP field of every cell
generated by the segmentation process of the
AAL5 PDU containing the information of that

ATOS User Guide


Appendix A : private MIB - 390 / 483

frame.

mode2const0(2) = the ATM CLP field of every cell generated


by the segmentation process of the AAL5
PDU containing the information of that
frame shall be set to constant 0.

mode2const1(3) = the ATM CLP field of every cell generated


by the segmentation process of the AAL5
PDU containing the information of that
frame shall be set to constant 1."
::= { ntpFrAtmIwfNiwServiceEntry 3 }

ntpFrAtmIwfNiwServiceClpToDeMode OBJECT-TYPE
SYNTAX INTEGER
{
mode1(1),
mode2(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object describes which mode of translation is in use
for loss priority mapping in the ATM to Frame Relay
direction.

mode1(1) = if one or more cells in a frame has its CLP


field set, the DE field of the Q.922 core frame
should be set.

mode2(2) = the DE field of the Q.922 core frame should be


set to the save value present in the ATM
paylaod."
::= { ntpFrAtmIwfNiwServiceEntry 4 }

ATOS User Guide


Appendix A : private MIB - 391 / 483

ntpFrAtmIwfNiwServiceLmiEnabled OBJECT-TYPE
SYNTAX INTEGER
{
enabled(1),
disabled(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The attribute indicates whether LMI is enabled for this
connection."
DEFVAL { disabled }
::= { ntpFrAtmIwfNiwServiceEntry 5 }

ntpFrAtmIwfNiwServiceLmiType OBJECT-TYPE
SYNTAX INTEGER
{
ituLmiType(1),
ansiLmiType(2),
ciscoLmiType(3)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The LMI type for this connection. If the LMI is disabled,
the CPE responds with a 'no such name' message."
::= { ntpFrAtmIwfNiwServiceEntry 6 }

ntpFrAtmIwfNiwServiceLmiBidirect OBJECT-TYPE
SYNTAX INTEGER
{
on(1),
off(2)
}

ATOS User Guide


Appendix A : private MIB - 392 / 483

ACCESS read-only
STATUS mandatory
DESCRIPTION
"The attribute indicates whether LMI bidirect is 'on' for
this connection. If the LMI is disabled, the CPE responds
with a 'no such name' message."
::= { ntpFrAtmIwfNiwServiceEntry 7 }

ntpFrAtmIwfNiwServiceLmiFullStatusPolling OBJECT-TYPE
SYNTAX INTEGER (1..255)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of full status polling counter for this
connection. If the LMI is disabled, the CPE responds with
a 'no such name' message."
DEFVAL { 6 }
::= { ntpFrAtmIwfNiwServiceEntry 8 }

ntpFrAtmIwfNiwServiceLmiErrorThreshold OBJECT-TYPE
SYNTAX INTEGER (1..10)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of the error threshold for this connection.
If the LMI is disabled, the CPE responds with a 'no such
name' message."
DEFVAL { 3 }
::= { ntpFrAtmIwfNiwServiceEntry 9 }

ntpFrAtmIwfNiwServiceLmiMonitoredEvent OBJECT-TYPE
SYNTAX INTEGER (1..10)
ACCESS read-only
STATUS mandatory
DESCRIPTION

ATOS User Guide


Appendix A : private MIB - 393 / 483

"The number of monitored event counter for this connection.


If the LMI is disabled, the CPE responds with a 'no such
name' message."
DEFVAL { 4 }
::= { ntpFrAtmIwfNiwServiceEntry 10 }

ntpFrAtmIwfNiwServiceLmiLinkIntegrityTimer OBJECT-TYPE
SYNTAX INTEGER (5..30)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The value (in seconds) of the link integrity verification
polling timer for this connection. If the LMI is disabled,
the CPE responds with a 'no such name' message."
DEFVAL { 10 }
::= { ntpFrAtmIwfNiwServiceEntry 11 }

ntpFrAtmIwfNiwServiceLmiPollingTimer OBJECT-TYPE
SYNTAX INTEGER (5..30)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The value (in seconds) of the polling verification timer
for this connection. If the LMI is disabled, the CPE
responds with a 'no such name' message."
DEFVAL { 15 }
::= { ntpFrAtmIwfNiwServiceEntry 12 }

ntpCes OBJECT IDENTIFIER ::= { ntpMib 5 }

ntpCesConfTable OBJECT-TYPE
SYNTAX SEQUENCE OF NtpCesConfEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION

ATOS User Guide


Appendix A : private MIB - 394 / 483

"CES configuration table. There is an entry for each CES


InterWorking Function (CES-IWF)."
::= { ntpCes 1 }

ntpCesConfEntry OBJECT-TYPE
SYNTAX NtpCesConfEntry
ACCESS not-accessible
STATUS mandatory
INDEX { ntpCesConfUserIndex, ntpCesConfIndex }
::= { ntpCesConfTable 1 }

NtpCesConfEntry ::=
SEQUENCE {
ntpCesConfUserIndex
INTEGER,
ntpCesConfIndex
INTEGER,
ntpCesConfAtmIndex
INTEGER,
ntpCesConfService
INTEGER,
ntpCesConfClockMode
INTEGER,
ntpCesConfPartialFill
INTEGER,
ntpCesConfCdvRxT
INTEGER,
ntpCesConfAdminStatus
INTEGER
}

ntpCesConfUserIndex OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory

ATOS User Guide


Appendix A : private MIB - 395 / 483

DESCRIPTION
"The CPE can have up to 4 multiservice units."
::= { ntpCesConfEntry 1 }

ntpCesConfIndex OBJECT-TYPE
SYNTAX INTEGER (1..8)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Within a multiservice unit, this value identifies a CES
entry."
::= { ntpCesConfEntry 2 }

ntpCesConfAtmIndex OBJECT-TYPE
SYNTAX INTEGER (1..128)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The ATM connection index (ntpAtmIndex in ntpAtmTable)
where this CES-IWF is mapped."
::= { ntpCesConfEntry 3 }

ntpCesConfService OBJECT-TYPE
SYNTAX INTEGER
{
unstructured(1),
structured(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Define the type of this CES-IWF: unstructured(1) data
transfert or structured(2) data transfert."
::= { ntpCesConfEntry 4 }

ATOS User Guide


Appendix A : private MIB - 396 / 483

ntpCesConfClockMode OBJECT-TYPE
SYNTAX INTEGER
{
synchronous(1),
adaptive(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The clock mode for this CES-IWF."
::= { ntpCesConfEntry 5 }

ntpCesConfPartialFill OBJECT-TYPE
SYNTAX INTEGER (0..47)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"If partial cell fill is used, this parameter is the number
of user octets per cell. If this parameter value is zero,
the partial cell fill is disabled: all cells have to be
completely filled before they are sent."
::= { ntpCesConfEntry 6 }

ntpCesConfCdvRxT OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The maximum cell arrival jitter in 10 usec increments that
the reassembly process will tollerate in the cell stream
without producing errors on the ATM interface."
::= { ntpCesConfEntry 7 }

ntpCesConfAdminStatus OBJECT-TYPE
SYNTAX INTEGER

ATOS User Guide


Appendix A : private MIB - 397 / 483

{
up(1),
down(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The desired state for this CES-IWF."
::= { ntpCesConfEntry 8 }

ntpCesStatTable OBJECT-TYPE
SYNTAX SEQUENCE OF NtpCesStatEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"CES statistics table. There is an entry for each CES
InterWorking Function (CES-IWF)."
::= { ntpCes 2 }

ntpCesStatEntry OBJECT-TYPE
SYNTAX NtpCesStatEntry
ACCESS not-accessible
STATUS mandatory
INDEX { ntpCesStatUserIndex, ntpCesStatIndex }
::= { ntpCesStatTable 1 }

NtpCesStatEntry ::=
SEQUENCE {
ntpCesStatUserIndex
INTEGER,
ntpCesStatIndex
INTEGER,
ntpCesStatRxCells
Counter,
ntpCesStatTxCells

ATOS User Guide


Appendix A : private MIB - 398 / 483

Counter,
ntpCesStatDiscardedCells
Counter,
ntpCesStatSdtPointerError
Counter,
ntpCesStatAal1InvalidSeqNum
Counter,
ntpCesStatLostCells
Counter,
ntpCesStatMisinsertedCells
Counter,
ntpCesStatOperStatus
INTEGER
}

ntpCesStatUserIndex OBJECT-TYPE
SYNTAX INTEGER (1..4)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The CPE can have up to 4 multiservice units."
::= { ntpCesStatEntry 1 }

ntpCesStatIndex OBJECT-TYPE
SYNTAX INTEGER (1..8)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Within a multiservice unit, this value identifies a CES
entry."
::= { ntpCesStatEntry 2 }

ntpCesStatRxCells OBJECT-TYPE
SYNTAX Counter
ACCESS read-only

ATOS User Guide


Appendix A : private MIB - 399 / 483

STATUS mandatory
DESCRIPTION
"The number of received cells on this CES-IWF."
::= { ntpCesStatEntry 3 }

ntpCesStatTxCells OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of transmitted cells on this CES-IWF."
::= { ntpCesStatEntry 4 }

ntpCesStatDiscardedCells OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of discarded cells."
::= { ntpCesStatEntry 5 }

ntpCesStatSdtPointerError OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Number of events in which the AAL1 reassembler found that
an SDT pointer is not where it is expected."
::= { ntpCesStatEntry 6 }

ntpCesStatAal1InvalidSeqNum OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION

ATOS User Guide


Appendix A : private MIB - 400 / 483

"Number of times that the sequence number of an incoming


AAL1 packet is invalid."
::= { ntpCesStatEntry 7 }

ntpCesStatLostCells OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Number of lost cells."
::= { ntpCesStatEntry 8 }

ntpCesStatMisinsertedCells OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Number of misinserted cells."
::= { ntpCesStatEntry 9 }

ntpCesStatOperStatus OBJECT-TYPE
SYNTAX INTEGER
{
up(1),
down(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The operational state for this CES-IWF."
::= { ntpCesStatEntry 10 }

vdslMib OBJECT IDENTIFIER ::= { atos 5 }

vdslChannel OBJECT IDENTIFIER ::= { vdslMib 1 }

ATOS User Guide


Appendix A : private MIB - 401 / 483

vdslChannelStatTable OBJECT-TYPE
SYNTAX SEQUENCE OF VdslChannelStatEntry
ACCESS not-accessible
STATUS mandatory
::= { vdslChannel 1 }

vdslChannelStatEntry OBJECT-TYPE
SYNTAX VdslChannelStatEntry
ACCESS not-accessible
STATUS mandatory
INDEX { vdslChannelStatLineIndex, vdslChannelStatPhysIndex,
vdslChannelStatChanIndex }
::= { vdslChannelStatTable 1 }

VdslChannelStatEntry ::=
SEQUENCE {
vdslChannelStatBadFrame
Counter,
vdslChannelStatFixedFrame
Counter,
vdslChannelStatChanIndex
INTEGER,
vdslChannelStatPhysIndex
INTEGER,
vdslChannelStatLineIndex
INTEGER
}

vdslChannelStatBadFrame OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Count of uncorrectable VDSL frames (FEC errors) since the

ATOS User Guide


Appendix A : private MIB - 402 / 483

unit was last reset."


::= { vdslChannelStatEntry 1 }

vdslChannelStatFixedFrame OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Count of corrected VDSL frames (FEC events) since the unit
was last reset."
::= { vdslChannelStatEntry 2 }

vdslChannelStatChanIndex OBJECT-TYPE
SYNTAX INTEGER (1..2)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Within a specified VDSL line and a specified VDSL
Transceiver Unit, this object identifies the channel
index."
::= { vdslChannelStatEntry 3 }

vdslChannelStatPhysIndex OBJECT-TYPE
SYNTAX INTEGER (1..16)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object identifies the VDSL Transceiver Unit where the
channel is mapped. It corresponds to 'vdslPhysIndex' in
'vdslPhysTable'."
::= { vdslChannelStatEntry 4 }

vdslChannelStatLineIndex OBJECT-TYPE
SYNTAX INTEGER (1..16)
ACCESS read-only

ATOS User Guide


Appendix A : private MIB - 403 / 483

STATUS mandatory
DESCRIPTION
"This object identifies the VDSL interface where the
channel is mapped. It corresponds to 'vdslLineConfIndex'
in 'vdslLineConfTable' and to 'vdslLineStatIndex' in
'vdslLineStatTable'."
::= { vdslChannelStatEntry 5 }

vdslChannelConfTable OBJECT-TYPE
SYNTAX SEQUENCE OF VdslChannelConfEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"This table provides one row per Vtu Channel per VDLS line
per Physical Vtu."
::= { vdslChannel 2 }

vdslChannelConfEntry OBJECT-TYPE
SYNTAX VdslChannelConfEntry
ACCESS not-accessible
STATUS mandatory
INDEX { vdslChannelConfLineIndex, vdslChannelConfPhysIndex,
vdslChannelConfChanIndex }
::= { vdslChannelConfTable 1 }

VdslChannelConfEntry ::=
SEQUENCE {
vdslChannelConfUsTxSlowBurstProtect
INTEGER,
vdslChannelConfUsTxPayloadRate
INTEGER,
vdslChannelConfDsInterleaveDelay
INTEGER,
vdslChannelConfChanIndex
INTEGER,

ATOS User Guide


Appendix A : private MIB - 404 / 483

vdslChannelConfPhysIndex
INTEGER,
vdslChannelConfLineIndex
INTEGER
}

vdslChannelConfUsTxSlowBurstProtect OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Actual level of impulse noise (burst) protection for an
interleaved (slow) channel, in DMT symbol steps. If the
channel is 'fast', this object must be zero."
::= { vdslChannelConfEntry 1 }

vdslChannelConfUsTxPayloadRate OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Transmit payload data rate on this channel, in 1 kbps
steps."
::= { vdslChannelConfEntry 2 }

vdslChannelConfDsInterleaveDelay OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Interleave Delay (in downstream) for this channel, in 0.1
millisecond steps. If the channel is 'fast', this object
must be zero."
::= { vdslChannelConfEntry 3 }

ATOS User Guide


Appendix A : private MIB - 405 / 483

vdslChannelConfChanIndex OBJECT-TYPE
SYNTAX INTEGER (1..2)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Within a specified VDSL line and a specified VDSL
Transceiver Unit, this object identifies the channel
index."
::= { vdslChannelConfEntry 4 }

vdslChannelConfPhysIndex OBJECT-TYPE
SYNTAX INTEGER (1..16)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object identifies the VDSL Transceiver Unit where the
channel is mapped. It corresponds to 'vdslPhysIndex' in
'vdslPhysTable'."
::= { vdslChannelConfEntry 5 }

vdslChannelConfLineIndex OBJECT-TYPE
SYNTAX INTEGER (1..16)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object identifies the VDSL interface where the
channel is mapped. It corresponds to 'vdslLineConfIndex'
in 'vdslLineConfTable' and to 'vdslLineStatIndex' in
'vdslLineStatTable'."
::= { vdslChannelConfEntry 6 }

vdslPhysical OBJECT IDENTIFIER ::= { vdslMib 2 }

vdslPhysTable OBJECT-TYPE
SYNTAX SEQUENCE OF VdslPhysEntry

ATOS User Guide


Appendix A : private MIB - 406 / 483

ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"This table provides one row for each Vtu. Each row
contains the Physical Layer Parameters table for that
Vtu (Vdsl Transceiver Unit).
"
::= { vdslPhysical 1 }

vdslPhysEntry OBJECT-TYPE
SYNTAX VdslPhysEntry
ACCESS not-accessible
STATUS mandatory
INDEX { vdslPhysIndex }
::= { vdslPhysTable 1 }

VdslPhysEntry ::=
SEQUENCE {
vdslPhysDsLineRate
INTEGER,
vdslPhysDsAttainableRate
INTEGER,
vdslPhysNeOutputPwr
INTEGER,
vdslPhysStatus
INTEGER,
vdslPhysNeAtn
INTEGER,
vdslPhysNeSnrMgn
INTEGER,
vdslPhysSide
INTEGER,
vdslPhysIndex
INTEGER
}

ATOS User Guide


Appendix A : private MIB - 407 / 483

vdslPhysDsLineRate OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Indicates the current data rate (downstream), in steps of
1 kbps."
::= { vdslPhysEntry 1 }

vdslPhysDsAttainableRate OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Indicates the maximum currently attainable data rate
(downstream), in steps of 1 kbps."
::= { vdslPhysEntry 2 }

vdslPhysNeOutputPwr OBJECT-TYPE
SYNTAX INTEGER (0..160)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Near-end total output power transmitted by this VTU, in
0.1 dBm."
::= { vdslPhysEntry 3 }

vdslPhysStatus OBJECT-TYPE
SYNTAX INTEGER
{
up(1),
down(2)
}
ACCESS read-only

ATOS User Guide


Appendix A : private MIB - 408 / 483

STATUS mandatory
DESCRIPTION
"Indicates current status of the Vtu."
::= { vdslPhysEntry 4 }

vdslPhysNeAtn OBJECT-TYPE
SYNTAX INTEGER (0..255)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Near-end difference in the total power transmitted by the
peer Vtu and the total power received by this Vtu, in
0.1 dB."
::= { vdslPhysEntry 5 }

vdslPhysNeSnrMgn OBJECT-TYPE
SYNTAX INTEGER (-127..127)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Near-end noise margin with respect the received signal, in
0.1 dB steps."
::= { vdslPhysEntry 6 }

vdslPhysSide OBJECT-TYPE
SYNTAX INTEGER
{
vtuc(1),
vtur(2)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Identifies whether the unit is a central side transceiver
(vtuc) or a remote side transceiver (vtur)."

ATOS User Guide


Appendix A : private MIB - 409 / 483

::= { vdslPhysEntry 7 }

vdslPhysIndex OBJECT-TYPE
SYNTAX INTEGER (1..16)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"There is a unique index for each VDSL Transceiver Unit."
::= { vdslPhysEntry 8 }

vdslLine OBJECT IDENTIFIER ::= { vdslMib 3 }

vdslLineStatTable OBJECT-TYPE
SYNTAX SEQUENCE OF VdslLineStatEntry
ACCESS not-accessible
STATUS mandatory
::= { vdslLine 1 }

vdslLineStatEntry OBJECT-TYPE
SYNTAX VdslLineStatEntry
ACCESS not-accessible
STATUS mandatory
INDEX { vdslLineStatIndex }
::= { vdslLineStatTable 1 }

VdslLineStatEntry ::=
SEQUENCE {
vdslLineStatFeLossOfPower
Counter,
vdslLineStatNeLossOfSignal
Counter,
vdslLineStatNeLossOfFrame
Counter,
vdslLineStatIndex
INTEGER

ATOS User Guide


Appendix A : private MIB - 410 / 483

vdslLineStatFeLossOfPower OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Count of far-end loss of power events since the unit was
last reset."
::= { vdslLineStatEntry 1 }

vdslLineStatNeLossOfSignal OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Count of near-end loss of signal events since the unit was
last reset."
::= { vdslLineStatEntry 2 }

vdslLineStatNeLossOfFrame OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Count of near-end loss of frame events since the unit was
last reset."
::= { vdslLineStatEntry 3 }

vdslLineStatIndex OBJECT-TYPE
SYNTAX INTEGER (1..16)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"There is a unique index for each VDSL interface."

ATOS User Guide


Appendix A : private MIB - 411 / 483

::= { vdslLineStatEntry 4 }

vdslLineConfTable OBJECT-TYPE
SYNTAX SEQUENCE OF VdslLineConfEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"This table includes common attributes describing both
ends of the VDSL line. There is one entry for each VDSL
interfaces.
"
::= { vdslLine 2 }

vdslLineConfEntry OBJECT-TYPE
SYNTAX VdslLineConfEntry
ACCESS not-accessible
STATUS mandatory
INDEX { vdslLineConfIndex }
::= { vdslLineConfTable 1 }

VdslLineConfEntry ::=
SEQUENCE {
vdslLineConfType
INTEGER,
vdslLineConfCoding
INTEGER,
vdslLineConfIndex
INTEGER
}

vdslLineConfType OBJECT-TYPE
SYNTAX INTEGER
{
noChannel(1),
fastOnly(2),

ATOS User Guide


Appendix A : private MIB - 412 / 483

interleavedOnly(3),
fastOrInterleaved(4),
fastAndInterleaved(5)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Defines the type of VDSL physical line entity that exists,
by defining whether and how the line is channelized. If
the line is channelized, the value will be other than
noChannel(1). This object defines which channel type(s)
are supported. Defined values are:
noChannel(1)

-- no channels exist

fastOnly(2)

-- only fast channel exists

interleavedOnly(3)

-- only interleaved channel exists

fastOrInterleaved(4)

-- either fast or interleaved


-- channel
-- exist, but only one at a time

fastAndInterleaved(5) -- both fast and interleaved


-- channels exist

"
::= { vdslLineConfEntry 1 }

vdslLineConfCoding OBJECT-TYPE
SYNTAX INTEGER
{
other(1),
mcm(2),
scm(3)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Specifies the VDSL coding type used on this line. 'mcm'(2)

ATOS User Guide


Appendix A : private MIB - 413 / 483

is Multiple Carrier Modulation, and 'scm'(3) is Single


Carrier Modulation.
"
::= { vdslLineConfEntry 2 }

vdslLineConfIndex OBJECT-TYPE
SYNTAX INTEGER (1..16)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"There is a unique index for each VDSL interface."
::= { vdslLineConfEntry 3 }

npmMib OBJECT IDENTIFIER ::= { atos 7 }

sourceIPAddress OBJECT-TYPE
SYNTAX IpAddress
ACCESS read-write
STATUS mandatory
::= { npmMib 1 }

operationSourcePort OBJECT-TYPE
SYNTAX INTEGER (0..65535)
ACCESS read-write
STATUS mandatory
::= { npmMib 2 }

enableControlProtocolForResponder OBJECT-TYPE
SYNTAX INTEGER
{
off(1),
on(2)
}
ACCESS read-write
STATUS mandatory

ATOS User Guide


Appendix A : private MIB - 414 / 483

::= { npmMib 3 }

operationConfiguration OBJECT IDENTIFIER ::= { npmMib 4 }

operationTable OBJECT-TYPE
SYNTAX SEQUENCE OF OperationEntry
ACCESS not-accessible
STATUS mandatory
::= { operationConfiguration 1 }

operationEntry OBJECT-TYPE
SYNTAX OperationEntry
ACCESS not-accessible
STATUS mandatory
INDEX { id }
::= { operationTable 1 }

OperationEntry ::=
SEQUENCE {
id
INTEGER,
type
INTEGER,
enableControlProtocol
INTEGER,
tag
OCTET STRING,
frequency
INTEGER,
payloadDataSize
INTEGER,
verifyDataPattern
INTEGER,
timeout
INTEGER,

ATOS User Guide


Appendix A : private MIB - 415 / 483

upperThreshold
INTEGER,
tos
INTEGER,
destinationIPAdrress
IpAddress,
destinationPort
INTEGER,
owner
OCTET STRING,
statisticDistribution
INTEGER,
statisticInterval
INTEGER,
statisticLives
INTEGER,
historyBuckets
INTEGER,
historyLives
INTEGER,
historyFilter
INTEGER,
activeLife
INTEGER,
inactiveLife
INTEGER,
startTime
OCTET STRING,
startMonth
INTEGER,
startDay
INTEGER,
connectionLostReaction
INTEGER,
timeoutReaction

ATOS User Guide


Appendix A : private MIB - 416 / 483

INTEGER,
verifyErrorReaction
INTEGER,
rttOverThresholdReaction
INTEGER,
rttThresholdType
INTEGER,
actionNumber
INTEGER,
timeNumber
INTEGER,
interval
INTEGER,
numberOfPackets
INTEGER,
codecType
INTEGER,
oneWaySDThreshold
INTEGER,
oneWayDSThreshold
INTEGER
}

id OBJECT-TYPE
SYNTAX INTEGER (1..2000)
ACCESS read-only
STATUS mandatory
::= { operationEntry 1 }

type OBJECT-TYPE
SYNTAX INTEGER
{
icmpRoundTRip(1),
udpRoundTRip(2),
jitter(3)

ATOS User Guide


Appendix A : private MIB - 417 / 483

}
ACCESS read-only
STATUS mandatory
::= { operationEntry 2 }

enableControlProtocol OBJECT-TYPE
SYNTAX INTEGER
{
off(1),
on(2)
}
ACCESS read-write
STATUS mandatory
::= { operationEntry 3 }

tag OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..16))
ACCESS read-write
STATUS mandatory
::= { operationEntry 4 }

frequency OBJECT-TYPE
SYNTAX INTEGER (1..604800)
ACCESS read-write
STATUS mandatory
::= { operationEntry 5 }

payloadDataSize OBJECT-TYPE
SYNTAX INTEGER (0..16384)
ACCESS read-write
STATUS mandatory
::= { operationEntry 6 }

verifyDataPattern OBJECT-TYPE
SYNTAX INTEGER

ATOS User Guide


Appendix A : private MIB - 418 / 483

{
off(1),
on(2)
}
ACCESS read-write
STATUS mandatory
::= { operationEntry 7 }

timeout OBJECT-TYPE
SYNTAX INTEGER (0..604800000)
ACCESS read-write
STATUS mandatory
::= { operationEntry 8 }

upperThreshold OBJECT-TYPE
SYNTAX INTEGER (0..2147483647)
ACCESS read-write
STATUS mandatory
::= { operationEntry 9 }

tos OBJECT-TYPE
SYNTAX INTEGER (0..255)
ACCESS read-write
STATUS mandatory
::= { operationEntry 10 }

destinationIPAdrress OBJECT-TYPE
SYNTAX IpAddress
ACCESS read-write
STATUS mandatory
::= { operationEntry 11 }

destinationPort OBJECT-TYPE
SYNTAX INTEGER (0..65535)
ACCESS read-write

ATOS User Guide


Appendix A : private MIB - 419 / 483

STATUS mandatory
::= { operationEntry 12 }

owner OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..40))
ACCESS read-write
STATUS mandatory
::= { operationEntry 13 }

statisticDistribution OBJECT-TYPE
SYNTAX INTEGER (1..20)
ACCESS read-write
STATUS mandatory
::= { operationEntry 14 }

statisticInterval OBJECT-TYPE
SYNTAX INTEGER (1..100)
ACCESS read-write
STATUS mandatory
::= { operationEntry 15 }

statisticLives OBJECT-TYPE
SYNTAX INTEGER (0..25)
ACCESS read-write
STATUS mandatory
::= { operationEntry 16 }

historyBuckets OBJECT-TYPE
SYNTAX INTEGER (1..60)
ACCESS read-write
STATUS mandatory
::= { operationEntry 17 }

historyLives OBJECT-TYPE
SYNTAX INTEGER (0..2)

ATOS User Guide


Appendix A : private MIB - 420 / 483

ACCESS read-write
STATUS mandatory
::= { operationEntry 18 }

historyFilter OBJECT-TYPE
SYNTAX INTEGER
{
none(1),
all(2),
overThreshold(3),
failures(4)
}
ACCESS read-write
STATUS mandatory
::= { operationEntry 19 }

activeLife OBJECT-TYPE
SYNTAX INTEGER (0..2147483647)
ACCESS read-write
STATUS mandatory
::= { operationEntry 20 }

inactiveLife OBJECT-TYPE
SYNTAX INTEGER (0..2147483647)
ACCESS read-write
STATUS mandatory
::= { operationEntry 21 }

startTime OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..9))
ACCESS read-write
STATUS mandatory
::= { operationEntry 22 }

startMonth OBJECT-TYPE

ATOS User Guide


Appendix A : private MIB - 421 / 483

SYNTAX INTEGER
{
january(1),
february(2),
march(3),
april(4),
may(5),
june(6),
july(7),
august(8),
september(9),
october(10),
november(11),
december(12),
none(13)
}
ACCESS read-write
STATUS mandatory
::= { operationEntry 23 }

startDay OBJECT-TYPE
SYNTAX INTEGER (0..31)
ACCESS read-write
STATUS mandatory
::= { operationEntry 24 }

connectionLostReaction OBJECT-TYPE
SYNTAX INTEGER
{
none(1),
trap(2)
}
ACCESS read-write
STATUS mandatory
::= { operationEntry 25 }

ATOS User Guide


Appendix A : private MIB - 422 / 483

timeoutReaction OBJECT-TYPE
SYNTAX INTEGER
{
none(1),
trap(2)
}
ACCESS read-write
STATUS mandatory
::= { operationEntry 26 }

verifyErrorReaction OBJECT-TYPE
SYNTAX INTEGER
{
none(1),
trap(2)
}
ACCESS read-write
STATUS mandatory
::= { operationEntry 27 }

rttOverThresholdReaction OBJECT-TYPE
SYNTAX INTEGER
{
none(1),
trap(2)
}
ACCESS read-write
STATUS mandatory
::= { operationEntry 28 }

rttThresholdType OBJECT-TYPE
SYNTAX INTEGER
{
immediate(1),

ATOS User Guide


Appendix A : private MIB - 423 / 483

afterX(2),
afterXY(3),
average(4)
}
ACCESS read-write
STATUS mandatory
::= { operationEntry 29 }

actionNumber OBJECT-TYPE
SYNTAX INTEGER (1..16)
ACCESS read-write
STATUS mandatory
::= { operationEntry 30 }

timeNumber OBJECT-TYPE
SYNTAX INTEGER (1..16)
ACCESS read-write
STATUS mandatory
::= { operationEntry 31 }

interval OBJECT-TYPE
SYNTAX INTEGER (1..60000)
ACCESS read-write
STATUS mandatory
::= { operationEntry 32 }

numberOfPackets OBJECT-TYPE
SYNTAX INTEGER (1..60000)
ACCESS read-write
STATUS mandatory
::= { operationEntry 33 }

codecType OBJECT-TYPE
SYNTAX INTEGER
{

ATOS User Guide


Appendix A : private MIB - 424 / 483

none(1),
g711aLaw(2),
g711uLaw(3),
g729a(4)
}
ACCESS read-write
STATUS mandatory
::= { operationEntry 34 }

oneWaySDThreshold OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-write
STATUS mandatory
::= { operationEntry 35 }

oneWayDSThreshold OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-write
STATUS mandatory
::= { operationEntry 36 }

operationStartTable OBJECT-TYPE
SYNTAX SEQUENCE OF OperationStartEntry
ACCESS not-accessible
STATUS mandatory
::= { operationConfiguration 2 }

operationStartEntry OBJECT-TYPE
SYNTAX OperationStartEntry
ACCESS not-accessible
STATUS mandatory
INDEX { startOpId }
::= { operationStartTable 1 }

OperationStartEntry ::=

ATOS User Guide


Appendix A : private MIB - 425 / 483

SEQUENCE {
startOpId
INTEGER,
startType
INTEGER
}

startOpId OBJECT-TYPE
SYNTAX INTEGER (1..2000)
ACCESS read-only
STATUS mandatory
::= { operationStartEntry 1 }

startType OBJECT-TYPE
SYNTAX INTEGER
{
npmStartNow(1),
npmStartAfter(2),
npmStartTime(3),
npmStop(4),
npmRestart(5),
npmNone(6)
}
ACCESS read-write
STATUS mandatory
::= { operationStartEntry 2 }

operationAddDelTable OBJECT-TYPE
SYNTAX SEQUENCE OF OperationAddDelEntry
ACCESS not-accessible
STATUS mandatory
::= { operationConfiguration 3 }

operationAddDelEntry OBJECT-TYPE
SYNTAX OperationAddDelEntry

ATOS User Guide


Appendix A : private MIB - 426 / 483

ACCESS not-accessible
STATUS mandatory
INDEX { operationIndex }
::= { operationAddDelTable 1 }

OperationAddDelEntry ::=
SEQUENCE {
operationIndex
INTEGER,
operationType
INTEGER
}

operationIndex OBJECT-TYPE
SYNTAX INTEGER (1..2000)
ACCESS read-only
STATUS mandatory
::= { operationAddDelEntry 1 }

operationType OBJECT-TYPE
SYNTAX INTEGER
{
icmpRoundTirp(1),
udpRoundTirp(2),
jitter(3),
notConfigured(4)
}
ACCESS read-write
STATUS mandatory
::= { operationAddDelEntry 2 }

operationHistory OBJECT IDENTIFIER ::= { npmMib 5 }

historyTable OBJECT-TYPE
SYNTAX SEQUENCE OF HistoryEntry

ATOS User Guide


Appendix A : private MIB - 427 / 483

ACCESS not-accessible
STATUS mandatory
::= { operationHistory 1 }

historyEntry OBJECT-TYPE
SYNTAX HistoryEntry
ACCESS not-accessible
STATUS mandatory
INDEX { historyOperationId, historyLifeIdx, historyBucketIdx }
::= { historyTable 1 }

HistoryEntry ::=
SEQUENCE {
historyOperationId
INTEGER,
historyLifeIdx
INTEGER,
historyBucketIdx
INTEGER,
historyLifeNumber
INTEGER,
historySampleNumber
INTEGER,
historySampleTime
INTEGER,
historyAddress
IpAddress,
historyRttValue
INTEGER,
historyRttCodeType
INTEGER
}

historyOperationId OBJECT-TYPE
SYNTAX INTEGER (1..2000)

ATOS User Guide


Appendix A : private MIB - 428 / 483

ACCESS read-only
STATUS mandatory
::= { historyEntry 1 }

historyLifeIdx OBJECT-TYPE
SYNTAX INTEGER (1..2)
ACCESS read-only
STATUS mandatory
::= { historyEntry 2 }

historyBucketIdx OBJECT-TYPE
SYNTAX INTEGER (1..60)
ACCESS read-only
STATUS mandatory
::= { historyEntry 3 }

historyLifeNumber OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { historyEntry 4 }

historySampleNumber OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { historyEntry 5 }

historySampleTime OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { historyEntry 6 }

historyAddress OBJECT-TYPE

ATOS User Guide


Appendix A : private MIB - 429 / 483

SYNTAX IpAddress
ACCESS read-only
STATUS mandatory
::= { historyEntry 7 }

historyRttValue OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { historyEntry 8 }

historyRttCodeType OBJECT-TYPE
SYNTAX INTEGER
{
okay(1),
responderFailure(2),
authenticationFailure(3),
formatFailure(4),
disconnected(5),
overThreshold(6),
timeout(7),
busy(8),
noConnection(9),
skipped(10),
sequenceError(11),
verifyError(12),
applicationSpecific(13),
portInUse(14),
packetLateArrival(15),
packetMIA(16)
}
ACCESS read-only
STATUS mandatory
::= { historyEntry 9 }

ATOS User Guide


Appendix A : private MIB - 430 / 483

operationStatus OBJECT IDENTIFIER ::= { npmMib 6 }

opStatusTable OBJECT-TYPE
SYNTAX SEQUENCE OF OpStatusEntry
ACCESS not-accessible
STATUS mandatory
::= { operationStatus 1 }

opStatusEntry OBJECT-TYPE
SYNTAX OpStatusEntry
ACCESS not-accessible
STATUS mandatory
INDEX { opID }
::= { opStatusTable 1 }

OpStatusEntry ::=
SEQUENCE {
opID
INTEGER,
opType
INTEGER,
groupID
INTEGER,
modificationTime
OCTET STRING,
status
INTEGER,
seconfLeftInLife
INTEGER,
transactionsAttempted
INTEGER,
transactionsSkipped
INTEGER,
connectionLostOccurred
INTEGER,

ATOS User Guide


Appendix A : private MIB - 431 / 483

timeoutOccurred
INTEGER,
overThresholdOccurred
INTEGER,
verifyErrorOccurred
INTEGER
}

opID OBJECT-TYPE
SYNTAX INTEGER (1..2000)
ACCESS read-only
STATUS mandatory
::= { opStatusEntry 1 }

opType OBJECT-TYPE
SYNTAX INTEGER
{
icmpRoundTrip(1),
udpRoundTrip(2),
jitter(3)
}
ACCESS read-only
STATUS mandatory
::= { opStatusEntry 2 }

groupID OBJECT-TYPE
SYNTAX INTEGER (0..10)
ACCESS read-only
STATUS mandatory
::= { opStatusEntry 3 }

modificationTime OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..100))
ACCESS read-only
STATUS mandatory

ATOS User Guide


Appendix A : private MIB - 432 / 483

::= { opStatusEntry 4 }

status OBJECT-TYPE
SYNTAX INTEGER
{
idle(1),
pending(2),
inactive(3),
active(4)
}
ACCESS read-only
STATUS mandatory
::= { opStatusEntry 5 }

seconfLeftInLife OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { opStatusEntry 6 }

transactionsAttempted OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { opStatusEntry 7 }

transactionsSkipped OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { opStatusEntry 8 }

connectionLostOccurred OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only

ATOS User Guide


Appendix A : private MIB - 433 / 483

STATUS mandatory
::= { opStatusEntry 9 }

timeoutOccurred OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { opStatusEntry 10 }

overThresholdOccurred OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { opStatusEntry 11 }

verifyErrorOccurred OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { opStatusEntry 12 }

latestOperationSample OBJECT IDENTIFIER ::= { npmMib 7 }

lastRttSampleTable OBJECT-TYPE
SYNTAX SEQUENCE OF LastRttSampleEntry
ACCESS not-accessible
STATUS mandatory
::= { latestOperationSample 1 }

lastRttSampleEntry OBJECT-TYPE
SYNTAX LastRttSampleEntry
ACCESS not-accessible
STATUS mandatory
INDEX { opId }
::= { lastRttSampleTable 1 }

ATOS User Guide


Appendix A : private MIB - 434 / 483

LastRttSampleEntry ::=
SEQUENCE {
opId
INTEGER,
latestStartTime
INTEGER,
latestRTT
INTEGER,
latestReturnCodeDescr
OCTET STRING,
latestRetrunCode
INTEGER
}

opId OBJECT-TYPE
SYNTAX INTEGER (1..2000)
ACCESS read-only
STATUS mandatory
::= { lastRttSampleEntry 1 }

latestStartTime OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastRttSampleEntry 2 }

latestRTT OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastRttSampleEntry 3 }

latestReturnCodeDescr OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..50))

ATOS User Guide


Appendix A : private MIB - 435 / 483

ACCESS read-only
STATUS mandatory
::= { lastRttSampleEntry 4 }

latestRetrunCode OBJECT-TYPE
SYNTAX INTEGER
{
okay(1),
responderFailure(2),
authenticationFailure(3),
formatFailure(4),
disconnected(5),
overThreshold(6),
timeout(7),
busy(8),
noConnected(9),
skipped(10),
sequenceError(11),
verifyError(12),
applicationSpecific(13),
portInUse(14),
packetLateArrval(15),
packetMIA(16)
}
ACCESS read-only
STATUS mandatory
::= { lastRttSampleEntry 5 }

lastJitterSampleTable OBJECT-TYPE
SYNTAX SEQUENCE OF LastJitterSampleEntry
ACCESS not-accessible
STATUS mandatory
::= { latestOperationSample 2 }

lastJitterSampleEntry OBJECT-TYPE

ATOS User Guide


Appendix A : private MIB - 436 / 483

SYNTAX LastJitterSampleEntry
ACCESS not-accessible
STATUS mandatory
INDEX { opIdx }
::= { lastJitterSampleTable 1 }

LastJitterSampleEntry ::=
SEQUENCE {
opIdx
INTEGER,
numOfRtt
INTEGER,
rttAvg
INTEGER,
rttMin
INTEGER,
rttMax
INTEGER,
rttSum
INTEGER,
rttSum2
INTEGER,
packetOverThreshold
INTEGER,
packetLossSD
INTEGER,
packetLossDS
INTEGER,
packetOutOfSequence
INTEGER,
packetMIA
INTEGER,
packetLateArrival
INTEGER,
internalError

ATOS User Guide


Appendix A : private MIB - 437 / 483

INTEGER,
packetSkipped
INTEGER,
minOfPosJitterSD
INTEGER,
maxOfPosJitterSD
INTEGER,
numOfPosJitterSD
INTEGER,
sumOfPosJitterSD
INTEGER,
sum2OfPosJitterSD
INTEGER,
minOfNegJitterSD
INTEGER,
maxOfNegJitterSD
INTEGER,
numOfNegJitterSD
INTEGER,
sumOfNegJitterSD
INTEGER,
sum2OfNegJitterSD
INTEGER,
minOfPosJitterDS
INTEGER,
maxOfPosJitterDS
INTEGER,
numOfPosJitterDS
INTEGER,
sumOfPosJitterDS
INTEGER,
sum2OfPosJitterDS
INTEGER,
minOfNegJitterDS
INTEGER,

ATOS User Guide


Appendix A : private MIB - 438 / 483

maxOfNegJitterDS
INTEGER,
numOfNegJitterDS
INTEGER,
sumOfNegJitterDS
INTEGER,
sum2OfNegJitterDS
INTEGER,
jitterAvg
INTEGER,
jitterSDAvg
INTEGER,
jitterDSAvg
INTEGER,
owSucces
INTEGER,
owFailure
INTEGER,
owMinSD
INTEGER,
owMaxSD
INTEGER,
owSumSD
INTEGER,
owSum2SD
INTEGER,
owMinDS
INTEGER,
owMaxDS
INTEGER,
owSumDS
INTEGER,
owSum2DS
INTEGER,
owAvgSD

ATOS User Guide


Appendix A : private MIB - 439 / 483

INTEGER,
owAvgDS
INTEGER,
oneWaySDOverThreshold
INTEGER,
oneWayDSOverThreshold
INTEGER
}

opIdx OBJECT-TYPE
SYNTAX INTEGER (1..2000)
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 1 }

numOfRtt OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 2 }

rttAvg OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 3 }

rttMin OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 4 }

rttMax OBJECT-TYPE
SYNTAX INTEGER

ATOS User Guide


Appendix A : private MIB - 440 / 483

ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 5 }

rttSum OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 6 }

rttSum2 OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 7 }

packetOverThreshold OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 8 }

packetLossSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 9 }

packetLossDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 10 }

packetOutOfSequence OBJECT-TYPE

ATOS User Guide


Appendix A : private MIB - 441 / 483

SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 11 }

packetMIA OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 12 }

packetLateArrival OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 13 }

internalError OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 14 }

packetSkipped OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 15 }

minOfPosJitterSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 16 }

ATOS User Guide


Appendix A : private MIB - 442 / 483

maxOfPosJitterSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 17 }

numOfPosJitterSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 18 }

sumOfPosJitterSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 19 }

sum2OfPosJitterSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 20 }

minOfNegJitterSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 21 }

maxOfNegJitterSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-write
STATUS mandatory
::= { lastJitterSampleEntry 22 }

ATOS User Guide


Appendix A : private MIB - 443 / 483

numOfNegJitterSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 23 }

sumOfNegJitterSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 24 }

sum2OfNegJitterSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 25 }

minOfPosJitterDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 26 }

maxOfPosJitterDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 27 }

numOfPosJitterDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory

ATOS User Guide


Appendix A : private MIB - 444 / 483

::= { lastJitterSampleEntry 28 }

sumOfPosJitterDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 29 }

sum2OfPosJitterDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 30 }

minOfNegJitterDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 31 }

maxOfNegJitterDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 32 }

numOfNegJitterDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 33 }

sumOfNegJitterDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only

ATOS User Guide


Appendix A : private MIB - 445 / 483

STATUS mandatory
::= { lastJitterSampleEntry 34 }

sum2OfNegJitterDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 35 }

jitterAvg OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 36 }

jitterSDAvg OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 37 }

jitterDSAvg OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 38 }

owSucces OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 39 }

owFailure OBJECT-TYPE
SYNTAX INTEGER

ATOS User Guide


Appendix A : private MIB - 446 / 483

ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 40 }

owMinSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 41 }

owMaxSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 42 }

owSumSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 43 }

owSum2SD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 44 }

owMinDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 45 }

owMaxDS OBJECT-TYPE

ATOS User Guide


Appendix A : private MIB - 447 / 483

SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 46 }

owSumDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 47 }

owSum2DS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 48 }

owAvgSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 49 }

owAvgDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 50 }

oneWaySDOverThreshold OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 51 }

ATOS User Guide


Appendix A : private MIB - 448 / 483

oneWayDSOverThreshold OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { lastJitterSampleEntry 52 }

operationStatistics OBJECT IDENTIFIER ::= { npmMib 8 }

totalStatisticsTable OBJECT-TYPE
SYNTAX SEQUENCE OF TotalStatisticsEntry
ACCESS not-accessible
STATUS mandatory
::= { operationStatistics 1 }

totalStatisticsEntry OBJECT-TYPE
SYNTAX TotalStatisticsEntry
ACCESS not-accessible
STATUS mandatory
INDEX { totalStatOpIdx, totalStatHourIdx }
::= { totalStatisticsTable 1 }

TotalStatisticsEntry ::=
SEQUENCE {
totalStatOpIdx
INTEGER,
totalStatHourIdx
INTEGER,
totalStatStartTime
OCTET STRING,
totalStatInitiations
INTEGER
}

totalStatOpIdx OBJECT-TYPE
SYNTAX INTEGER (1..2000)

ATOS User Guide


Appendix A : private MIB - 449 / 483

ACCESS read-only
STATUS mandatory
::= { totalStatisticsEntry 1 }

totalStatHourIdx OBJECT-TYPE
SYNTAX INTEGER (1..25)
ACCESS read-only
STATUS mandatory
::= { totalStatisticsEntry 2 }

totalStatStartTime OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..100))
ACCESS read-only
STATUS mandatory
::= { totalStatisticsEntry 3 }

totalStatInitiations OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { totalStatisticsEntry 4 }

errorStatistcsTable OBJECT-TYPE
SYNTAX SEQUENCE OF ErrorStatistcsEntry
ACCESS not-accessible
STATUS mandatory
::= { operationStatistics 2 }

errorStatistcsEntry OBJECT-TYPE
SYNTAX ErrorStatistcsEntry
ACCESS not-accessible
STATUS mandatory
INDEX { errorStatOpIdx, errorStatLifeIdx }
::= { errorStatistcsTable 1 }

ATOS User Guide


Appendix A : private MIB - 450 / 483

ErrorStatistcsEntry ::=
SEQUENCE {
errorStatOpIdx
INTEGER,
errorStatLifeIdx
INTEGER,
errorStatStartTime
OCTET STRING,
errorStatTimouts
INTEGER,
errorStatNoConnections
INTEGER,
errorStatInternalErrors
INTEGER,
errorStatSequenceErrors
INTEGER,
errorStatVerifyErrors
INTEGER,
errorStatOverThresholds
INTEGER,
errorStatSuccess
INTEGER
}

errorStatOpIdx OBJECT-TYPE
SYNTAX INTEGER (1..2000)
ACCESS read-only
STATUS mandatory
::= { errorStatistcsEntry 1 }

errorStatLifeIdx OBJECT-TYPE
SYNTAX INTEGER (1..25)
ACCESS read-only
STATUS mandatory
::= { errorStatistcsEntry 2 }

ATOS User Guide


Appendix A : private MIB - 451 / 483

errorStatStartTime OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..100))
ACCESS read-only
STATUS mandatory
::= { errorStatistcsEntry 3 }

errorStatTimouts OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorStatistcsEntry 4 }

errorStatNoConnections OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorStatistcsEntry 5 }

errorStatInternalErrors OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorStatistcsEntry 6 }

errorStatSequenceErrors OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorStatistcsEntry 7 }

errorStatVerifyErrors OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory

ATOS User Guide


Appendix A : private MIB - 452 / 483

::= { errorStatistcsEntry 8 }

errorStatOverThresholds OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorStatistcsEntry 9 }

errorStatSuccess OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorStatistcsEntry 10 }

errorJitterStatisticTable OBJECT-TYPE
SYNTAX SEQUENCE OF ErrorJitterStatisticEntry
ACCESS not-accessible
STATUS mandatory
::= { operationStatistics 3 }

errorJitterStatisticEntry OBJECT-TYPE
SYNTAX ErrorJitterStatisticEntry
ACCESS not-accessible
STATUS mandatory
INDEX { errorStatOpIdx, errorStatLifeIdx }
::= { errorJitterStatisticTable 1 }

ErrorJitterStatisticEntry ::=
SEQUENCE {
errorJittrStatOpIdx
INTEGER,
errorJitterStatLifeIdx
INTEGER,
errorJitterStatStartTime
OCTET STRING,

ATOS User Guide


Appendix A : private MIB - 453 / 483

errorJitterStatNumOfRtt
INTEGER,
errorJitterStatRttAvg
INTEGER,
errorJitterStatRttMin
INTEGER,
errorJitterStatRttMax
INTEGER,
errorJitterStatRttSum
INTEGER,
errorJitterStatRttSum2
INTEGER,
errorJitterStatPacketOverThreshold
INTEGER,
errorJitterStatPacketLossSD
INTEGER,
errorJitterStatPacketLossDS
INTEGER,
errorJitterStatPacketOutOfSequence
INTEGER,
errorJitterStatPacketMIA
INTEGER,
errorJitterStatPacketLateArrival
INTEGER,
errorJitterStatInternalError
INTEGER,
errorJitterStatPacketSkipped
INTEGER,
errorJitterStatMinOfPosSD
INTEGER,
errorJitterStatMaxOfPosSD
INTEGER,
errorJitterStatNumOfPosSD
INTEGER,
errorJitterStatSumOfPosSD

ATOS User Guide


Appendix A : private MIB - 454 / 483

INTEGER,
errorJitterStatSum2OfPosSD
INTEGER,
errorJitterStatMinOfNegSD
INTEGER,
errorJitterStatMaxOfNegSD
INTEGER,
errorJitterStatNumOfNegSD
INTEGER,
errorJitterStatSumOfNegSD
INTEGER,
errorJitterStatSum2OfNegSD
INTEGER,
errorJitterStatMinOfPosDS
INTEGER,
errorJitterStatMaxOfPosDS
INTEGER,
errorJitterStatNumOfPosDS
INTEGER,
errorJitterStatSumOfPosDS
INTEGER,
errorJitterStatSum2OfPosDS
INTEGER,
errorJitterStatMinOfNegDS
INTEGER,
errorJitterStatMaxOfNegDS
INTEGER,
errorJitterStatNumOfNegDS
INTEGER,
errorJitterStatSumOfNegDS
INTEGER,
errorJitterStatSum2OfNegDS
INTEGER,
errorJitterStatJitterAvg
INTEGER,

ATOS User Guide


Appendix A : private MIB - 455 / 483

errorJitterStatJitterSDAvg
INTEGER,
errorJitterStatJitterDSAvg
INTEGER,
errorJitterStatOWSucc
INTEGER,
errorJitterStatOWFailure
INTEGER,
errorJitterStatOWMinSD
INTEGER,
errorJitterStatOWMaxSD
INTEGER,
errorJitterStatOWSumSD
INTEGER,
errorJitterStatOWSum2SD
INTEGER,
errorJitterStatOWMinDS
INTEGER,
errorJitterStatOWMaxDS
INTEGER,
errorJitterStatOWSumDS
INTEGER,
errorJitterStatOWSum2DS
INTEGER,
errorJitterStatOWAvgSD
INTEGER,
errorJitterStatOWAvgDS
INTEGER,
errorJitterStatOWSDOverThreshold
INTEGER,
errorJitterStatOWDSOverThreshold
INTEGER
}

errorJittrStatOpIdx OBJECT-TYPE

ATOS User Guide


Appendix A : private MIB - 456 / 483

SYNTAX INTEGER (1..2000)


ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 1 }

errorJitterStatLifeIdx OBJECT-TYPE
SYNTAX INTEGER (1..25)
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 2 }

errorJitterStatStartTime OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..100))
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 3 }

errorJitterStatNumOfRtt OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 4 }

errorJitterStatRttAvg OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 5 }

errorJitterStatRttMin OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 6 }

ATOS User Guide


Appendix A : private MIB - 457 / 483

errorJitterStatRttMax OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 7 }

errorJitterStatRttSum OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 8 }

errorJitterStatRttSum2 OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 9 }

errorJitterStatPacketOverThreshold OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 10 }

errorJitterStatPacketLossSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 11 }

errorJitterStatPacketLossDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 12 }

ATOS User Guide


Appendix A : private MIB - 458 / 483

errorJitterStatPacketOutOfSequence OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 13 }

errorJitterStatPacketMIA OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 14 }

errorJitterStatPacketLateArrival OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 15 }

errorJitterStatInternalError OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 16 }

errorJitterStatPacketSkipped OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 17 }

errorJitterStatMinOfPosSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory

ATOS User Guide


Appendix A : private MIB - 459 / 483

::= { errorJitterStatisticEntry 18 }

errorJitterStatMaxOfPosSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 19 }

errorJitterStatNumOfPosSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 20 }

errorJitterStatSumOfPosSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 21 }

errorJitterStatSum2OfPosSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 22 }

errorJitterStatMinOfNegSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 23 }

errorJitterStatMaxOfNegSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-write

ATOS User Guide


Appendix A : private MIB - 460 / 483

STATUS mandatory
::= { errorJitterStatisticEntry 24 }

errorJitterStatNumOfNegSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 25 }

errorJitterStatSumOfNegSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 26 }

errorJitterStatSum2OfNegSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 27 }

errorJitterStatMinOfPosDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 28 }

errorJitterStatMaxOfPosDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 29 }

errorJitterStatNumOfPosDS OBJECT-TYPE
SYNTAX INTEGER

ATOS User Guide


Appendix A : private MIB - 461 / 483

ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 30 }

errorJitterStatSumOfPosDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 31 }

errorJitterStatSum2OfPosDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 32 }

errorJitterStatMinOfNegDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 33 }

errorJitterStatMaxOfNegDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 34 }

errorJitterStatNumOfNegDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 35 }

errorJitterStatSumOfNegDS OBJECT-TYPE

ATOS User Guide


Appendix A : private MIB - 462 / 483

SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 36 }

errorJitterStatSum2OfNegDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 37 }

errorJitterStatJitterAvg OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 38 }

errorJitterStatJitterSDAvg OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 39 }

errorJitterStatJitterDSAvg OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 40 }

errorJitterStatOWSucc OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 41 }

ATOS User Guide


Appendix A : private MIB - 463 / 483

errorJitterStatOWFailure OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 42 }

errorJitterStatOWMinSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 43 }

errorJitterStatOWMaxSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 44 }

errorJitterStatOWSumSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 45 }

errorJitterStatOWSum2SD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 46 }

errorJitterStatOWMinDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 47 }

ATOS User Guide


Appendix A : private MIB - 464 / 483

errorJitterStatOWMaxDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 48 }

errorJitterStatOWSumDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 49 }

errorJitterStatOWSum2DS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 50 }

errorJitterStatOWAvgSD OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 51 }

errorJitterStatOWAvgDS OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 52 }

errorJitterStatOWSDOverThreshold OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory

ATOS User Guide


Appendix A : private MIB - 465 / 483

::= { errorJitterStatisticEntry 53 }

errorJitterStatOWDSOverThreshold OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { errorJitterStatisticEntry 54 }

distributionStatistcsTable OBJECT-TYPE
SYNTAX SEQUENCE OF DistributionStatistcsEntry
ACCESS not-accessible
STATUS mandatory
::= { operationStatistics 4 }

distributionStatistcsEntry OBJECT-TYPE
SYNTAX DistributionStatistcsEntry
ACCESS not-accessible
STATUS mandatory
INDEX { distribStatOpIdx, distribStatLifeIdx, distribStatDistributionIdx }
::= { distributionStatistcsTable 1 }

DistributionStatistcsEntry ::=
SEQUENCE {
distribStatOpIdx
INTEGER,
distribStatLifeIdx
INTEGER,
distribStatDistributionIdx
INTEGER,
distribStartTime
OCTET STRING,
distribStartCompletions
INTEGER,
distribStartOverThreshold
INTEGER,

ATOS User Guide


Appendix A : private MIB - 466 / 483

distribStartSumCompletionTime
INTEGER,
distribStartSumCompletionTime2Low
INTEGER,
distribStartSumCompletionTime2High
INTEGER,
distribStartSumCompletionTimeMin
INTEGER,
distribStartSumCompletionTimeMax
INTEGER
}

distribStatOpIdx OBJECT-TYPE
SYNTAX INTEGER (1..2000)
ACCESS read-only
STATUS mandatory
::= { distributionStatistcsEntry 1 }

distribStatLifeIdx OBJECT-TYPE
SYNTAX INTEGER (1..25)
ACCESS read-only
STATUS mandatory
::= { distributionStatistcsEntry 2 }

distribStatDistributionIdx OBJECT-TYPE
SYNTAX INTEGER (1..20)
ACCESS read-only
STATUS mandatory
::= { distributionStatistcsEntry 3 }

distribStartTime OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..100))
ACCESS read-only
STATUS mandatory
::= { distributionStatistcsEntry 4 }

ATOS User Guide


Appendix A : private MIB - 467 / 483

distribStartCompletions OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { distributionStatistcsEntry 5 }

distribStartOverThreshold OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { distributionStatistcsEntry 6 }

distribStartSumCompletionTime OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { distributionStatistcsEntry 7 }

distribStartSumCompletionTime2Low OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { distributionStatistcsEntry 8 }

distribStartSumCompletionTime2High OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { distributionStatistcsEntry 9 }

distribStartSumCompletionTimeMin OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory

ATOS User Guide


Appendix A : private MIB - 468 / 483

::= { distributionStatistcsEntry 10 }

distribStartSumCompletionTimeMax OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { distributionStatistcsEntry 11 }

groupConfiguration OBJECT IDENTIFIER ::= { npmMib 9 }

groupTable OBJECT-TYPE
SYNTAX SEQUENCE OF GroupEntry
ACCESS not-accessible
STATUS mandatory
::= { groupConfiguration 1 }

groupEntry OBJECT-TYPE
SYNTAX GroupEntry
ACCESS not-accessible
STATUS mandatory
INDEX { id }
::= { groupTable 1 }

GroupEntry ::=
SEQUENCE {
groupId
INTEGER,
groupFrequency
INTEGER,
groupSchedulePeriod
INTEGER,
groupActiveLife
INTEGER,
groupInactiveLife
INTEGER,

ATOS User Guide


Appendix A : private MIB - 469 / 483

groupStartTime
OCTET STRING,
groupStartMonth
INTEGER,
groupStartDay
INTEGER,
groupOperationList
OCTET STRING
}

groupId OBJECT-TYPE
SYNTAX INTEGER (1..10)
ACCESS read-only
STATUS mandatory
::= { groupEntry 1 }

groupFrequency OBJECT-TYPE
SYNTAX INTEGER (1..604800)
ACCESS read-write
STATUS mandatory
::= { groupEntry 2 }

groupSchedulePeriod OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-write
STATUS mandatory
::= { groupEntry 3 }

groupActiveLife OBJECT-TYPE
SYNTAX INTEGER (0..2147483647)
ACCESS read-write
STATUS mandatory
::= { groupEntry 4 }

groupInactiveLife OBJECT-TYPE

ATOS User Guide


Appendix A : private MIB - 470 / 483

SYNTAX INTEGER (0..2147483647)


ACCESS read-write
STATUS mandatory
::= { groupEntry 5 }

groupStartTime OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..9))
ACCESS read-write
STATUS mandatory
::= { groupEntry 6 }

groupStartMonth OBJECT-TYPE
SYNTAX INTEGER
{
january(1),
february(2),
march(3),
april(4),
may(5),
june(6),
july(7),
august(8),
september(9),
october(10),
november(11),
december(12),
none(13)
}
ACCESS read-write
STATUS mandatory
::= { groupEntry 7 }

groupStartDay OBJECT-TYPE
SYNTAX INTEGER (0..31)
ACCESS read-write

ATOS User Guide


Appendix A : private MIB - 471 / 483

STATUS mandatory
::= { groupEntry 8 }

groupOperationList OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..2000))
ACCESS read-only
STATUS mandatory
::= { groupEntry 9 }

groupStartTable OBJECT-TYPE
SYNTAX SEQUENCE OF GroupStartEntry
ACCESS not-accessible
STATUS mandatory
::= { groupConfiguration 2 }

groupStartEntry OBJECT-TYPE
SYNTAX GroupStartEntry
ACCESS not-accessible
STATUS mandatory
INDEX { startGroupId }
::= { groupStartTable 1 }

GroupStartEntry ::=
SEQUENCE {
startGroupId
INTEGER,
startGroupType
INTEGER
}

startGroupId OBJECT-TYPE
SYNTAX INTEGER (1..10)
ACCESS read-only
STATUS mandatory
::= { groupStartEntry 1 }

ATOS User Guide


Appendix A : private MIB - 472 / 483

startGroupType OBJECT-TYPE
SYNTAX INTEGER
{
npmStartNow(1),
npmStartAfter(2),
npmStartTime(3),
npmStop(4),
npmRestart(5),
npmNone(6)
}
ACCESS read-write
STATUS mandatory
::= { groupStartEntry 2 }

groupAddDelOpTable OBJECT-TYPE
SYNTAX SEQUENCE OF GroupAddDelOpEntry
ACCESS not-accessible
STATUS mandatory
::= { groupConfiguration 3 }

groupAddDelOpEntry OBJECT-TYPE
SYNTAX GroupAddDelOpEntry
ACCESS not-accessible
STATUS mandatory
INDEX { operationID }
::= { groupAddDelOpTable 1 }

GroupAddDelOpEntry ::=
SEQUENCE {
operationID
INTEGER,
groupIndex
INTEGER,
opGrouppedStatus

ATOS User Guide


Appendix A : private MIB - 473 / 483

INTEGER
}

operationID OBJECT-TYPE
SYNTAX INTEGER (1..30)
ACCESS read-only
STATUS mandatory
::= { groupAddDelOpEntry 1 }

groupIndex OBJECT-TYPE
SYNTAX INTEGER (0..10)
ACCESS read-write
STATUS mandatory
::= { groupAddDelOpEntry 2 }

opGrouppedStatus OBJECT-TYPE
SYNTAX INTEGER
{
notGroupped(1),
groupped(2)
}
ACCESS read-only
STATUS mandatory
::= { groupAddDelOpEntry 3 }

groupAddDelTable OBJECT-TYPE
SYNTAX SEQUENCE OF GroupAddDelEntry
ACCESS not-accessible
STATUS mandatory
::= { groupConfiguration 4 }

groupAddDelEntry OBJECT-TYPE
SYNTAX GroupAddDelEntry
ACCESS not-accessible
STATUS mandatory

ATOS User Guide


Appendix A : private MIB - 474 / 483

INDEX { groupIdx }
::= { groupAddDelTable 1 }

GroupAddDelEntry ::=
SEQUENCE {
groupIdx
INTEGER,
groupStatus
INTEGER
}

groupIdx OBJECT-TYPE
SYNTAX INTEGER (1..10)
ACCESS read-only
STATUS mandatory
::= { groupAddDelEntry 1 }

groupStatus OBJECT-TYPE
SYNTAX INTEGER
{
groupAdded(1),
groupNotAdded(2)
}
ACCESS read-write
STATUS mandatory
::= { groupAddDelEntry 2 }

responderConfiguration OBJECT IDENTIFIER ::= { npmMib 10 }

responderTable OBJECT-TYPE
SYNTAX SEQUENCE OF ResponderEntry
ACCESS not-accessible
STATUS mandatory
::= { responderConfiguration 1 }

ATOS User Guide


Appendix A : private MIB - 475 / 483

responderEntry OBJECT-TYPE
SYNTAX ResponderEntry
ACCESS not-accessible
STATUS mandatory
INDEX { responderIdx }
::= { responderTable 1 }

ResponderEntry ::=
SEQUENCE {
responderIdx
INTEGER,
responderType
INTEGER,
responderAddress
IpAddress,
responderPort
INTEGER
}

responderIdx OBJECT-TYPE
SYNTAX INTEGER (1..50)
ACCESS read-only
STATUS mandatory
::= { responderEntry 1 }

responderType OBJECT-TYPE
SYNTAX INTEGER { udpRoundTrip(1) }
ACCESS read-only
STATUS mandatory
::= { responderEntry 2 }

responderAddress OBJECT-TYPE
SYNTAX IpAddress
ACCESS read-only
STATUS mandatory

ATOS User Guide


Appendix A : private MIB - 476 / 483

::= { responderEntry 3 }

responderPort OBJECT-TYPE
SYNTAX INTEGER (0..65535)
ACCESS read-only
STATUS mandatory
::= { responderEntry 4 }

dynamicResponderStatus OBJECT IDENTIFIER ::= { npmMib 11 }

controlProtocolEnable OBJECT-TYPE
SYNTAX INTEGER
{
disable(1),
enable(2)
}
ACCESS read-only
STATUS mandatory
::= { dynamicResponderStatus 1 }

numberOfCtrlPacketReceived OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { dynamicResponderStatus 2 }

numberOfError OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
::= { dynamicResponderStatus 3 }

recentSourcesTable OBJECT-TYPE
SYNTAX SEQUENCE OF RecentSourcesEntry
ACCESS not-accessible

ATOS User Guide


Appendix A : private MIB - 477 / 483

STATUS mandatory
::= { dynamicResponderStatus 4 }

recentSourcesEntry OBJECT-TYPE
SYNTAX RecentSourcesEntry
ACCESS not-accessible
STATUS mandatory
INDEX { sourceId }
::= { recentSourcesTable 1 }

RecentSourcesEntry ::=
SEQUENCE {
sourceId
INTEGER,
sourceDescr
OCTET STRING
}

sourceId OBJECT-TYPE
SYNTAX INTEGER (1..5)
ACCESS read-only
STATUS mandatory
::= { recentSourcesEntry 1 }

sourceDescr OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..70))
ACCESS read-write
STATUS mandatory
::= { recentSourcesEntry 2 }

recentErrorSourcesTable OBJECT-TYPE
SYNTAX SEQUENCE OF RecentErrorSourcesEntry
ACCESS not-accessible
STATUS mandatory
::= { dynamicResponderStatus 5 }

ATOS User Guide


Appendix A : private MIB - 478 / 483

recentErrorSourcesEntry OBJECT-TYPE
SYNTAX RecentErrorSourcesEntry
ACCESS not-accessible
STATUS mandatory
INDEX { errorSourceId }
::= { recentErrorSourcesTable 1 }

RecentErrorSourcesEntry ::=
SEQUENCE {
errorSourceId
INTEGER,
errorSourceDescr
OCTET STRING
}

errorSourceId OBJECT-TYPE
SYNTAX INTEGER (1..5)
ACCESS read-only
STATUS mandatory
::= { recentErrorSourcesEntry 1 }

errorSourceDescr OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..70))
ACCESS read-write
STATUS mandatory
::= { recentErrorSourcesEntry 2 }

--- Trap definitions


--

remoteAdminOffTrap TRAP-TYPE
ENTERPRISE aethra

ATOS User Guide


Appendix A : private MIB - 479 / 483

VARIABLES { remoteIfcDescr, remoteIfcAdminStatusValue }


DESCRIPTION
"This trap is to notify the manager that the remote admin
status (remoteIfcAdminStatusValue) of an interface
(remoteIfcDescr) is off . The manager can't manages the
CPE through this interface."
::=

atosGenericAlarmTrap TRAP-TYPE
ENTERPRISE aethra
VARIABLES { atosGenericAlarm }
DESCRIPTION
"This trap is used to send generic string alarm messages
(atosGenericAlarm) to SNMP manager, when a particular
condition occurs."
::=

upsNetworkNotPresentTrap TRAP-TYPE
ENTERPRISE aethra
DESCRIPTION
"This trap is used for notify the manager that the network
is not present."
::=

upsNetworkPresentTrap TRAP-TYPE
ENTERPRISE aethra
DESCRIPTION
"This trap is used for notify the manager that the network
is present."
::=

upsBatteryLowTrap TRAP-TYPE
ENTERPRISE aethra
DESCRIPTION
"This trap is used for notify the manager the 'battery low

ATOS User Guide


Appendix A : private MIB - 480 / 483

status'."
::=

upsBatteryDecayTrap TRAP-TYPE
ENTERPRISE aethra
DESCRIPTION
"This trap is used for notify the manager the 'battery decay
status'."
::=

upsBatteryBrokenTrap TRAP-TYPE
ENTERPRISE aethra
DESCRIPTION
"This trap is used for notify the manager the 'battery broken
status'."
::=

tftpSessionStartTrap TRAP-TYPE
ENTERPRISE aethra
VARIABLES { tftpSessionStatus }
DESCRIPTION
"Notify the manager that the TFTP session started by SNMP
is in progress."
::=

tftpSessionStopTrap TRAP-TYPE
ENTERPRISE aethra
VARIABLES { tftpSessionStatus }
DESCRIPTION
"Notify the manager that the TFTP session started by SNMP is
terminated."
::=

ifcSerialV35DOWN TRAP-TYPE
ENTERPRISE aethra

ATOS User Guide


Appendix A : private MIB - 481 / 483

DESCRIPTION
"This trap is used for notify the manager the 'V35 DOWN (AIS ON)'."
::=

10

ifcSerialV35UP TRAP-TYPE
ENTERPRISE aethra
DESCRIPTION
"This trap is used for notify the manager the 'V35 UP (AIS OFF)'."
::=

11

ifcE1AIS2MOn TRAP-TYPE
ENTERPRISE aethra
DESCRIPTION
"This trap is used for notify the manager the 'E1 AIS-2M On'."
::=

12

ifcE1AIS2MOff TRAP-TYPE
ENTERPRISE aethra
DESCRIPTION
"This trap is used for notify the manager the 'E1 AIS-2M Off'."
::=

13

ifcE1PhyOn TRAP-TYPE
ENTERPRISE aethra
DESCRIPTION
"This trap is used for notify the manager the 'E1 line up'."
::=

14

ifcE1PhyOff TRAP-TYPE
ENTERPRISE aethra
DESCRIPTION
"This trap is used for notify the manager the 'E1 line down'."
::=

15

npmConnectionLostOff TRAP-TYPE

ATOS User Guide


Appendix A : private MIB - 482 / 483

ENTERPRISE aethra
::=

16

npmConnectionLostOn TRAP-TYPE
ENTERPRISE aethra
::=

17

npmTimeoutOff TRAP-TYPE
ENTERPRISE aethra
::=

18

npmTimeoutOn TRAP-TYPE
ENTERPRISE aethra
::=

19

npmRttOverThresholdOff TRAP-TYPE
ENTERPRISE aethra
::=

20

npmRttOverThresholdOn TRAP-TYPE
ENTERPRISE aethra
::=

21

npmVerifyErrorOff TRAP-TYPE
ENTERPRISE aethra
::=

22

npmVerifyErrorOn TRAP-TYPE
ENTERPRISE aethra
::=

END
--- ATOS-MIB.mib

23

ATOS User Guide


Appendix A : private MIB - 483 / 483

--

You might also like