Top Banner
VOIPBOX VoIP Client Appliance USER GUIDE
73
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: UserGuide VOIPbox Client

VOIPBOX

VoIP Client Appliance

USER GUIDE

Page 2: UserGuide VOIPbox Client

Published By: ApplianSys Limited

University of Warwick Science Park

Business Innovation Centre

Binley Business Park

Coventry, CV3 2TX

Copyright © 2009 ApplianSys Ltd. All Rights Reserved. No part of the contents of this document may be reproduced or

transmitted in any form or by any means electronic or otherwise without the written permission of ApplianSys Limited.

Page 3: UserGuide VOIPbox Client

VOIPBOX Client User Guide

Contents

Using This Guide 2

SECTION 1: HARDWARE & MODELS 5

Hardware 6

Models 6

Models 7

SECTION 2: USING VOIPBOX 11

Getting Started 12

Online Help and Documentation 19

Setting up VOIPBOX Client 20

Configuration Options 23

SECTION 3: CONFIGURATION REFERENCE 27

SYSTEM Menu 28

NETWORK Menu 37

VOIP Menu 46

SECTION 4: FREQUENTLY ASKED QUESTIONS 53

Deployment 54

Hardware 54

APPENDICES 55

Appendix A: Web Interface Layout 55

Appendix B: ViBE Configuration Options 58

Appendix C: Configuring Netgear DGN-2000 70

Page 4: UserGuide VOIPbox Client

VOIPBOX Client User Guide

2 I Using This Guide

Using This Guide

Products Covered

This guide will help you set up and configure VOIPBOX client appliances. If you are

looking for information on how the VOIPBOX works and the way it should be deployed

refer to the VOIPBOX server guide. This guide describes how to configure the client to

connect to a VOIPBOX server already deployed.

This guide applies to all current models in the VOIPBOX client range:

Small Form Factor (SFF)

���� VOIPBOX020

���� VOIPBOX030

1U

���� VOIPBOX110

���� VOIPBOX120

���� VOIPBOX130

These models all share the same software and core feature set. Any variations relevant

to specific models are because of their different hardware specifications. A few

software features are hardware dependent so see minor variations in use in different

models. These variations are noted in the guide.

How This Guide Is Organised

As you can see from the list of Contents, the guide has been organised into sections to

help install a VOIPBOX client. Full information on how the clients are deployed and

utilised with VOIPBOX servers is in the server user guide:

���� ‘USING VOIPBOX’ - walk through the main tasks you will typically have with

VOIPBOX:

- Get the appliance installed and started

- Set the appliance up to communicate with a server

- Route voice and where needed data through the server

The remaining sections are for you to refer to whenever you need a specific piece of

information:

���� ‘CONFIGURATION REFERENCE’ - describes in detail each of the screens you can

find in your appliance’s Web Administration Interface.

���� ‘FREQUENTLY ASKED QUESTIONS’ – on deployment, support, managing the

appliance, performance, security and hardware

���� ‘APPENDICES’ – further information you might need in specific scenarios

Page 5: UserGuide VOIPbox Client

VOIPBOX Client User Guide

Using This Guide I 3

Conventions Used in This Guide

The following formats have been used to help you use this guide:

� [KEYSTROKE]

���� Something you have to type, a drop down or radio button setting

(fixed width font)

VOIPBOX commands (fixed width font)[console display]

� ‘menu option'

� Fieldname

���� ON SCREEN BUTTON

���� URLS: www.urls_and_IP_addresses.com

Alert: be aware of a potential issue - something you should avoid or something you are

advised to do. You will find a description of the risk and how to resolve or avoid it in the

Alert format.

Critical Alerts are written in a bold, red font. It is very important that you pay attention to

these.

Note: extra information, not directly part of the instructions or reference material, but

which may still be useful for you to know

Tip: advice to help you make faster or more efficient use of the product with

workarounds and timesaving techniques

����

Page 6: UserGuide VOIPbox Client

4 I Using This Guide

Page 7: UserGuide VOIPbox Client

VOIPBOX Client User Guide

HARDWARE & MODELS I 5

SECTION 1: HARDWARE & MODELS

IN THIS SECTION A summary of hardware used and models

available for VOIPBOX clients

Hardware 6

Models 7

Page 8: UserGuide VOIPbox Client

VOIPBOX Client User Guide

6 I HARDWARE & MODELS - Hardware

Hardware

VOIPBOX uses specially selected hardware to ensure both reliability and high

performance without unnecessary cost.

CompactFlash cards are used for the operating system and settings. This has several

advantages over traditional hard disks:

���� Hard disks have moving parts and are the primary cause of hardware failure. So

being diskless VOIPBOX is much more reliable

���� It means faster boot times and gives more resilience to hardware failure. If you

suffer an unexpected power outage, the risk of configuration data and

application corruption is minimised

���� The cards can be removed from each unit, allowing them to be moved to a

spare or new appliance in the unlikely event of failure, retaining all settings and

license information and data. The replacement unit instantly continues from

where the failed unit left off, without the need to reinstall software or recover

data

You can also use a ViBE enabled Netgear DGN-2000 as a client. Details of how to

configure this device are provided in this guide.

Page 9: UserGuide VOIPbox Client

VOIPBOX Client User Guide

HARDWARE & MODELS - Models I 7

Models

There are five products in the client range and all products in the range run the same

software but differ in terms of hardware and performance. This allows them to support

different types of deployment. All products run from CompactFlash card and do not use

disks.

Clients

VOIPBOX020 is the entry level product in the range. It differs from the other devices in that

there is only a serial line for set up. All the other devices can be set up with a monitor

and keyboard or by using the serial line.

VOIPBOX030 and VOIPBOX110 are mid range devices. They differ in the following ways:

VOIPBOX110 is a 1U rack-mountable device whereas VOIPBOX030 is a small form factor

(SFF) unit designed to be placed on a desk/shelf. Due to the shallow depth of

VOIPBOX110 and external power adapter it is suitable for mounting in communications

cabinets as well as full racks in data centres. In cabinets where there is no active

ventilation it is suggested that the power adapter is put outside of the cabinet and cord

fed into it to minimise additional heat inside.

VOIPBOX030 has one network interface VOIPBOX130 has two network interfaces.

VOIPBOX120 and VOIPBOX130 are 1U rack-mountable devices, with two network

interfaces. Due to their depth they need to be deployed in a full rack. They have side to

side ventilation and as such cannot be mounted on rails. They must have their weight

supported by either a shelf or other piece of equipment that is secured directly below.

Page 10: UserGuide VOIPbox Client

VOIPBOX Client User Guide

8 I HARDWARE & MODELS - Models

VOIPBOX020

Front:

Rear (subject to change):

VOIPBOX030

Front:

Rear (subject to change):

Page 11: UserGuide VOIPbox Client

VOIPBOX Client User Guide

HARDWARE & MODELS - Models I 9

VOIPBOX110

Front:

Rear (subject to change):

VOIPBOX120

Front:

Rear (subject to change):

Page 12: UserGuide VOIPbox Client

VOIPBOX Client User Guide

10 I HARDWARE & MODELS - Models

VOIPBOX130

Front:

Rear (subject to change):

Page 13: UserGuide VOIPbox Client

VOIPBOX Client User Guide

USING VOIPBOX I 11

SECTION 2: USING VOIPBOX

IN THIS SECTION Walk through the main tasks you will typically

have with VOIPBOX Client

���� Get the appliance installed and started

���� Set the appliance up for the type of

deployment required

���� Configure the appliance to connect to

server

���� Carry out key appliance administration

tasks you would usually carry out on an

ongoing basis

Getting Started 12

Physical Setup 12

Network Requirements 14

Initial Appliance Configuration 15

Online Help and Documentation 19

Setting up VOIPBOX Client 20

Packet Routing 22

Configuration Options 23

Users & logging in 23

Restricting access to administration services 23

Administration over SSH 23

Static Routes 23

SNMP Logging and Alerting 24

System Log 24

Firewall 24

Port forwarding 24

Configuration restore and backup 24

Current status 25

Upgrades 25

Power Control 25

Page 14: UserGuide VOIPbox Client

VOIPBOX Client User Guide

12 I USING VOIPBOX - Getting Started

Getting Started

This step-by-step guide will help you to start using your appliance as quickly as possible. If

at any time you need further assistance, contact your vendor (ApplianSys Support

Partner or ApplianSys):

ApplianSys Support: Email Support:

+44 (0) 8707 707 789 [email protected]

Physical Setup

Step 1

Unpack your client, check that all items listed on your delivery note are present and then

check for transit damage.

���� VOIPBOX is supplied with a power cable with a suitable plug for the country to

which it is originally supplied. Check you have the right cable.

Please contact your vendor immediately if anything is missing or damaged

Step 2

VOIPBOX series 1U appliances should be secured in a rack. For the full depth 1U devices

a shelf (or piece of securely fixed equipment below) is required – no rails are provided

and the whole weight of each unit should not be placed on the lugs. Ventilation in each

unit is from side to side.

Your appliance should be positioned such that adequate airflow can be achieved

Choose a suitable place to house your VOIPBOX and connect it to a 240V or 110V AC

mains supply as appropriate (hardware is auto-switching)

VOIPBOX is supplied with a power cable for the country to which it is sold. If you do not

have the appropriate cable please contact ApplianSys support.

For initial deployment you will need a PS2 keyboard, VGA monitor, cat 5 network cable

and network addressing information to hand. For VOIPBOX020 you will need a serial

cable instead of a VGA monitor and PS2 keyboard.

All models should be positioned such that adequate airflow can be achieved.

You can place VOIPBOX030 on a desk or a shelf within a rack. It is slightly more than 1U

high. Ventilation is from the bottom of the unit. Do not attempt to remove the feet on the

underside or overheating could occur. If placed in a rack without fan units (e.g. a wall-

mounted communications cabinet) the power brick should be placed outside the rack

and the cable looped through to reduce the heat generated within the cabinet.

VOIPBOX110 should be secured in a rack. They are 1U in height. No shelf is required – the

lugs can support the weight. Ventilation is from the front to the back of the unit. If placed

Page 15: UserGuide VOIPbox Client

VOIPBOX Client User Guide

USING VOIPBOX - Getting Started I 13

in a rack without fan units (i.e. a wall mounted communications cabinet) the power

brick should be placed outside the rack and the cable looped through to reduce the

heat generated within the cabinet

VOIPBOX120/130 appliances should be secured in a rack. They are 1U in height. A shelf (or

piece of securely fixed equipment below) is required – no rails are provided and the

whole weight of each unit should not be placed on the lugs. Ventilation in each unit is

from side to side.

To avoid an IP address conflict between the VOIPBOX default IP address and any other

equipment on your network do not connect the network cable until you have

performed initial setup.

The communication settings required for a serial connection are 38,400 bps, 8 data bits,

no parity, 1 stop bit (8N1).

For VOIPBOX120 and VOIPBOX130 only: the green button on the front panel should be lit

to show that the unit is switched on. If it is not, press it to switch on the unit.

Page 16: UserGuide VOIPbox Client

VOIPBOX Client User Guide

14 I USING VOIPBOX - Getting Started

Network Requirements

The following table details all port & protocol usage of the VOIPBOX. Use this information

to aid configuration of the appliance attached to your network.

80/TCP Appliance web administration system

443/TCP Appliance web administration system

22/TCP SSH (debugging service, enabled by

default)

161/UDP SNMP

53/TCP DNS

53/UDP DNS

65500/UDP VoIP tunnel

The ‘admin address restriction’ feature (found in the ‘configure’ section of the web

administration system) limits access to administration services offered by the appliance.

The full list of protected services is:

���� Web Administration

���� SNMP

���� SSH

Page 17: UserGuide VOIPbox Client

VOIPBOX Client User Guide

USING VOIPBOX - Getting Started I 15

Initial Appliance Configuration

VOIPBOX Client is provided preconfigured with the following network settings:

���� IP Address: 192.168.100.100

���� Netmask: 255.255.255.0

���� Default GW: 192.168.100.1

� DNS: 192.168.100.1

���� Username: admin

���� Password: admin

Console configuration

Step 1

Attach a serial port null modem cable or connect a VGA monitor and keyboard to your

appliance. Note the VGA and keyboard ports are not available on some of the smaller

appliances and they will only accept a serial port.

Step 2

With a serial cable using an application of your choice (such as Hyper Terminal),

connect to a serial port and to listen to its output.

Step 3

Once booted, login using the default account details:

Username: admin

Password: admin

Page 18: UserGuide VOIPbox Client

VOIPBOX Client User Guide

16 I USING VOIPBOX - Getting Started

On the following screen, enter the hostname you wish to assign to the appliance; the

network address and netmask; the default gateway, and the DNS servers that the

VOIPBOX can use to resolve network addresses.

When used behind an ADSL router, the gateway and DNS server will usually be the same,

being the address of the ADSL router on the LAN. If DHCP is in use on the LAN, ensure

that the DHCP server cannot assign the address assigned to the VOIPBOX to another

device.

Step 4

Type console_ui and press [RETURN] to start configuring your VOIPBOX. On the

following screen, enter the hostname you wish to assign to the appliance; the network

address and netmask; the default gateway, and the DNS servers that the VOIPBOX can

use to resolve network addresses.

When used behind an ADSL router, the gateway and DNS server will usually be the same,

being the address of the ADSL router on the LAN. If DHCP is in use on the LAN, ensure

that the DHCP server cannot assign the address assigned to the VOIPBOX to another

device.

Step 5

On the next screen you should enter the type of network connection, , either ‘1. auto-

negotiated’ or ‘2. 100baseTX—FD’ (100Mb/s, full duplex). The latter setting may be

required to force the speed of the link to the top speed. Once selected, wait a few

seconds while these parameters are saved.

Step 6

You will now need to set the password for the administrator. Type the same password

twice, and remember that it is case–sensitive. You will not see any characters appear

on screen as this process is not echoed back.

The user name remains fixed as “admin”.

Configuration can now continue from a web browser.

Your browser must support Javascript.

Page 19: UserGuide VOIPbox Client

VOIPBOX Client User Guide

USING VOIPBOX - Getting Started I 17

Step 7

From a web browser go to the hostname/network address you assigned in step 3. Open

a browser (it is recommended that you use Mozilla Firefox, Google Chrome or IE7+) at a

machine that has network access to the VOIPBOX. Type the address of the VOIPBOX

Client you assigned in step 3 into the address bar. If you are still using the default settings

then use http://192.168.100.100

This will redirect automatically to the HTTPS interface.

You will be taken to the login screen below:

Step 8

Click on the small orange shield icon next to the LOGIN button. This allows you to install

the self signed certificate onto your machine so that your browser recognises the

appliances as a trusted connection.

Page 20: UserGuide VOIPbox Client

VOIPBOX Client User Guide

18 I USING VOIPBOX - Getting Started

Step 9

To add a VOIPBOX license click ‘voip’ > ‘licensing’ from the menu. Click the REQUEST

LICENCE button and copy the ‘Licence String’ into an email and send this to your

VOIPBOX vendor. Once they have sent you a new code paste this into the Licence

String field and click SAVE.

Your VOIPBOX Client is now ready for configuration.

Page 21: UserGuide VOIPbox Client

VOIPBOX Client User Guide

USING VOIPBOX - Online Help and Documentation I 19

Online Help and Documentation

In addition to this manual, VOIPBOX Client also has an online help system.

You can access this by clicking the help icon next to each section header. This opens

a popup window containing context sensitive help.

Some fields have a blue information icon next to them. If you put your mouse over the

icon a popup appears giving you more information about the field.

Page 22: UserGuide VOIPbox Client

VOIPBOX Client User Guide

20 I USING VOIPBOX - Setting up VOIPBOX Client

Setting up VOIPBOX Client

After logging into the VOIPBOX client and clicking on the ’voip’ tab you will see the

following page:

Client IP Options

An ISP will provide an IP address to the client site in one of two ways, statically or

dynamically.

For VOIPBOX in Static mode, the VOIPBOX Server must first know where the client is

located. The server sends a “setup” message to the client requesting that it establishes a

tunnel to the provision IP previously configured.

To deploy a VOIPBOX Client with a Dynamic IP the server has a fixed IP and has to tell

the client where the server is located. To secure connections and authenticate unique

clients we use the hardware MAC address. In order to further secure this connection we

also expect a pre-defined password from the client which encrypts the data being sent

between devices.

Configure connection between Client and Server

First you must have…

���� Physically installed and connected your VOIPBOX client to the network

���� Assigned the client an IP address

Page 23: UserGuide VOIPbox Client

VOIPBOX Client User Guide

USING VOIPBOX - Setting up VOIPBOX Client I 21

1 Log in to the Web Interface as ‘admin’

2 Click the ’VoIP’ tab and select ’Deployment’ from the left hand navigation menu

Configure connection using ‘Static’ mode

1 Enter the password you have been provided with to authenticate against the

server in Provision Password

2 If you have not checked Route Packets enter the address of the network you’re

routing through the VoIP tunnel in the Network field

In most circumstances, the Route Packets option is enabled. All traffic from the

VOIPBOX is routed through the link to the VOIPBOX server which then forwards it

on. This means that the full capability of the VOIPBOX optimization is used; VoIP

traffic has highest quality and the data traffic is optimised in both directions.

However, it may be required in some cases that data traffic is not routed to the

VOIPBOX server.

Page 24: UserGuide VOIPbox Client

VOIPBOX Client User Guide

22 I USING VOIPBOX - Setting up VOIPBOX Client

Configure connection using ‘Dynamic’ mode

1 Enter the password you have been provided with to authenticate against the

server in Provision Password

2 Enter the IP address of the VOIPBOX server you have been provided with in

Provision Server

3 If you have not checked Route Packets enter the address of the network you’re

routing through the VoIP tunnel in the Network field

Page 25: UserGuide VOIPbox Client

VOIPBOX Client User Guide

USING VOIPBOX - Configuration Options I 23

Configuration Options

Users & logging in

The VOIPBOX can support multiple local users each with their own password.

���� Click ‘system’ > ‘users’. Then click the ADD USERS button.

���� Additionally, users can be added using RADIUS authentication, in which case only

their username is required.

The RADIUS server is configured from ‘network’ > ‘settings’, where the IP address

and secret must be entered. Once you have done this you can add a RADIUS

user by selecting ‘system’ > ‘users’ > ADD RADIUS from the menu.

���� Once a user has been added, further information can be added, and their

password updated by the Administrator. You can edit existing users by clicking

the pencil icon next to their names when you select ‘system’ > ‘users’.

���� A user can log out by clicking the log out prompt in the top right corner of the

screen. As an added security measure, users will be automatically logged out

after 60 minutes.

Restricting access to administration services

The VOIPBOX can restrict administration over the Web Interface to a trusted

network.

���� Click ‘network’ > ‘settings’. Add an admin address in CIDR or IP/netmask notation

to the Admin Network field and then click SAVE. If left blank, any network can

administer the VOIPBOX.

Administration over SSH ���� VOIPBOX includes a number of command line tools for power users and these

can be accessed by logging into the VOIPBOX as root using an SSH client. This is

enabled by default, and may be disabled by clicking ’network’ > ‘services’ and

then un-ticking the SSH Service Configuration Enabled checkbox. Click SAVE to

apply the changes

���� The administrator can also access these features by logging in as admin via SSH

and using the same password as the Web Interface. To gain root access, enter

‘sudo su –’ and enter the admin password again.

Static Routes

You can configure additional static routes to enable access to devices on networks that

would otherwise be inaccessible. You can add a new static route by going to ‘network’

> ’static routes’. Existing routes are listed here and you can delete them if you need to.

Page 26: UserGuide VOIPbox Client

VOIPBOX Client User Guide

24 I USING VOIPBOX - Configuration Options

SNMP Logging and Alerting

The VOIPBOX can provide management information via SNMP. Click ‘network’ >

‘settings’. Add an SNMP Community name and click SAVE.

System Log

The VOIPBOX holds recent system log messages. You can view these by going to

’system’ > ‘logging’.

The 100 most recent events are available over a number of pages, with the most recent

shown on page 1.

Other logs produced by the system are also available from this page under the ‘Read

Logs’ heading. Clicking title of the log file will go to a new page that makes the most

recent 10,000 lines of the log available to view. These entries can be downloaded as a

file by clicking the SAVE button.

The syslog can fill quite quickly, losing older messages. To keep the full log information,

the system log can be sent to a syslog server. Enter the IP address or URL of a Remote

Syslog Server at the bottom of this page and click SAVE to enable this feature

Firewall

Normally, only the ports essential for operation of the VOIPBOX are open. If you

need to, you can open custom ports on the appliance.

���� Click ‘network’ > ‘ports’ and click the ADD button. Complete the details under

Port Settings then click SAVE to add it to the list of Opened Ports.

Port forwarding

If you need to forward additional ports to computers connected to your LAN you

can do so by adding a port forwarding rule.

���� First make sure you have opened the port as explained above

���� Next, click ‘Network’ > ‘Port Forward’ and click the ADD button. Complete the

details under the Add Port Forwarding Rule section.

���� Click SAVE to add it to the list of Port Forwarding Rules.

Page 27: UserGuide VOIPbox Client

VOIPBOX Client User Guide

USING VOIPBOX - Configuration Options I 25

Configuration restore and backup

The entire configuration of the VOIPBOX may be saved as a single file, which may be

subsequently restored to this or another VOIPBOX Server. Go to ‘system’ > ‘backup’ and

follow the on-screen instructions.

Current status

It is possible to view various items of information about the system. These are available by

clicking ‘system’ which will show you a System Overview and from ‘system’ > ‘services’

which shows Service Status.

Upgrades

Software upgrade patches are made available from time to time by ApplianSys. New

software versions are normally released to:

���� Upgrade VIBE or the appliance platform to fix newly discovered security

vulnerabilities

���� Fix known bugs

���� Enhance existing features or add new ones

If you have a support contract, you will be contacted when updates are released. You

decide whether you wish to receive the upgrade.

To apply an upgrade, store the patch in a folder you can access. Go to ‘system’ >

‘upgrade’ and click the BROWSE button to select the patch file to be applied and then

click APPLY.

Your web browser will then upload the file from your PC to your VOIPBOX which will

check that the file is a full and complete patch, and that it is appropriate to install on

your version of software.

If these tests are successful then the upgrade will be installed. The appliance will

continue to use the current firmware until it is rebooted at which point it will boot from

the new firmware

Depending on the speed of your network connection, installation may take several

minutes. You will receive a confirmation message when the upgrade is complete. You

will need to reboot the appliance to use the new firmware.

Power Control

The unit can be restarted or powered-down from ‘system’ > ’shutdown’.

An older configuration backup can be used even if the appliance has a newer firmware

version. The backup will automatically be upgraded to match the firmware version

when the appliance is rebooted.

Note that the configuration file is NOT human readable.

Page 28: UserGuide VOIPbox Client
Page 29: UserGuide VOIPbox Client

VOIPBOX Client User Guide

CONFIGURATION REFERENCE I 27

SECTION 3: CONFIGURATION REFERENCE

IN THIS SECTION This section describes each of the screens that

can be found in the Web Administration

Interface.

Note: More detailed help on each section can

be found in the online help system.

SYSTEM Menu 28

Information 28

User Accounts 29

System Services 30

Licensing 31

Logging 32

Alerts 33

Backup 34

Upgrade 35

Restart/Shutdown 36

NETWORK Menu 37

Overview 37

Settings 38

Alias Interfaces 39

Static Routes 40

Services 41

Port Forward 42

Ports 43

SMS 44

SMTP 45

VOIP Menu 46

Overview 46

Deployment 47

Settings 48

Licensing 49

Tunnels 50

NAT 51

Page 30: UserGuide VOIPbox Client

VOIPBOX Client User Guide

28 I CONFIGURATION REFERENCE - SYSTEM Menu

SYSTEM Menu

Information

Description Description of the appliance

Location Text describing the location of the server

Department Location of the appliance within an organisation

Notes Text notes relating to this appliance

Support contact

details

Email address of person to contact if there is a problem

with the appliance

Timezone The time zone in which the appliance is used

Timeserver(s) NTP server used to keep the appliance clock

accurate. Multiple time servers can be specified. It is

recommended that you specify four timeservers. Each

timeserver should be separated by a space.

Page 31: UserGuide VOIPbox Client

VOIPBOX Client User Guide

CONFIGURATION REFERENCE - SYSTEM Menu I 29

User Accounts

Fields are defined as follows:

System users List users, and allow edit, suspend and delete

Add local Enter user name and password

Add RADIUS (only available when

RADIUS server configured)

Enter user name

Page 32: UserGuide VOIPbox Client

VOIPBOX Client User Guide

30 I CONFIGURATION REFERENCE - SYSTEM Menu

System Services

Fields are defined as follows:

Service status Display status of software services

Page 33: UserGuide VOIPbox Client

VOIPBOX Client User Guide

CONFIGURATION REFERENCE - SYSTEM Menu I 31

Licensing

Appliance code Unique code for this appliance

Upload licence file Select licence file and upload it

Appliance licence details Show licence features and their status

Page 34: UserGuide VOIPbox Client

VOIPBOX Client User Guide

32 I CONFIGURATION REFERENCE - SYSTEM Menu

Logging

Fields are defined as follows:

Events Display the most recent events in the log

Read logs Display system log files

Remote syslog Set syslog server to receive syslog messages

Page 35: UserGuide VOIPbox Client

VOIPBOX Client User Guide

CONFIGURATION REFERENCE - SYSTEM Menu I 33

Alerts

Name Descriptive name to help you identify the alert

Type Dropdown options for email, sms or snmp

Email address / SMS

number / SNMP

agent

Depends on the ‘type’ of alert

Hardware Pick from the list of severities to be alerted about

hardware issues. The lower the severity the more often

you will be alerted

System Pick from the list of severities to be alerted about

system issues. The lower the severity the more often

you will be alerted

User Pick from the list of severities to be alerted about user

issues. The lower the severity the more often you will

be alerted

Page 36: UserGuide VOIPbox Client

VOIPBOX Client User Guide

34 I CONFIGURATION REFERENCE - SYSTEM Menu

Backup

Backup system Save configuration to file

Restore system Select file to restore from

Page 37: UserGuide VOIPbox Client

VOIPBOX Client User Guide

CONFIGURATION REFERENCE - SYSTEM Menu I 35

Upgrade

Fields are defined as follows:

Firmware Choose new firmware file

Appliance Version

Information

This shows the firmware and subsystem version. At the

time of writing the subsystem update feature is not

used on VOIPBOX. If subsystem updates become

available in the future an alert will be raised.

Page 38: UserGuide VOIPbox Client

VOIPBOX Client User Guide

36 I CONFIGURATION REFERENCE - SYSTEM Menu

Restart/Shutdown

Fields are defined as follows:

Type Choose whether appliance restarts or shuts down

Reason Text entered in the event log

Immediate or scheduled When the event will happen

Page 39: UserGuide VOIPbox Client

VOIPBOX Client User Guide

CONFIGURATION REFERENCE - NETWORK Menu I 37

NETWORK Menu

Overview

Default route Route providing internet access

Hostname Appliance hostname

DNS server #1 DNS server for external name resolution

SNMP community Name of the SNMP community

Page 40: UserGuide VOIPbox Client

VOIPBOX Client User Guide

38 I CONFIGURATION REFERENCE - NETWORK Menu

Settings

Fields are defined as follows:

Available network

interfaces

Enable, and configure IP address, netmask, link

type and set up bonding for network ports

Default route Router providing internet access

Hostname Appliance hostname

DNS server #1 DNS server for external name resolution

DNS server #2 Alternative DNS server

Admin network Address of network trusted to administer this

appliance

SNMP community Name of the SNMP community

RADIUS server IP address Server for user authentication via a RADIUS server

RADIUS server secret Secret for configuration of link with RADIUS server

Page 41: UserGuide VOIPbox Client

VOIPBOX Client User Guide

CONFIGURATION REFERENCE - NETWORK Menu I 39

Alias Interfaces

Fields are defined as follows:

Interface name Name of the being added

Physical interface List of available interfaces

Alias IP address IP of the interface being added

Subnet mask Mask of the being added

Page 42: UserGuide VOIPbox Client

VOIPBOX Client User Guide

40 I CONFIGURATION REFERENCE - NETWORK Menu

Static Routes

Fields are defined as follows:

Description of route Text description

Network Network and netmask

Router IP address providing access to this route

Page 43: UserGuide VOIPbox Client

VOIPBOX Client User Guide

CONFIGURATION REFERENCE - NETWORK Menu I 41

Services

Fields are defined as follows:

SSH enabled Enable remote administration over SSH

SSH listening port The port on which SSH is listening

Web interface

listening port

The port on which the secure web interface server is

listening

Page 44: UserGuide VOIPbox Client

VOIPBOX Client User Guide

42 I CONFIGURATION REFERENCE - NETWORK Menu

Port Forward

Fields are defined as follows:

Description Text description

Interface Choose between the available network interfaces

(eth0, etc) or ViBE

Protocol TCP/UDP/BOTH

Source address External network address. If left empty will allow all

Destination address IP address where packet was supposed to go

Destination port Port where packet was supposed to go

LAN address IP address to forward packets to

LAN port Forward to different port than source

Enabled Enable the port

Page 45: UserGuide VOIPbox Client

VOIPBOX Client User Guide

CONFIGURATION REFERENCE - NETWORK Menu I 43

Ports

Fields are defined as follows:

Port from Port you want to open

Port to Leave blank for single port or enter for range

Protocol TCP/UDP/BOTH

Description Text description

Enabled Enable port

Page 46: UserGuide VOIPbox Client

VOIPBOX Client User Guide

44 I CONFIGURATION REFERENCE - NETWORK Menu

SMS

Fields are defined as follows:

Provider Dropdown option listing the available providers

Page 47: UserGuide VOIPbox Client

VOIPBOX Client User Guide

CONFIGURATION REFERENCE - NETWORK Menu I 45

SMTP

Fields are defined as follows:

Address The address of the SMTP server you wish to use

Port This is the port on which the SMTP service is listening.

Usually 25 or 587

Username The username for the account on the SMTP service

Password The password for the email account

Use authentication Whether to use the username and password to

authenticate SMTP sessions

Use TLS encryption Whether to encrypt the data sent to the SMTP server

Send test email to Enter an email address if you wish to receive

confirmation that the SMTP server settings are correct

Page 48: UserGuide VOIPbox Client

VOIPBOX Client User Guide

46 I CONFIGURATION REFERENCE - VOIP Menu

VOIP Menu

Overview

Fields are defined as follows:

Client overview Information about the VOIPBOX process. Displays

status information on VIBE and of licences. You can

view the current ViBE configuration by clicking the

[view view.conf] link. To restart the ViBE service click

restart.

Server connections Shows information about connections

Page 49: UserGuide VOIPbox Client

VOIPBOX Client User Guide

CONFIGURATION REFERENCE - VOIP Menu I 47

Deployment

Deployment Mode Static – if the IP is staying the same with

router/modem reboots. Dynamic – if the ISP is not

providing a static IP

Route Packets Send all packets through the tunnel – provides QoS.

Recommended option

Network If route packet option is turned off then this field is

used to determine which packets are going

through the tunnel

Provision password Password used for communication with server

Provision Server Setting available in dynamic mode only – specifies

the server client is trying to connect to

Page 50: UserGuide VOIPbox Client

VOIPBOX Client User Guide

48 I CONFIGURATION REFERENCE - VOIP Menu

Settings

Keepalive Time between keepalive packets.

Packet Loss

Tolerance

Number of keepalive packets, after which link is

considered dead

Custom setting Variety of custom settings. Available by clicking the

CUSTOM SETTINGS button

Page 51: UserGuide VOIPbox Client

VOIPBOX Client User Guide

CONFIGURATION REFERENCE - VOIP Menu I 49

Licensing

License status The expiry date of the installed license

License The license string

Request license If your license is about to expire then you should

request a new license. Click Request Licence to

get a license request string. This should be

forwarded onto your VOIPBOX vendor.

Page 52: UserGuide VOIPbox Client

VOIPBOX Client User Guide

50 I CONFIGURATION REFERENCE - VOIP Menu

Tunnels

Tunnel type List the available link types

Description Text description to help identify the link

Enabled Toggle to switch this link on or off

VOIPBOX Server IP The public IP of the VOIPBOX Server to establish the

tunnel with

Traffic source

address

The IP address from which the client connection will

be made

Maximum upload

rate

The maximum rate at which data from the server

will be downloaded, in kb/s

Parent tunnel

address (kbps)

????

Link max calls Maximum number of calls over the link

Custom setting Variety of custom settings. Available by clicking

the CUSTOM SETTINGS button

Page 53: UserGuide VOIPbox Client

VOIPBOX Client User Guide

CONFIGURATION REFERENCE - VOIP Menu I 51

NAT

Enable NAT on… The interfaces on which to enable NAT

Reset conntrack Use this to reset the conntrack table

Page 54: UserGuide VOIPbox Client
Page 55: UserGuide VOIPbox Client

VOIPBOX Client User Guide

FREQUENTLY ASKED QUESTIONS I 53

SECTION 4: FREQUENTLY ASKED QUESTIONS

IN THIS SECTION This reference section helps you find answers

quickly to the most common questions asked

about VOIPBOX by users deploying it.

Deployment 54

Hardware 54

Page 56: UserGuide VOIPbox Client

VOIPBOX Client User Guide

54 I FREQUENTLY ASKED QUESTIONS - Deployment

Deployment

How do I log in to the administration systems?

Administration functions are accessed through a web-based User Interface. You should

open a web browser (ApplianSys recommends the latest stable releases of Firefox,

Google Chrome or Internet Explorer) and enter the IP address you have assigned the

appliance into your browser address bar.

The default username is admin. These login details are valid for both the web and the

console administration systems.

Can I connect to the appliance using a serial cable to perform local administration?

Yes, as mentioned in the Quick Start Guide (which also came with your appliance), a

serial connection can be established by connecting a suitable 9 pin null-modem cable

to COM1 on the back of the appliance. Terminal software (‘minicom’ or ‘cu’ in *nix, or

Tera Term in Windows are all ideal) should be set to 38,400 bps with 8 data bits, no parity

and 1 stop bit (8N1).

Is there an SSH server on the appliance for remote administration?

Yes and it is enabled by default. To disable it, deselect the SSH Enabled option in the

’network > services’ page. No reboot is necessary for this change to take effect.

Hardware

What is the power consumption?

The maximum draws are 220W for the VOIPBOX120/130 series and 80W for VOIPBOX100/050.

The exact draw will depend on exact usage and specification of components used.

Typically we see about 150W on the VOIPBOX120/130 series and 50W on the

VOIPBOX100/050.

What input voltages will the VOIPBOX work with?

110-240 volts

What type of power cord does VOIPBOX use?

VOIPBOX120/130 always uses an IEC C13 (“Kettle”) cord, which is standard for most

computer power supplies. VOIPBOX100 and VOIPBOX050 may be supplied with an IEC

C13 (“Kettle”), IEC C5 (Clover Leaf) or figure-of-8 cord, depending on the model of

power supply in use at the time.

Page 57: UserGuide VOIPbox Client

VOIPBOX Client User Guide

Appendix A: Web Interface Layout I 55

APPENDICES

APPENDICES

Appendix A: Web Interface Layout

The interface is organised as follows:

SYSTEM

Menu Item Options Description

Overview Software services status and System load

Information

Description

Location

Department

Notes

Support contract details

Timeserver(s)

Timezone

Description of the appliance

Text describing the location of the server

Location of the Appliance within an organisation

Text notes relating to this appliance

Email address of person to contact if there is a problem

with the appliance

Network Time Protocol server used to keep the

appliance clock accurate

The timezone in which the appliance is used

Users Add local user

Add RADIUS user

Enter user name and password

Enter user name

Services Service Status Display status of software services

Licencing

Appliance code

Upload licence file

Appliance licence details

Unique code for this appliance

Select licence file and upload it

Show licence features and their status

Logging

Events

Read Logs

Remote syslog

Display the most recent events in the log

Display system log files

Set syslog server to receive syslog messages

Alerts

Name

Type

Email address / SMS

number / SNMP agent

Hardware

System

User

Descriptive name to help you identify the alert

Dropdown options for email, sms or snmp

Depends on the ‘type’ of alert

Pick from the list of severities to be alerted about

hardware issues. The lower the severity the more often

you will be alerted

Pick from the list of severities to be alerted about

system issues. The lower the severity the more often

you will be alerted

Pick from the list of severities to be alerted about user

issues. The lower the severity the more often you will be

alerted

Backup Backup system

Restore system

Save configuration to file

Select file to restore from

Upgrade Firmware Choose file with firmware containing new firmware

Shutdown

Type

Reason

Immediate or scheduled

Choose whether appliance restarts or shuts down

Text entered in the event log

When the event will happen

Page 58: UserGuide VOIPbox Client

VOIPBOX Client User Guide

56 I Appendix A: Web Interface Layout

NETWORK

Menu Item Options Description

Overview Network status and information.

Settings

Available network

interfaces

Default route

Hostname

DNS server #1

DNS server #2

Admin network

SNMP community

RADIUS server’s IP address

RADIUS server’s secret

Enable, and configure IP address, netmask, link type

and set up bonding for network ports

Router providing Internet access

Appliance hostname

DNS server for external name resolution

Alternative DNS server

Address of network trusted to administer this appliance

Server for user authentication

Secret for configuration of link with RADIUS server

Alias interfaces

Interface name

Physical interface

Alias IP address

Subnet mask

Name of the being added

List of available interfaces

IP of the interface being added

Mask of the being added

Static Routes

Description of route

Network

Router

Text description

Network and netmask

IP address providing access to this route

Services

SSH enabled

SSH listening port

Web interface listening

port

Enable remote administration over SSH

The port on which SSH is listening

The port on which the secure web interface server is

listening

Port

Forwarding

Description

Interface

Protocol

Source address

Destination address

Destination port

LAN address

LAN port

Enabled

Text description

eth0/vibe

TCP/UDP/BOTH

External network or empty (allow all)

IP address where packet was supposed to go

Port where packet was supposed to go

IP address to forward packets to

Forward to different port than source

Enable the port

Ports

Port from

Port to

Protocol

Description

Enabled

Port you want to open.

Can be used as port range.

TCP/UDP/BOTH

Text description

Enable port

SMS Provider Dropdown option listing the available providers

SMTP

Address

Port

Username

Password

Use authentication

Use TLS encryptions

Send test email to

The address of the SMTP server you wish to use

This is the port on which the SMTP service is listening.

Usually 25 or 587

The username for the account on the SMTP service

The password for the email account ?

Whether to use the username and password to

authenticate SMTP sessions

Whether to encrypt the data sent to the SMTP server

Enter an email address if you wish to receive

confirmation that the SMTP server settings are correct

Page 59: UserGuide VOIPbox Client

VOIPBOX Client User Guide

Appendix A: Web Interface Layout I 57

VOIP

Menu Item Options Description

Overview

Client overview

Server connections

Information about the VOIPBOX process. Displays

status information on VIBE and of licences. You can

view the current ViBE configuration by clicking the

[view view.conf] link. To restart the ViBE service click

restart.

Shows information about connections

Deployment

Deployment Mode

Route packets

Network

Provision password

Provisioning server

Static – if the IP is staying the same with router/modem

reboots. Dynamic – if the ISP is not providing a static IP

Send all packets through the tunnel – provides QoS.

Recommended option

If route packet option is turned off then this field is used

to determine which packets are going through the

tunnel Password used for communication with server

Password used for communication with server

Setting available in dynamic mode only – specifies the

server client is trying to connect to

Settings

Keepalive Interval

Packet Loss Tolerance

Customer setting

Time between keep alive packets

Number of keepalive’s before considering the link as

dead

Variety of custom settings. Available by clicking the

CUSTOM SETTINGS button

Licensing

License status

License

Request license

The expiry date of the installed license

The license string

If your licence is about to expire then you should

request a new licence. Click Request Licence to get a

licence request string. This should be forwarded onto

your VOIPBOX vendor.

Tunnels

Link type

Description

Enabled

Remote VOIPBOX Server

IP

Traffic source address

Maximum download rate

Customer setting

List the available link types

Text description to help identify the link

Toggle to switch this link on or off

The public IP of the VOIPBOX Server to establish the

tunnel with

The IP address from which the client connection will be

made

The maximum rate at which data from the server will

be downloaded, in kb/s

Variety of custom settings. Available by clicking the

CUSTOM SETTINGS button

NAT Enabled NAT on…

Reset conntrack

The interfaces on which to enable NAT

Use this to reset conntrack table?

Page 60: UserGuide VOIPbox Client

VOIPBOX Client User Guide

58 I Appendix B: ViBE Configuration Options

Appendix B: ViBE Configuration Options

The “Valid” column indicates whether the option is valid in the (G) global, (R) remote, or

(N) network sections of the configuration file.

Option Name Valid in Default Setting Description

add_routes = R yes Whether to automatically add

kernel routes for networks to this

remote when this tunnel comes up.

(And remove them if this tunnel

goes down.)

adsl_stat_cmd = G “” Command to run in order to

determine ADSL line speed. Used in

modem devices only

adsl_stat_tpl = G “” Template string specifying how we

determine the line speeds from the

output of adsl_stat_cmd. Used in

modem devices only

aggressive_timing =

aggressive_window =

R no Use more aggressive timings when

calculating how much bandwidth

should be available.

auto_fw = G 0.0.0.0 IP address top pass to clients that

support automatic firewall rule

generation when provisioning. If

supported, a firewall rule will be

generated by the CPE device that

only allows traffic from the given IP

address. This prevents hijacking of

the CPE by another ViBE device.

backup = R none Specify the IP of a remote ViBE box

which is at the far end of a backup

network link (such as ISDN. ) The IP

should be the same as the IP of

another specified remote device,

which should not contain any

network blocks but can use other

parameters such as up_rate.

bind_address = G 0.0.0.0 Source address for ViBE packets if

not decided by other means ( see

watch_address/secondary_address

)

block_invite = G/R yes Whether or not to block SIP INVITE

messages if the max_calls limit is

reached.

(see also send_sip_busy)

bras_profile G/R bt Select bras profile to use. Options

Page 61: UserGuide VOIPbox Client

VOIPBOX Client User Guide

Appendix B: ViBE Configuration Options I 59

Option Name Valid in Default Setting Description

are, bt, “percent80”,, “percent70”,

“percent60”, “percent50”,

cell_sz = G/R 53 Layer 2 raw cell size in bytes, before

any overheads. Non cell based

technologies should specify “0”. 53

bytes is standard ATM cell size.

cell_oh = G/R 5 Un-usable overhead per L2 cell. 5

bytes is standard for AAL5. Ignored

if cell_sz = 0

(see also pkt_oh and l2oh)

checksum_offload = G/R no Don't generate checksums for RTP

packets. This eases processor load

on the smaller platforms and should

be fine where the destination for

the RTP will be the LAN.

dead_ms = G/R 1000 If no data is received in this time,

then the remote is considered

down and routes to networks

destined for this remote are

removed from the kernel routing

table ( if permanent is no. )

detrunk_port = G 65500 UDP port on which to listen for ViBE

packets.

dg834gt = G no Enable specific fixes for the

Netgear DG834GT

down_rate = R 0 If set, this is sent to the remote CPE

upon provisioning to become its

up_rate.

force_local R no Causes packets travelling within a

VPN but passing through this

device to be seen by the kernel.

Forces packets to exit and re-enter

the ViBE interface. Allows packets

to be seen by TCPdump etc.

gateway N N/A Specifies the gateway address for

a network entry that will be

created in the kernel routing table

when the tunnel specified by the

remote containing the “network {}”

command is established. The traffic

destined for the specified network

will use the specified gateway and

NOT the ViBE tunnel. The entry

specified by the “network {}”

command is removed when the

tunnel is down.

Page 62: UserGuide VOIPbox Client

VOIPBOX Client User Guide

60 I Appendix B: ViBE Configuration Options

Option Name Valid in Default Setting Description

inet_address = R N/A Specifies the WAN IP address for a

centrally provisioned device.

Generally all traffic from the LAN of

the CPE device which is not

destined for an RFC1918 address

will be source NATed to this

address.

interval = G 1000 Minimum period between ViBE

packets (in uS. )

isdefault = R no Set this remote as our default route.

keepalive_ms = G/R 100 Time (mS) between sending

keepalive packets when there is no

data.

l2oh = G/R 0 This is added to pkt_oh and is

intended as a way of accounting

for additional overheads such as

those created by an IPsec tunnel.

links = R 0 Specifies the number of ViBE

tunnels to establish when creating

a bonded link to CPE devices with

dynamic IP addresses. The source

addresses to be used are picked

up from the “multilink_source = {}”

parameter

link_max_calls R N/A Sets the maximum number of calls

that this link can support as part of

a bonded set or in a failover

situation. This is used in conjunction

with the max_calls parameter,

which specifies that overall

maximum call capacity. Effective

max calls value is the smaller of

either the max_calls value, or the

value of the sum of all of the

link_max_calls values for the active

links.

link_type = G/R aal5 Simple way to set the default

network parameters of cell_sz,

cell_oh, and pkt_oh. Can be “aal5”

or ”ether”

local = N no Specifies that this network is NOT to

be sent to this remote ( used for

chopping out smaller blocks of a

large network. )

log_quality = R 62258 Generate a syslog entry if the

quality of this tunnel drops below

this figure (65535 = 100%)

Page 63: UserGuide VOIPbox Client

VOIPBOX Client User Guide

Appendix B: ViBE Configuration Options I 61

Option Name Valid in Default Setting Description

max_calls = G/R 30 Maximum number of RTP streams

allowed to this remote. This is taken

directly from the licensed call limit

regardless of whether this many

calls are actually ever made.

metric N N/A Specifies the network metric for a

network entry that will be created

in the kernel routing table when the

tunnel specified by the remote

containing the “network {}”

command is established. The entry

specified by the “network {}”

command is removed when the

tunnel is down.

min_route_prefix = G 25 If require_remote_routes is true, this

is the minimum prefix length of a

route which is considered specific

enough to a remote ViBE box.

misc_allocation = G/R 10 Minimum percentage of

bandwidth to allocate for Data

traffic (Ensures that SIP/H.323 etc.

signalling always gets through.)

mtu = G/R 1450 MTU to this remote. Will be

determined automatically in future.

multilink_source = {} G/R {} Allows a list of source addresses to

be specified that will be used, in

sequence, by a remote establishing

a bonded link of multiple tunnels to

CPE devices with dynamic IP

addresses

name = “name” R “" Added within a remote section will

cause the “name” to be displayed

in the status pages etc. Can also

be interrogated by SNMP. Quotes

“” are mandatory if the name

includes spaces.

network <net>{}

R N/A The <net> parameter specifies a

network route which should be

added for this CPE device.

Parameters specific to this network

are enclosed in braces {}. For

example network 192.168.0.0/24 {}

would cause all traffic directed to

192.168.0.x to be sent to the remote

CPE specified in the enclosing

remote section. If the options for

this network contain a vpn_id

parameter, then only traffic from

Page 64: UserGuide VOIPbox Client

VOIPBOX Client User Guide

62 I Appendix B: ViBE Configuration Options

Option Name Valid in Default Setting Description

remote CPEs with the

corresponding VPN ID and directed

at the network will be sent to this

CPE.

nofrag = G/R no Do not fragment ViBE protocol

packets even if the interval setting

is too high to use all of the

available bandwidth.

no_ttl = G no Normally ViBE sets the TTL field of

outbound packets to 255, and

does not accept packets that

have a different TTL from those that

were first seen when the tunnel was

first negotiated. This is used to

prevent packet injection if

deployed in an ISPs network, and

makes packet injection extremely

difficult in other situations. This

option turns this feature off.

packet_queues = G/R 3 Number of data traffic classes to

this remote

packet_queue_size = G 50 Data packet queue size ( per QoS

class. )

parent = <address> G/R N/A Used to designate this link as part of

a VLB (ViBE Link Bonding) set. The

address is the address of the

“parent link” i.e. the “remote”

section that contains network, max

calls etc. information for the

bonded link. The “remote” section

that contains a “parent” command

should contain a source_address

command and an up_rate

command to specify the link source

and data rate. Note: Although the

term “parent” is used, it is solely for

configuration purposes. All links in a

VLB set are treated equally and

there is no greater reliance on any

one link over any other.

password = R N/A Specify a password to use when

provisioning. New installations

should use this in preference to the

older “provision_password”

permanent = G/R no Do not perform dead peer

detection. Will not work correctly

with provisioned CPE because new

provisioning data will never be sent,

Page 65: UserGuide VOIPbox Client

VOIPBOX Client User Guide

Appendix B: ViBE Configuration Options I 63

Option Name Valid in Default Setting Description

meaning that if the CPE is rebooted

the ViBE link will never re-establish.

An (almost) equivalent would be to

set keepalive_ms to 10000 and

dead_ms to 60000, meaning that

such CPE would be provisioned

within a minute, but that keep-

alives are only sent every 10

seconds.

ping_stat_update R 20 Default number of seconds

between creating updates to the

extended remote stats, i.e. RTT and

Jitter

pkt_oh = G/R 10 Standard overheads per IP packet

at the layer 2 level. 10 allows for the

AAL5 trailer (8 bytes) and PPP. For

Ethernet, cell size would be 0 and

pkt_oh would be 14 (The Ethernet

header length)

provision = G/R no Specifies whether to send

provisioning information to this

remote. This would normally be for

platforms which do not have their

own configuration interface and

are centrally provisioned (such as

the Netgear DG834GT.) Can be

yes/no/1/0.

provision_server =

<address>

R N/A Used to specify the address of a

provisioning server when the CPE

device does not have a fixed IP

address

provision_password =

<password>

G/R N/A Provisioning password to be used

when the CPE device does not

have a fixed IP address. New

installations should use the newer

“password” command instead.

provision_source = G N/A Source address to use for

provisioning data to send to a

remote that is to be provisioned.

queue_percentages = R 5, 80, 15 Percentage of available data

bandwidth to allocate to each

traffic class.

remote <ip> {} G N/A Introduces a remote CPE device.

Options relating to this CPE are

enclosed in braces {}

remote <mac

address>{}

G N/A Introduces a remote CPE device

when the remote CPE does not

Page 66: UserGuide VOIPbox Client

VOIPBOX Client User Guide

64 I Appendix B: ViBE Configuration Options

Option Name Valid in Default Setting Description

have a fixed IP address. Used in

conjunction with a provisioning

server. Options relating to this CPE

are enclosed in braces {}

rain_mode = R no “Redundant Array of Inexpensive

Networks”

Options are

“no/off/yes/on/up/down/both”

Causes RTP payload packets to be

sent twice to try and avoid packet

loss. Reduces bandwidth by 50%

when used on a single link. With

multiple links (which will all be set

the same bandwidth and equal to

the bandwidth of the smallest

available link) the bandwidth is B x

(N-1) where N is the number of links

in use and B is the bandwidth of a

single link

require_remote_routes

=

G no If set, remotes that do not have a

route entry with a better prefix than

min_route_prefix will be considered

inaccessible. For use in resilient

installations where an external

router advertises routes based on

link state.

route_metric = G 10 Metric to apply to routes via the

ViBE interface

route_realm = G 100 Linux realm (route tag) to give to

routes via the ViBE interface.

secondary_address = G 0.0.0.0 This address (if specified) is used as

the source address for packets sent

to backup remotes.

send_sip_busy = G/R yes Whether or not to generate a

response code if a SIP INVITE is

blocked

sip_busy_message = G 486 (see text) Message to return to clients when a

SIP invite is blocked. Defaults to

“486 Link Congestion”

sip_port G 5060 UDP port used for SIP messages

source_address =

<address>

G/R N/A Used to designate an IP address to

use for a remote that is part of a

VLB set. Each individual VPN in a

VLB set must have a different

originating IP address, however

these addresses can all be

allocated to the same physical port

Page 67: UserGuide VOIPbox Client

VOIPBOX Client User Guide

Appendix B: ViBE Configuration Options I 65

Option Name Valid in Default Setting Description

through the use of IP aliases. The

use of aliases allows multiple

subnets to be used on the same

physical port so that multiple

gateways can be defined to

support a multiple link connection.

startup_ms R 5000 The time (in ms) which must pass

before this peer tunnel is

considered to be “down” from the

initial connection attempt. (i.e.

permissible startup delay.) It is used

as a delay to allow slow, e.g. ISDN

modem, links to come up.

Overrides dead_time during link

start up.

stat_pings = G/R 50 Default number of pings used to

determine remote RTT and Jitter

stats

symmetric = R no Causes ViBE to use the same

source and destination ports for

ViBE traffic. Can allow NAT routers

to allow incoming traffic without

specifying a port forward rule.

tap_address =

tap_mask =

G 10.255.255.254/

255.255.255.252

Address assigned to the ViBE

interface.

Note: If tap_address is specified

then tap_mask MUST also be

specified.

tap_gateway = G 10.255.255.253 Pseudo address for use as the

gateway address for routes via the

ViBE interface. This does NOT have

to be in the same network range as

tap_address.

tap_name = G “ViBE” Name of the ViBE interface.

test_count R 5 How many pings to send when

using ping test option

test_deadline R 1 Sets how long to wait (in seconds)

for test ping replies

test_mins R 0 Minutes between sending ping tests

over backup link path to check

connectivity when link is not in use.

A value of 0 (zero) turns off the

tests. A suffix of h, d, w, can also be

used. 1d = 1 day

test_rtp_src G/R yes Check to make sure that source

port for RTP streams is greater than

Page 68: UserGuide VOIPbox Client

VOIPBOX Client User Guide

66 I Appendix B: ViBE Configuration Options

Option Name Valid in Default Setting Description

1023. Used to prevent random rtp

detection, which could otherwise

be caused by DNS requests etc.

tos = G/R 0 TOS byte value of ViBE packets.

total_rate = R 277000 Raw ADSL rate in the direction TO

the remote ViBE box (bps).

Superseded by up_rate.

trunk_port = R 65500 UDP port to send ViBE traffic to.

up_rate = R 277 As total_rate but in kbps. Can be

over-ridden by data from a remote

CPE. (The override allows Modem

based CPE devices to send rate

information. )

use_def_prio G/R yes The scheme for placing packets

into the various queues involves the

use of the ToS byte in the IP header.

Essentially the value is divided by

(256/number of queues) and the

integer part of the result is used as

the queue number, with 0 being

the lowest priority. If use_def_prio is

set to “yes” (the default condition)

then, in addition, SIP packets are

put in the highest queue and

packets smaller than 200 bytes are

put in the next queue.

ViBE_source = G 0.0.0.0 G Packets sent from the local

machine to the ViBE interface will

be sourced from this address. (Will

be tap_address if not specified.)

ViBEup_cmd = G “” Command to run when the status

of a tunnel changes.

voice_precedence =

/voice_dscp =

G/R 0 RTP packets are not on fixed ports,

and since ViBE does not decode

call set-up packets it has no

guaranteed way of detecting

them. To resolve this ViBE takes an

heuristic approach to determining

which packets are in fact RTP. On a

network with a great deal of UDP

traffic on even ports, it is possible

that ViBE may incorrectly identify

some UDP streams as RTP. These

settings are used to indicate the

TOS/DSCP marking of RTP packets,

which will normally fix this problem.

Setting a voice_precedence value

Page 69: UserGuide VOIPbox Client

VOIPBOX Client User Guide

Appendix B: ViBE Configuration Options I 67

Option Name Valid in Default Setting Description

of 0 turns off this feature.

voice_quantum = G/R 20 Packet size (in mS) of the voice

traffic that is expected on the

network.

vpn_id = R/N None A string which identifies a private

group of networks/remotes. Any

network blocks which contain a

vpn_id will not be added to the

kernel routing table and hence will

not be visible outside of this ViBE

box, other than to remotes whose

definitions also include the same

vpn_id.

wait_lost_ms R 60 Time to wait before assuming that a

packet is lost when using bonded

links. Can be increased when there

are differences in latency between

links. Increasing the figure will

increase the overall latency of the

bonded link to accommodate the

slower link.

wakeup_ms R/G 5000 Time in mS between packets sent

to attempt to “wake up” a remote

peer once it has been deemed to

be dead.

watch_address = G 0.0.0.0 Used in an HA configuration in

conjunction with VRRP. If this

address is not present on the

machine, then ViBE is disabled until

it appears. Packets for primary

remote destinations (i.e. not

specified in a backup = clause) will

be sourced from this address.

Page 70: UserGuide VOIPbox Client

VOIPBOX Client User Guide

68 I Appendix B: ViBE Configuration Options

If supplied with SIP support, the following commands are available.

Option Name Valid in Default Description

sip_port = G/R 5060 UDP port to look for SIP packets

on.

rewrite_sip_codec = G/R none Rewrite SIP messages so that it

appears that the RTP CODEC is

gsm or speex ( values can be

“none”, “gsm” or “speex”.

rewrite_sip_ip = G/R None Modify SIP messages so that they

are directed at this address.

If supplied with compression support, the following commands are available.

Option Name Valid in Default Description

Compression = G/R none Compress G.711 RTP streams

using “gsm” or “speex”. (If

supplied with this option.)

decompress_payload

=

G/R no If G.711 has been compressed

(transcoded) by ViBE, should we

decompress it?

If supplied with GSM support, the following commands are available which affect how a

G.711 stream is converted to GSM.

Option Name Valid in Default Description

gsm_silence_detection

=

G/R yes If the G.711 packet is “silence”,

then just send a byte indicating

that this is the case.

gsm_silence_threshold

=

G/R 40 Amplitude below which a G.711

signal is considered “silent.”

gsm_comfort_noise = G/R 40 Amplitude of random noise

generated if silence is received.

(Sounds odd if not set to the

same as the silence threshold.)

Page 71: UserGuide VOIPbox Client

VOIPBOX Client User Guide

Appendix B: ViBE Configuration Options I 69

If supplied with Speex support, the following are available which affect how a G.711

stream is converted to Speex.

Option Name Valid in Default Description

speex_vbr = G/R yes Enable variable bit rate mode.

speex_complexity =

speex_quality =

speex_vad =

G/R 5

5

yes

Speex compression parameters.

speex_dtx = G/R Yes Turn on discontinuous

transmission. (Silence detection.)

speex_enh = G/R yes Turn on perception

enhancement on the decoder.

max_rate =

min_rate =

G/R 32000

8000

Max and min bit rates to use for

a single call.

Page 72: UserGuide VOIPbox Client

VOIPBOX Client User Guide

70 I Appendix C: Configuring Netgear DGN-2000

Appendix C: Configuring Netgear DGN-2000

The following instructions are only applicable if your service provider has given you a

ViBE enabled Netgear router.

1 Login into your router

2 From the main menu of the browser interface, under ‘Advanced’, click ViBE. The

VIBE Settings screen displays

4 Your service provider may supply an IP address and password for the provisioning

of the ViBE service. Only change these values if you are told to by your provider.

If you have been given Provisioning details, enter them in the relevant fields and

click APPLY.

5 You will need to reboot the router for the settings to take place.

Do not apply standard NetGear firmware to your ViBE enabled router.

Compatible firmware upgrades will be available from:

http://www.appliansys.com/netgear

Page 73: UserGuide VOIPbox Client

VOIPBOX Client User Guide

Notes I 71

Notes