IPVgate-20A, IPVgate-20B, IPVgate-20P

INSTALLATION AND
OPERATION MANUAL
IPVgate-20A,
IPVgate-20B,
IPVgate-20P
VoIP CPEs
Version 2.4
The Access Company
IPVgate-20A, IPVgate-20B,
IPVgate-20P
VoIP CPEs
Version 2.4
Installation and Operation Manual
Notice
This manual contains information that is proprietary to RAD Data Communications Ltd. ("RAD").
No part of this publication may be reproduced in any form whatsoever without prior written
approval by RAD Data Communications.
Right, title and interest, all information, copyrights, patents, know-how, trade secrets and other
intellectual property or other proprietary rights relating to this manual and to the IPVgate-20A,
IPVgate-20B, IPVgate-20P and any software components contained therein are proprietary
products of RAD protected under international copyright law and shall be and remain solely with
RAD.
IPVgate-20A, IPVgate-20B, IPVgate-20P is a registered trademark of RAD. No right, license, or
interest to such trademark is granted hereunder, and you agree that no such right, license, or
interest shall be asserted by you with respect to such trademark.
You shall not copy, reverse compile or reverse assemble all or any portion of the Manual or the
IPVgate-20A, IPVgate-20B, IPVgate-20P. You are prohibited from, and shall not, directly or
indirectly, develop, market, distribute, license, or sell any product that supports substantially
similar functionality as the IPVgate-20A, IPVgate-20B, IPVgate-20P, based on or derived in any
way from the IPVgate-20A, IPVgate-20B, IPVgate-20P. Your undertaking in this paragraph shall
survive the termination of this Agreement.
This Agreement is effective upon your opening of the IPVgate-20A, IPVgate-20B, IPVgate-20P
package and shall continue until terminated. RAD may terminate this Agreement upon the breach
by you of any term hereof. Upon such termination by RAD, you agree to return to RAD the
IPVgate-20A, IPVgate-20B, IPVgate-20P and all copies and portions thereof.
For further information contact RAD at the address below or contact your local distributor.
International Headquarters
RAD Data Communications Ltd.
North America Headquarters
RAD Data Communications Inc.
24 Raoul Wallenberg Street
Tel Aviv 69719, Israel
Tel: 972-3-6458181
Fax: 972-3-6498250, 6474436
E-mail: market@rad.com
900 Corporate Drive
Mahwah, NJ 07430, USA
Tel: (201) 5291100, Toll free: 1-800-4447234
Fax: (201) 5295777
E-mail: market@radusa.com
© 2007 RAD Data Communications Ltd.
Publication No. 803-200-12/07
Limited Warranty
RAD warrants to DISTRIBUTOR that the hardware in the IPVgate-20A, IPVgate-20B, IPVgate-20P
to be delivered hereunder shall be free of defects in material and workmanship under normal use
and service for a period of twelve (12) months following the date of shipment to DISTRIBUTOR.
If, during the warranty period, any component part of the equipment becomes defective by
reason of material or workmanship, and DISTRIBUTOR immediately notifies RAD of such defect,
RAD shall have the option to choose the appropriate corrective action: a) supply a replacement
part, or b) request return of equipment to its plant for repair, or c) perform necessary repair at
the equipment's location. In the event that RAD requests the return of equipment, each party
shall pay one-way shipping costs.
RAD shall be released from all obligations under its warranty in the event that the equipment has
been subjected to misuse, neglect, accident or improper installation, or if repairs or
modifications were made by persons other than RAD's own authorized service personnel, unless
such repairs by others were made with the written consent of RAD.
The above warranty is in lieu of all other warranties, expressed or implied. There are no
warranties which extend beyond the face hereof, including, but not limited to, warranties of
merchantability and fitness for a particular purpose, and in no event shall RAD be liable for
consequential damages.
RAD shall not be liable to any person for any special or indirect damages, including, but not
limited to, lost profits from any cause whatsoever arising from or in any way connected with the
manufacture, sale, handling, repair, maintenance or use of the IPVgate-20A, IPVgate-20B,
IPVgate-20P, and in no event shall RAD's liability exceed the purchase price of the IPVgate-20A,
IPVgate-20B, IPVgate-20P.
DISTRIBUTOR shall be responsible to its customers for any and all warranties which it makes
relating to IPVgate-20A, IPVgate-20B, IPVgate-20P and for ensuring that replacements and other
adjustments required in connection with the said warranties are satisfactory.
Software components in the IPVgate-20A, IPVgate-20B, IPVgate-20P are provided "as is" and
without warranty of any kind. RAD disclaims all warranties including the implied warranties of
merchantability and fitness for a particular purpose. RAD shall not be liable for any loss of use,
interruption of business or indirect, special, incidental or consequential damages of any kind. In
spite of the above RAD shall do its best to provide error-free software products and shall offer
free Software updates during the warranty period under this Agreement.
RAD's cumulative liability to you or any other party for any loss or damages resulting from any
claims, demands, or actions arising out of or relating to this Agreement and the IPVgate-20A,
IPVgate-20B, IPVgate-20P shall not exceed the sum paid to RAD for the purchase of the IPVgate20A, IPVgate-20B, IPVgate-20P. In no event shall RAD be liable for any indirect, incidental,
consequential, special, or exemplary damages or lost profits, even if RAD has been advised of
the possibility of such damages.
This Agreement shall be construed and governed in accordance with the laws of the State of Israel.
Product Disposal
To facilitate the reuse, recycling and other forms of recovery of waste
equipment in protecting the environment, the owner of this RAD product is
required to refrain from disposing of this product as unsorted municipal waste
at the end of its life cycle. Upon termination of the unit’s use, customers
should provide for its collection for reuse, recycling or other form of
environmentally conscientious disposal.
General Safety Instructions
The following instructions serve as a general guide for the safe installation and operation of
telecommunications products. Additional instructions, if applicable, are included inside the manual.
Safety Symbols
This symbol may appear on the equipment or in the text. It indicates potential
safety hazards regarding product operation or maintenance to operator or service
personnel.
Warning
Danger of electric shock! Avoid any contact with the marked surface while the
product is energized or connected to outdoor telecommunication lines.
Protective ground: the marked lug or terminal should be connected to the building
protective ground bus.
Warning
Some products may be equipped with a laser diode. In such cases, a label with the
laser class and other warnings as applicable will be attached near the optical
transmitter. The laser warning symbol may be also attached.
Please observe the following precautions:
•
Before turning on the equipment, make sure that the fiber optic cable is intact
and is connected to the transmitter.
•
Do not attempt to adjust the laser drive current.
•
Do not use broken or unterminated fiber-optic cables/connectors or look
straight at the laser beam.
•
The use of optical devices with the equipment will increase eye hazard.
•
Use of controls, adjustments or performing procedures other than those
specified herein, may result in hazardous radiation exposure.
ATTENTION: The laser beam may be invisible!
In some cases, the users may insert their own SFP laser transceivers into the product. Users are
alerted that RAD cannot be held responsible for any damage that may result if non-compliant
transceivers are used. In particular, users are warned to use only agency approved products that
comply with the local laser safety regulations for Class 1 laser products.
Always observe standard safety precautions during installation, operation and maintenance of
this product. Only qualified and authorized service personnel should carry out adjustment,
maintenance or repairs to this product. No installation, adjustment, maintenance or repairs
should be performed by either the operator or the user.
Handling Energized Products
General Safety Practices
Do not touch or tamper with the power supply when the power cord is connected. Line voltages
may be present inside certain products even when the power switch (if installed) is in the OFF
position or a fuse is blown. For DC-powered products, although the voltages levels are usually
not hazardous, energy hazards may still exist.
Before working on equipment connected to power lines or telecommunication lines, remove
jewelry or any other metallic object that may come into contact with energized parts.
Unless otherwise specified, all products are intended to be grounded during normal use.
Grounding is provided by connecting the mains plug to a wall socket with a protective ground
terminal. If a ground lug is provided on the product, it should be connected to the protective
ground at all times, by a wire with a diameter of 18 AWG or wider. Rack-mounted equipment
should be mounted only in grounded racks and cabinets.
Always make the ground connection first and disconnect it last. Do not connect
telecommunication cables to ungrounded equipment. Make sure that all other cables are
disconnected before disconnecting the ground.
Connecting AC Mains
Make sure that the electrical installation complies with local codes.
Always connect the AC plug to a wall socket with a protective ground.
The maximum permissible current capability of the branch distribution circuit that supplies power
to the product is 16A. The circuit breaker in the building installation should have high breaking
capacity and must operate at short-circuit current exceeding 35A.
Always connect the power cord first to the equipment and then to the wall socket. If a power
switch is provided in the equipment, set it to the OFF position. If the power cord cannot be
readily disconnected in case of emergency, make sure that a readily accessible circuit breaker or
emergency switch is installed in the building installation.
In cases when the power distribution system is IT type, the switch must disconnect both poles
simultaneously.
Connecting DC Power
Unless otherwise specified in the manual, the DC input to the equipment is floating in reference
to the ground. Any single pole can be externally grounded.
Due to the high current capability of DC power systems, care should be taken when connecting
the DC supply to avoid short-circuits and fire hazards.
DC units should be installed in a restricted access area, i.e. an area where access is authorized
only to qualified service and maintenance personnel.
Make sure that the DC power supply is electrically isolated from any AC source and that the
installation complies with the local codes.
The maximum permissible current capability of the branch distribution circuit that supplies power
to the product is 16A. The circuit breaker in the building installation should have high breaking
capacity and must operate at short-circuit current exceeding 35A.
Before connecting the DC supply wires, ensure that power is removed from the DC circuit. Locate
the circuit breaker of the panel board that services the equipment and switch it to the OFF
position. When connecting the DC supply wires, first connect the ground wire to the
corresponding terminal, then the positive pole and last the negative pole. Switch the circuit
breaker back to the ON position.
A readily accessible disconnect device that is suitably rated and approved should be incorporated
in the building installation.
If the DC power supply is floating, the switch must disconnect both poles simultaneously.
Connecting Data and Telecommunications Cables
Data and telecommunication interfaces are classified according to their safety status.
The following table lists the status of several standard interfaces. If the status of a given port
differs from the standard one, a notice will be given in the manual.
Ports
Safety Status
V.11, V.28, V.35, V.36, RS-530, X.21,
10 BaseT, 100 BaseT, Unbalanced E1,
E2, E3, STM, DS-2, DS-3, S-Interface
ISDN, Analog voice E&M
SELV
xDSL (without feeding voltage),
Balanced E1, T1, Sub E1/T1
TNV-1 Telecommunication Network Voltage-1:
Ports whose normal operating voltage is within the
limits of SELV, on which overvoltages from
telecommunications networks are possible.
FXS (Foreign Exchange Subscriber)
TNV-2 Telecommunication Network Voltage-2:
Ports whose normal operating voltage exceeds the
limits of SELV (usually up to 120 VDC or telephone
ringing voltages), on which overvoltages from
telecommunication networks are not possible. These
ports are not permitted to be directly connected to
external telephone and data lines.
FXO (Foreign Exchange Office), xDSL
(with feeding voltage), U-Interface
ISDN
TNV-3 Telecommunication Network Voltage-3:
Ports whose normal operating voltage exceeds the
limits of SELV (usually up to 120 VDC or telephone
ringing voltages), on which overvoltages from
telecommunication networks are possible.
Safety Extra Low Voltage:
Ports which do not present a safety hazard. Usually
up to 30 VAC or 60 VDC.
Always connect a given port to a port of the same safety status. If in doubt, seek the assistance
of a qualified safety engineer.
Always make sure that the equipment is grounded before connecting telecommunication cables.
Do not disconnect the ground connection before disconnecting all telecommunications cables.
Some SELV and non-SELV circuits use the same connectors. Use caution when connecting cables.
Extra caution should be exercised during thunderstorms.
When using shielded or coaxial cables, verify that there is a good ground connection at both
ends. The grounding and bonding of the ground connections should comply with the local codes.
The telecommunication wiring in the building may be damaged or present a fire hazard in case of
contact between exposed external wires and the AC power lines. In order to reduce the risk,
there are restrictions on the diameter of wires in the telecom cables, between the equipment
and the mating connectors.
Caution
To reduce the risk of fire, use only No. 26 AWG or larger telecommunication line cords.
Attention
Pour réduire les risques s’incendie, utiliser seulement des conducteurs de
télécommunications 26 AWG ou de section supérieure.
Some ports are suitable for connection to intra-building or non-exposed wiring or cabling only. In
such cases, a notice will be given in the installation instructions.
Do not attempt to tamper with any carrier-provided equipment or connection hardware.
Electromagnetic Compatibility (EMC)
The equipment is designed and approved to comply with the electromagnetic regulations of
major regulatory bodies. The following instructions may enhance the performance of the
equipment and will provide better protection against excessive emission and better immunity
against disturbances.
A good ground connection is essential. When installing the equipment in a rack, make sure to remove
all traces of paint from the mounting points. Use suitable lock-washers and torque. If an external
grounding lug is provided, connect it to the ground bus using braided wire as short as possible.
The equipment is designed to comply with EMC requirements when connecting it with unshielded
twisted pair (UTP) cables. However, the use of shielded wires is always recommended, especially
for high-rate data. In some cases, when unshielded wires are used, ferrite cores should be
installed on certain cables. In such cases, special instructions are provided in the manual.
Disconnect all wires which are not in permanent use, such as cables used for one-time configuration.
The compliance of the equipment with the regulations for conducted emission on the data lines
is dependent on the cable quality. The emission is tested for UTP with 80 dB longitudinal
conversion loss (LCL).
Unless otherwise specified or described in the manual, TNV-1 and TNV-3 ports provide secondary
protection against surges on the data lines. Primary protectors should be provided in the building
installation.
The equipment is designed to provide adequate protection against electro-static discharge (ESD).
However, it is good working practice to use caution when connecting cables terminated with
plastic connectors (without a grounded metal hood, such as flat cables) to sensitive data lines.
Before connecting such cables, discharge yourself by touching ground or wear an ESD preventive
wrist strap.
FCC-15 User Information
This equipment has been tested and found to comply with the limits of the Class A digital device,
pursuant to Part 15 of the FCC rules. These limits are designed to provide reasonable protection
against harmful interference when the equipment is operated in a commercial environment. This
equipment generates, uses and can radiate radio frequency energy and, if not installed and used in
accordance with the Installation and Operation manual, may cause harmful interference to the
radio communications. Operation of this equipment in a residential area is likely to cause harmful
interference in which case the user will be required to correct the interference at his own expense.
Canadian Emission Requirements
This Class A digital apparatus meets all the requirements of the Canadian Interference-Causing
Equipment Regulation.
Cet appareil numérique de la classe A respecte toutes les exigences du Règlement sur le matériel
brouilleur du Canada.
Warning per EN 55022 (CISPR-22)
Warning
Avertissement
Achtung
This is a class A product. In a domestic environment, this product may cause radio
interference, in which case the user will be required to take adequate measures.
Cet appareil est un appareil de Classe A. Dans un environnement résidentiel, cet
appareil peut provoquer des brouillages radioélectriques. Dans ces cas, il peut être
demandé à l’utilisateur de prendre les mesures appropriées.
Das vorliegende Gerät fällt unter die Funkstörgrenzwertklasse A. In Wohngebieten
können beim Betrieb dieses Gerätes Rundfunkströrungen auftreten, für deren
Behebung der Benutzer verantwortlich ist.
Installation Instructions for
Compliance with EMC Requirements
(IPVgate-20P/1E1 only)
To comply with electromagnetic compatibility requirements, a ferrite core (such as FAIR RITE
catalog number 2643625102 or equivalent) should be installed on any unshielded data cable
connected to an RJ-45 connector. This limits the electromagnetic energy emitted from the
cable. Alternatively, replace unshielded data cable with shielded data cable.
Note: If using a shielded data cable, the cable shield should be connected to the metallic hood.
To install the ferrite core:
•
Run the cable through the open core.
•
If cable thickness allows, wrap it around the core and run it through again.
Allow no more than 2 inches (5 cm) between the core and the cable connector to the unit.
•
Snap the core shut.
Maximum 2"
(50 mm)
Note: Two cables from the same module can be run through a single ferrite core.
Français
Mise au rebut du produit
Afin de faciliter la réutilisation, le recyclage ainsi que d'autres formes de
récupération d'équipement mis au rebut dans le cadre de la protection de
l'environnement, il est demandé au propriétaire de ce produit RAD de ne pas
mettre ce dernier au rebut en tant que déchet municipal non trié, une fois
que le produit est arrivé en fin de cycle de vie. Le client devrait proposer des
solutions de réutilisation, de recyclage ou toute autre forme de mise au rebut
de cette unité dans un esprit de protection de l'environnement, lorsqu'il aura
fini de l'utiliser.
Instructions générales de sécurité
Les instructions suivantes servent de guide général d'installation et d'opération sécurisées des
produits de télécommunications. Des instructions supplémentaires sont éventuellement
indiquées dans le manuel.
Symboles de sécurité
Ce symbole peut apparaitre sur l'équipement ou dans le texte. Il indique des risques
potentiels de sécurité pour l'opérateur ou le personnel de service, quant à
l'opération du produit ou à sa maintenance.
Avertissement
Danger de choc électrique ! Evitez tout contact avec la surface marquée tant que le
produit est sous tension ou connecté à des lignes externes de télécommunications.
Mise à la terre de protection : la cosse ou la borne marquée devrait être connectée
à la prise de terre de protection du bâtiment.
•
Avant la mise en marche de l'équipement, assurez-vous que le câble de fibre
optique est intact et qu'il est connecté au transmetteur.
•
Ne tentez pas d'ajuster le courant de la commande laser.
•
N'utilisez pas des câbles ou connecteurs de fibre optique cassés ou sans
terminaison et n'observez pas directement un rayon laser.
•
L'usage de périphériques optiques avec l'équipement augmentera le risque pour
les yeux.
•
L'usage de contrôles, ajustages ou procédures autres que celles spécifiées ici
pourrait résulter en une dangereuse exposition aux radiations.
ATTENTION : Le rayon laser peut être invisible !
Les utilisateurs pourront, dans certains cas, insérer leurs propres émetteurs-récepteurs Laser SFP
dans le produit. Les utilisateurs sont avertis que RAD ne pourra pas être tenue responsable de
tout dommage pouvant résulter de l'utilisation d'émetteurs-récepteurs non conformes. Plus
particulièrement, les utilisateurs sont avertis de n'utiliser que des produits approuvés par
l'agence et conformes à la réglementation locale de sécurité laser pour les produits laser de
classe 1.
Respectez toujours les précautions standards de sécurité durant l'installation, l'opération et la
maintenance de ce produit. Seul le personnel de service qualifié et autorisé devrait effectuer
l'ajustage, la maintenance ou les réparations de ce produit. Aucune opération d'installation,
d'ajustage, de maintenance ou de réparation ne devrait être effectuée par l'opérateur ou
l'utilisateur.
Manipuler des produits sous tension
Règles générales de sécurité
Ne pas toucher ou altérer l'alimentation en courant lorsque le câble d'alimentation est branché.
Des tensions de lignes peuvent être présentes dans certains produits, même lorsque le
commutateur (s'il est installé) est en position OFF ou si le fusible est rompu. Pour les produits
alimentés par CC, les niveaux de tension ne sont généralement pas dangereux mais des risques
de courant peuvent toujours exister.
Avant de travailler sur un équipement connecté aux lignes de tension ou de télécommunications,
retirez vos bijoux ou tout autre objet métallique pouvant venir en contact avec les pièces sous
tension.
Sauf s'il en est autrement indiqué, tous les produits sont destinés à être mis à la terre durant
l'usage normal. La mise à la terre est fournie par la connexion de la fiche principale à une prise
murale équipée d'une borne protectrice de mise à la terre. Si une cosse de mise à la terre est
fournie avec le produit, elle devrait être connectée à tout moment à une mise à la terre de
protection par un conducteur de diamètre 18 AWG ou plus. L'équipement monté en châssis ne
devrait être monté que sur des châssis et dans des armoires mises à la terre.
Branchez toujours la mise à la terre en premier et débranchez-la en dernier. Ne branchez pas des
câbles de télécommunications à un équipement qui n'est pas mis à la terre. Assurez-vous que
tous les autres câbles sont débranchés avant de déconnecter la mise à la terre.
Français
Certains produits peuvent être équipés d'une diode laser. Dans de tels cas, une
étiquette indiquant la classe laser ainsi que d'autres avertissements, le cas échéant,
sera jointe près du transmetteur optique. Le symbole d'avertissement laser peut
aussi être joint.
Avertissement
Veuillez observer les précautions suivantes :
Français
Connexion au courant du secteur
Assurez-vous que l'installation électrique est conforme à la réglementation locale.
Branchez toujours la fiche de secteur à une prise murale équipée d'une borne protectrice de mise
à la terre.
La capacité maximale permissible en courant du circuit de distribution de la connexion alimentant
le produit est de 16A. Le coupe-circuit dans l'installation du bâtiment devrait avoir une capacité
élevée de rupture et devrait fonctionner sur courant de court-circuit dépassant 35A.
Branchez toujours le câble d'alimentation en premier à l'équipement puis à la prise murale. Si un
commutateur est fourni avec l'équipement, fixez-le en position OFF. Si le câble d'alimentation ne
peut pas être facilement débranché en cas d'urgence, assurez-vous qu'un coupe-circuit ou un
disjoncteur d'urgence facilement accessible est installé dans l'installation du bâtiment.
Le disjoncteur devrait déconnecter simultanément les deux pôles si le système de distribution de
courant est de type IT.
Connexion d'alimentation CC
Sauf s'il en est autrement spécifié dans le manuel, l'entrée CC de l'équipement est flottante par
rapport à la mise à la terre. Tout pôle doit être mis à la terre en externe.
A cause de la capacité de courant des systèmes à alimentation CC, des précautions devraient
être prises lors de la connexion de l'alimentation CC pour éviter des courts-circuits et des risques
d'incendie.
Les unités CC devraient être installées dans une zone à accès restreint, une zone où l'accès n'est
autorisé qu'au personnel qualifié de service et de maintenance.
Assurez-vous que l'alimentation CC est isolée de toute source de courant CA (secteur) et que
l'installation est conforme à la réglementation locale.
La capacité maximale permissible en courant du circuit de distribution de la connexion alimentant
le produit est de 16A. Le coupe-circuit dans l'installation du bâtiment devrait avoir une capacité
élevée de rupture et devrait fonctionner sur courant de court-circuit dépassant 35A.
Avant la connexion des câbles d'alimentation en courant CC, assurez-vous que le circuit CC n'est
pas sous tension. Localisez le coupe-circuit dans le tableau desservant l'équipement et fixez-le
en position OFF. Lors de la connexion de câbles d'alimentation CC, connectez d'abord le
conducteur de mise à la terre à la borne correspondante, puis le pôle positif et en dernier, le
pôle négatif. Remettez le coupe-circuit en position ON.
Un disjoncteur facilement accessible, adapté et approuvé devrait être intégré à l'installation du
bâtiment.
Le disjoncteur devrait déconnecter simultanément les deux pôles si l'alimentation en courant CC
est flottante.
Quick Start Guide
Installation of IPVgate-20x should be carried out only by an experienced
technician. If you are familiar with IPVgate-20x, use this guide to prepare the
units for operation.
1.
Installing RVS Devices
To install the RVS IPVgate-20x devices, perform the following steps.
To install RVS devices:
1. Login to the IPVsuite.
2. Add a new subscriber in the Add New Subscriber page.
3. Fill all required information (marked with “*”).
4. Click <Configure Devices>.
5. Click <Add new device>.
6. On the Main page, fill in the following fields: Country code, Area code,
Number, Alias (optional), SIP User Name, and SIP Password.
7. Proceed to the Firmware page.
8. Select the Model Name, Software installed, and Hardware set according to
the actual device labels.
9. Click <Save only>.
10. Connect to the network and telephony equipment, as explained in Section 2.
11. Open the Quick Install page (192.168.0.1).
12. Configure the device with the customer’s telephone number and fill in the
following fields: Country Code, Area Code, Local Number, and Domain Name.
13. Configure the device in the Quick Installation page with the customer’s
network connection parameters.
14. Click <Update Changes> to update the device with the defined parameters
(use default password “321”).
15. Return to the IPVsuite.
16. Configure the device with additional services according to the customer’s
requests (for example, Additional numbers, VPN, Firewall, and so on).
17. Click <Update All>.
IPVgate-20x Ver. 2.4
Installing RVS Devices
1
Quick Start Guide
Installation and Operation Manual
2.
Connecting to the Ethernet and Telephony
Equipment
IPVgate-20A
To connect IPVgate-20A to the Ethernet and telephony equipment:
1. Connect the network cable (RJ-45) from the device LAN Eth connector to the
PC.
2. Connect the ADSL and Ethernet cables as follows:
•
In the ADSL model, connect the standard telephone cable (RJ-11) from
the ADSL device to the ADSL wall jack.
•
In the ETH model, connect the network cable (RJ-45) from the device
WAN Eth connector to the Modem or Router.
3. Connect the standard RJ-11 telephone cable from Trunk 1, Trunk 2, Trunk 3
or Trunk 4 to the PBX trunks or standard telephone devices.
4. Connect the +5 VDC Power Supply to the POWER connector.
IPVgate-20B
To connect IPVgate-20B to the Ethernet and telephony equipment:
1. Connect the network cable (RJ-45) from the device LAN Eth connector to the
PC.
2. Connect the cables as follows:
•
In the ADSL model, connect the standard telephone cable (RJ-11) from
the ADSL device to the ADSL wall jack.
•
In the ETH model, connect the network cable (RJ-45) from the device
WAN Eth connector to the Modem or Router.
3. Connect the ISDN cable (RJ-45) from BRI 1 and BRI 2 connectors to the PBX
trunks.
4. If the PBX requires BRI power from the device, connect the -48 VDC Power
Supply to ISDN Power connector.
5. If you will continue to use Telecom as a backup telephone line, connect it to
the LINE IN connector and connect the ISDN cable (RJ-45) from the LINE OUT
connector to the PBX trunk.
6. Connect the +5 VDC Power Supply to the POWER connector.
IPVgate-20P
To connect IPVgate-20P to the Ethernet and telephony equipment:
1. Connect the network cable (RJ-45) from the device LAN connector to the PC.
2
Connecting to the Ethernet and Telephony Equipment
IPVgate-20x Ver. 2.4
Installation and Operation Manual
Quick Start Guide
2. Connect the cables as follows:
If you are using the ADSL uplink, connect the standard telephone cable
(RJ-11) from the device ADSL connector to a DSLAM.
If you are using the network uplink, connect the network cable (RJ-45)
from the WAN connector to the DSLAM.
3. Connect the E1 cable (RJ-45) from the E1/T1 connector to the PBX PRI trunk.
4. Connect the AC power.
5. If you will continue to use Telecom as a backup telephone line, connect the
E1 cable to the PSTN connector.
3.
Connecting the Power Cables
Connecting the Power
IPVgate-20A, IPVgate-20B
To connect power to the IPVgate-20A and IPVgate-20B devices:
1. Connect the connector of the external power supply to the Power connector
on the IPVgate-20A or IPVgate-20B rear panel.
2. Connect the power supply 3-prong plug to a mains outlet.
The unit turns on automatically upon connection to the mains. The green
PWR indicator turns on, and the IPVgate-20A/B indicator blinks for
approximately 10 seconds during startup.
To connect ISDN power to the IPVgate-20B device:
1. Connect the ISDN power converter to the ISDN power connector on the
IPVgate-20B rear panel.
2. Connect the ISDN converter 3-prong plug to a mains outlet.
IPVgate-20P
To connect AC power to an IPVgate-20P:
1. Connect the power cable socket to the power connector on the IPVgate-20P
rear panel.
2. Connect the power cable plug to the mains outlet.
The unit turns on automatically upon connection to the mains.
To connect DC power to an IPVgate-20P:
•
IPVgate-20x Ver. 2.4
Refer to the DC power supply connection supplement on the Technical
Documentation CD.
Connecting the Power Cables
3
Quick Start Guide
4
Connecting the Power Cables
Installation and Operation Manual
IPVgate-20x Ver. 2.4
Contents
Introduction ............................................................................................................................ 1-1
1.1
1.2
1.3
System Overview........................................................................................................1-1
Applications............................................................................................................1-1
Features .................................................................................................................1-3
Physical Description ...................................................................................................1-4
Technical Specifications..............................................................................................1-5
IPVgate-20A............................................................................................................1-6
IPVgate-20B............................................................................................................1-8
IPVgate-20P..........................................................................................................1-10
Installation .............................................................................................................................. 2-1
2.1
2.2
2.3
2.4
2.5
2.6
2.7
Site Requirements and Prerequisites ..........................................................................2-1
Package Contents ......................................................................................................2-1
IPVgate-20A............................................................................................................2-1
IPVgate-20B............................................................................................................2-2
IPVgate-20P............................................................................................................2-2
Equipment Needed.....................................................................................................2-2
Mounting the Unit......................................................................................................2-2
Installing RVS Devices.................................................................................................2-3
Connecting to the Ethernet and Telephony Equipment................................................2-4
IPVgate-20A............................................................................................................2-4
IPVgate-20B............................................................................................................2-4
IPVgate-20P............................................................................................................2-5
Connecting the Power Cables .....................................................................................2-6
Connecting the Power.............................................................................................2-6
Connecting the ISDN Power to IPVgate-20B.............................................................2-7
Using the Command Line Interface ........................................................................................... 3-1
3.1
3.2
3.3
Command Line Processing ..........................................................................................3-1
Using the Command Line Editing Features ...............................................................3-2
Using Command Completion....................................................................................3-2
Accessing Command Help........................................................................................3-2
Command Modes ....................................................................................................3-2
Accessing the Unit .....................................................................................................3-3
Telnet.....................................................................................................................3-3
Serial Console .........................................................................................................3-3
Unit Command Line Interface (CLI) .............................................................................3-4
Telnet Manager Commands .....................................................................................3-4
IP and Basic Configuration.....................................................................................3-10
Dhcp ....................................................................................................................3-12
QoS ......................................................................................................................3-38
Billing Server.........................................................................................................3-40
File System ...........................................................................................................3-46
DNS Server ...........................................................................................................3-50
DDNS Registration ................................................................................................3-54
NAT Configuration ................................................................................................3-58
Port Services.........................................................................................................3-60
Telephony Gain.....................................................................................................3-62
IPVgate - 20xx Ver. 2.4
i
Table of Contents
3.4
Installation and Operation Manual
Voice Over IP ........................................................................................................3-68
SIP Commands ......................................................................................................3-70
Phone Interface ....................................................................................................3-78
Phone Number configuration ................................................................................3-90
IP Filter Settings....................................................................................................3-91
DMZ Settings ........................................................................................................3-95
VPN Settings.........................................................................................................3-97
Time ...................................................................................................................3-111
Version Commands .............................................................................................3-111
ATM Settings ......................................................................................................3-112
ADSL Settings .....................................................................................................3-116
ISDN Configuration Commands............................................................................3-119
Ping....................................................................................................................3-132
Quit....................................................................................................................3-132
Factory Default Settings .....................................................................................3-133
Restart ...............................................................................................................3-133
Boot Commands ....................................................................................................3-134
p ........................................................................................................................3-134
c.........................................................................................................................3-135
ap ......................................................................................................................3-135
ac.......................................................................................................................3-135
b<x>...................................................................................................................3-136
r .........................................................................................................................3-136
Appendix A VPN Configuration Examples
Appendix B Typical ADSL Connection Configurations
ii
IPVgate - 20xx Ver. 2.4
Chapter 1
Introduction
This chapter provides an overview for installing and operating the RAD VoIP
System (RVS) devices, including IPVgate-20A, IPVgate-20B and IPVgate-20P
devices.
1.1
System Overview
The RVS (RAD VoIP System) includes IPVgate™ patent-pending all-in-one
gateways, routers, ADSL access points, such as the following VoIP CPE devices,
which integrate analog/digital telephony, fax and data over broadband Internet,
with standard SIP support:
•
IPVgate-20A: analog VoIP CPE (Customer Premises Equipment)
•
IPVgate-20B: digital BRI VoIP CPE
•
IPVgate-20P: PRI VoIP CPE.
Applications
This section discusses typical applications relevant for IPVgate-20A/B and
IPVgate-20P.
IPVgate-20A/B
IPVgate-20A/B provide cost-effective, standalone analog (IPVgate-20A) or digital
(IPVgate-20B) VoIP gateway, fully interoperable with leading soft switches and SIP
servers to handle all office or home connectivity needs.
IPVgate - 20x Ver. 2.4
System Overview
1-1
Chapter 1 Introduction
Installation and Operation Manual
Figure 1-1 illustrates a typical application of the IPVgate-20A unit.
Figure 1-1. IPVgate-20A VoIP-based PSTN Access for SME and/or SOHO
Customers
Figure 1-2 illustrates a typical application of the IPVgate-20B unit.
Figure 1-2. IPVgate-20B VoIP-based PSTN Access for SME and/or SOHO Customers
IPVgate-20P
IPVgate-20P integrates digital enterprise class telephony, fax, and data over
broadband Internet, with standard SIP support.
1-2
System Overview
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 1 Introduction
Figure 1-3 illustrates a typical application of the IPVgate-20P unit.
Figure 1-3. IPVgate-20P VoIP-based PSTN Access for SME and/or SOHO Customers
Features
This section discusses the main features of IPVgate-20A/B and IPVgate-20P.
IPVgate-20A/B
The main features of IPVgate-20A/B devices are:
IPVgate - 20x Ver. 2.4
•
IPVgate-20A only: Connects 2 or 4 FXS ports over any broadband Internet
connection, using SIP.
•
IPVgate-20B only: Connects 4/8 ISDN lines (2/4 BRI) over any broadband
Internet connection, using SIP. Generates Q.931 signaling and provides
supplementary services such as Time, DDI (Direct Dialing Inward), MSN
(Multiple Subscriber Numbering), CLIR (Caller-ID Restriction), CLIP (CallerID Presentation) and AOC (Advice of Charge). AOC variations, such as AOC
metering, AOC currency, AOC at start of call, AOC during call, and AOC at
end of call are also supplied. An additional dual-purpose Sync/Backup BRI
interface allows cascading of units and clock synchronization, essential
for qualitative PBX operation. Utilizing its backup line (connected to Telco
lines) the unit can switch all phone calls to regular telephony upon
broadband connectivity failure.
•
Employ G.729A or G.723.1 voice compression algorithms.
•
Dynamic bandwidth allocation using voice activity detection and silence
suppression.
•
Multi-layered Quality-of-Service (QoS) to ensure business quality
telephone calls.
•
Built-in VPN (IPSec) server to create enterprise virtual networks.
System Overview
1-3
Chapter 1 Introduction
Installation and Operation Manual
•
Fully interoperable with leading vendors’ SIP-based equipment. Fax
machines connected to IPVgate-20A/B benefit from high quality T.38
support which assures effective and reliable fax transmissions. Performs
SIP fail backup by DNS number resolving. When a central SIP server fails to
respond, IPVgate-20A/B accesses the operator or enterprise DNS server
to resolve the IP address of the VoIP trunking gateway or of another endpoint device. IPVgate-20A/B are also available with an ADSL modem, to
provide ADSL line monitoring and re-routing all traffic information to a
backup router (e.g., ISDN router) upon connectivity failure.
•
IPVgate-20A/B generates call quality information to the RADview
management unit to track and analyze QoS of the service.
IPVgate-20P
In addition to the common features shared with IPVgate-20A/B, IPVgate-20P
supports the following features:
•
Connects 30 lines (1 PRI) over any broadband Internet connection, using
SIP. Generates Q.931 signaling and provides supplementary services such
as Time, DDI (Direct Dialing Inward), MSN (Multiple Subscriber
Numbering), CLIR (Caller-ID Restriction), CLIP (Caller-ID Presentation) and
AOC (Advice of Charge). AOC variations, such as AOC metering, AOC
currency, AOC at start of call, AOC during call, and AOC at end of call are
also supplied. An additional dual-purpose Sync/Backup PRI interface
allows cascading of units and clock synchronization, essential for
qualitative PBX operation. Utilizing its backup line (connected to Telco
lines) the unit can switch all phone calls to regular telephony upon
broadband connectivity failure.
•
Operates as VoIP Access gateway or Trunking VoIP Gateway.
•
Multi-layered Quality-of-Service (QoS) to ensure business quality
telephone calls.
•
Built-in VPN (IPSec) server to create enterprise virtual networks.
•
Fully interoperable with leading vendors’ SIP-based equipment.
•
As a scalable, carrier-grade unit, IPVgate-20P offers unprecedented voice
quality and user-friendly configuration interface.
1.2
Physical Description
The IPVgate-20A and IPVgate-20B analog VoIP CPE devices can be ordered with 2
or 4 FXS ports (that is, two or four voice ports) and with ADSL or WAN uplink
interfaces. They come with an external wall mounted +5 VDC power supply.
The IPVgate-20P hardware comes with two uplink interfaces (ADSL and Ethernet)
and can be configured to use either one.
The IPVgate-20x panels contain LED indicators as illustrated in Figure 1-4 to
Figure 1-6.
1-4
Physical Description
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 1 Introduction
Figure 1-4. IPVgate-20A
Figure 1-5. IPVgate-20B
Figure 1-6. IPVgate-20P
1.3
Technical Specifications
This section lists the technical specifications of IPVgate-20A, IPVgate-20B and
IPVgate-20P.
IPVgate - 20x Ver. 2.4
Technical Specifications
1-5
Chapter 1 Introduction
Installation and Operation Manual
IPVgate-20A
Network
Interface
WAN
• Ethernet 10/100BaseT
• ADSL
LAN
• Ethernet 10/100BaseT
Connectors
• Ethernet: RJ-45
• ADSL: RJ-11
Data Transfer
Protocols
• IPv4
• Router with NAT/NAPT
• RIP II
• DHCP client/Server
• SNTP
• DMZ
• PPPoE/PPTP
• PPPoA, IPoATM (ADSL version)
Security
Telephony
SSLv3/TLSv1
Encrypted Phone/Fax P2P VoIP calls
VPN
IPSec server/client with Tunnel IP-filtering
Firewall
Stateless, port level IP-filtering
Number of Lines
2 or 4 Analog FXS
Connectors
RJ-11
Features
• Call waiting
• Call progress tones per country
• DTMF detection
Ring Voltage
90 VDC
Caller ID
• Type II
• CLIR
• CLIP
Pulse Metering
1-6
Technical Specifications
12/16 kHz
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Basic PBX
Functionalities
Chapter 1 Introduction
• Extension-to-extension call
• Extension-to-VoIP call
• Call hold
• Call transfer
• Music on hold
• Line grouping
Voice over IP
SIPv2 based
• UDP/RTP packets
• Silence Suppression
• Echo Cancellation
• VAD
• CNG
• Dynamic Jitter Buffer
• Modem pass-through
Fax
• T.38 compliant Group 3 fax relay
• Fax bypass
Compression
• G.711
• G.723.1
• G.729A
QoS
• Diffserv
• Upstream priority
Management
• Quick-install web page
• Remote ADSL line quality monitoring
• RS-232 port for basic configuration
• Telnet
• FTP server
• Remote update/upgrade
Indicators
Ethernet Ports
(LAN and WAN)
ACT (green), blinks according to the Ethernet traffic
Power
PWR (green), ON – Power supply is on
System
SYS (red) – The device is resetting or the telephony is
unavailable
LINK (green), ON – Good link integrity
SYS (green) – blinks at startup, ON while operating
Power
IPVgate - 20x Ver. 2.4
5 VDC 2A
Technical Specifications
1-7
Chapter 1 Introduction
Physical
Environment
Installation and Operation Manual
Height
4.85 cm (1.9 in)
Width
21.8 cm (8.6 in)
Depth
19.1 cm (7.5 in)
Weight
0.875 kg (1.9 lb)
Operating
Temperature
5° to 40°C (41° to 104°F)
Storage
Temperature
-25° to 70°C (-77° to 158°F)
Humidity
Up to 90%, non-condensing
WAN
• Ethernet 10/100BaseT
IPVgate-20B
Network
Interface
• ADSL
LAN
• Ethernet 10/100BaseT
Connectors
• Ethernet: RJ-45
• ADSL: RJ-11
Data Transfer
Protocols
• IPv4
• Router with NAT/NAPT
• RIP II
• DHCP client/Server
• SNTP
• DMZ
• PPPoE/PPTP
• PPPoA, IPoATM (ADSL version)
Security
1-8
Encrypted Phone/Fax P2P VoIP calls
VPN
IPSec server/client with Tunnel IP-filtering
Firewall
Stateless, port level IP-filtering
Technical Specifications
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Telephony
Number of Lines
Chapter 1 Introduction
• 2 or 4 digital lines (1/2 BRI) each terminated in RJ-45
connector
• BRI backup line (to Telco)
• BRI synchronization line for cascading
Features
• Call progress tones per country
(dial-tone, busy-tone, ringing tone)
• ISDN supplementary service
• DDI (dial into/from extension) support
• Digit stripping
• MSN (Multiple Subscriber Numbering)
• Advice of Charge (AOC):
AOC-S, AOC-D, AOC-E
Voice over IP
Ring Voltage
48 VDC supply voltage to ISDN phones
Caller ID, Time &
AOC display
• CLIR
SIPv2 based
• UDP/RTP packets
• CLIP
• Silence Suppression
• Echo Cancellation
• VAD
• CNG
• Dynamic Jitter Buffer
Fax
• T.38 compliant Group 3 fax relay and modem passthrough
• Fax bypass
Compression
• G.711
• G.723.1
• G.729A
Management
• Quick-install web page
• Remote ADSL line quality monitoring
• RS-232 port for basic configuration
• Telnet
• FTP server
• Remote update/upgrade
IPVgate - 20x Ver. 2.4
Technical Specifications
1-9
Chapter 1 Introduction
Indicators
Installation and Operation Manual
Ethernet Ports
(LAN and WAN)
ACT (green), blinks according to the Ethernet traffic
LINK (green), ON – Good link integrity
Power
PWR (green), ON – Power supply is on
System
SYS (red) – The device is resetting or the telephony is
unavailable
SYS (green) – blinks at startup, ON while operating
Power
5 VDC 1A
Physical
Environment
Height
4.85 cm (1.9 in)
Width
21.8 cm (8.6 in)
Depth
19.1 cm (7.5 in)
Weight
0.875 kg (1.9 lb)
Operating
Temperature
5° to 40°C (41° to 104°F)
Storage
Temperature
-25° to 70°C (-77° to 158°F)
Humidity
Up to 90%, non-condensing
WAN
• Ethernet 10/100BaseT
IPVgate-20P
Network
Interface
• ADSL
LAN
• Ethernet 10/100BaseT
Connectors
• Ethernet: RJ-45
• ADSL: RJ-11
Data Transfer
Protocols
• IPv4
• Router with NAT/NAPT
• RIP II
• DHCP client/Server
• SNTP
• DMZ
• PPPoE/PPTP
• PPPoA, IPoATM (ADSL version)
1-10
Technical Specifications
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
PRI Protocols
Chapter 1 Introduction
• Layer 1: I.430
• Layer 2: Q.921, LAP-D (I.441)
• Layer 3: Q.931 (I.451)
• QSIC
Country Variance
• National: ISDN-2
• Euro ISDN: ETSI NET 3, NET 5
• France: VN2, VN3
• Germany: 1TR6
• Austria: TSO13.1
Security
Telephony
Encrypted Phone/Fax P2P VoIP calls
VPN
IPSec server/client with Tunnel IP-filtering SSLv3/TLSv1
Firewall
Stateless, port level IP-filtering
Number of Lines
• 30 digital lines (1 PRI) terminated in RJ-45 connector
• PRI backup line (to Telco)
• PRI synchronization line for cascading
Features
• Call progress tones per country
(dial-tone, busy-tone, ringing tone)
• ISDN supplementary service
• DDI (dial into/from extension) support
• Digit stripping
• MSN (Multiple Subscriber Numbering)
• Advice of Charge (AOC): AOC-S, AOC-D, AOC-E
Voice over IP
Ring Voltage
48 VDC supply voltage to ISDN phones
Caller ID, Time &
AOC display
• CLIR
SIPv2 based
• UDP/RTP packets
• CLIP
• Silence Suppression
• Echo Cancellation
• VAD
• CNG
• Dynamic Jitter Buffer
IPVgate - 20x Ver. 2.4
Technical Specifications
1-11
Chapter 1 Introduction
Installation and Operation Manual
Fax
• T.38 compliant Group 3 fax relay and modem
pass-through
• Fax bypass
Compression
• G.711
• G.723.1
• G.729A
QoS
• Diffserv
• Upstream priority
Management
• Quick-install web page
• Remote ADSL line quality monitoring
• RS-232 port for basic configuration
• Telnet
• FTP server
• Remote update/upgrade
Indicators
Ethernet Ports
(LAN and WAN)
ACT (yellow), blinks according to the Ethernet traffic
ADSL
ACT (green), blinks according to the ADSL traffic
LINK (green), ON – Good link integrity
LINK (green), ON – Good link integrity
Power
PWR (green), ON – Power supply is on
System
SYS (green) – blinks at startup, ON while operating
Power
AC/DC Voltage
Wide range power supply:
100-240 VAC, 0.3A, 50/60 Hz or 48 VDC, 0.5A
Physical
Height
4.37 cm (1.7 in)
Width
44 cm (17.3 in)
Depth
24 cm (9.4 in)
Weight
3 kg (6.6 lb)
Operating
Temperature
5° to 40°C (41° to 104°F)
Storage
Temperature
-25° to 70°C (-77° to 158°F)
Humidity
Up to 90%, non-condensing
Environment
1-12
Technical Specifications
IPVgate - 20x Ver. 2.4
Chapter 2
Installation
This chapter identifies the steps required to setup and enable the RAD VoIP
System (RVS) devices, including IPVgate-20x (A, B, P) devices.
Internal settings, adjustment, maintenance, and repairs may be performed only
by a skilled technician who is aware of the hazards involved.
Warning
Always observe standard safety precautions during installation, operation, and
maintenance of this product.
2.1
Site Requirements and Prerequisites
AC-powered IPVgate-20P units should be installed within 1.5m (5 ft) of an
easily-accessible grounded AC outlet capable of furnishing the voltage in
accordance with IPVgate-20P nominal supply voltage.
DC-powered IPVgate-20P units require a -48 VDC power source, which must be
adequately isolated from the main supply.
Allow at least 90 cm (36 in) of frontal clearance for operating and maintenance
accessibility. Allow at least 10 cm (4 in) clearance at the rear of the unit for signal
lines and interface cables.
The ambient operating temperature of IPVgate-20x devices is 0° to 50° C (32° to
122°F), at a relative humidity of up to 90%, non-condensing.
2.2
Package Contents
IPVgate-20A
The IPVgate-20A package includes the following items:
•
One IPVgate-20A unit
•
Technical documentation CD
•
External wall mounted +5 VDC power supply
•
Analog RJ-11 telephony cable
IPVgate-20x Ver. 2.4
Package Contents
2-1
Chapter 2 Installation
Installation and Operation Manual
IPVgate-20B
The IPVgate-20B package includes the following items:
•
One IPVgate-20B unit
•
Technical documentation CD
•
External wall mounted +5 VDC power supply
•
ISDN RJ-45 regular cable
•
Additional wall-mounted 48 VDC power supply for ISDN phones support (if
ordered)
IPVgate-20P
The IPVgate-20P package includes the following items:
•
One IPVgate-20P unit
•
Technical documentation CD
•
Power cord (VAC) and AC/DC plug (-48 VDC)
•
E1 RJ-45 regular cable
•
E1 RJ-45 cross cable
2.3
Equipment Needed
IPVgate-20x devices need no special tools for installation. You need a screwdriver
to mount IPVgate-20P devices in a 19" rack.
The IPVgate-20P device comes equipped with an appropriate (country or region
dependent) power cord to be connected from the power socket on the rear panel
to the mains.
2.4
Mounting the Unit
IPVgate-20x devices are designed for installation as a desktop unit. IPVgate-20P
can also be mounted in a 19" rack or on a wall.
To install an IPVgate-20x device as a desktop unit:
•
2-2
Place and secure the unit on a stable, non-movable surface.
Mounting the Unit
IPVgate-20x Ver. 2.4
Installation and Operation Manual
Chapter 2 Installation
To install an IPVgate-20x device in a rack or on the wall:
•
For rack mounting instructions, refer to the RM-35 installation kit manual
•
For wall mounting instructions, refer to the WM-35 installation kit manual
For any installation, refer to the clearance and temperature requirements in
Section 2.1.
2.5
Installing RVS Devices
To install the RVS IPVgate-20x devices, perform the following steps.
To install RVS devices:
1. Login to the IPVsuite.
2. Add a new subscriber in the Add New Subscriber page.
3. Fill all required information (marked with “*”).
4. Click <Configure Devices>.
5. Click <Add new device>.
6. On the Main page, fill in the following fields: Country code, Area code,
Number, Alias (optional), SIP User Name, and SIP Password.
7. Proceed to the Firmware page.
8. Select the Model Name, Software installed, and Hardware set according to
the actual device labels.
9. Click <Save only>.
10. Connect to the network and telephony equipment, as explained in
Section 2-6.
11. Open the Quick Install page (192.168.0.1).
12. Configure the device with the customer’s telephone number and fill in the
following fields: Country Code, Area Code, Local Number, and Domain Name.
13. Configure the device in the Quick Installation page with the customer’s
network connection parameters.
14. Click <Update Changes> to update the device with the defined parameters
(use default password “321”).
15. Return to the IPVsuite.
16. Configure the device with additional services according to the customer’s
requests (for example, Additional numbers, VPN, Firewall, and so on).
17. Click <Update All>.
IPVgate-20x Ver. 2.4
Installing RVS Devices
2-3
Chapter 2 Installation
Installation and Operation Manual
2.6
Connecting to the Ethernet and Telephony
Equipment
IPVgate-20A
IPVgate-20A is available in ADSL and Ethernet models. Typical rear panels are
shown is Figure 2-1 and Figure 2-2, respectively.
To connect IPVgate-20A to the Ethernet and telephony equipment:
1. Connect the network cable (RJ-45) from the device LAN Eth connector to the
PC.
2. Connect the ADSL and Ethernet cables as follows:
•
In the ADSL model, connect the standard telephone cable (RJ-11) from
the ADSL device to the ADSL wall jack.
•
In the ETH model, connect the network cable (RJ-45) from the device
WAN Eth connector to the Modem or Router.
3. Connect the standard RJ-11 telephone cable from Trunk 1, Trunk 2, Trunk 3
or Trunk 4 to the PBX trunks or standard telephone devices.
4. Connect the +5 VDC Power Supply to the POWER connector.
Figure 2-1. IPVgate-20A ADSL
Figure 2-2. IPVgate-20A ETH
IPVgate-20B
IPVgate-20A is available in ADSL and Ethernet models. Typical rear panels are
shown is Figure 2-3 and Figure 2-4, respectively.
To connect IPVgate-20B to the Ethernet and telephony equipment:
1. Connect the network cable (RJ-45) from the device LAN Eth connector to the
PC.
2. Connect the cables as follows:
2-4
•
In the ADSL model, connect the standard telephone cable (RJ-11) from
the ADSL device to the ADSL wall jack.
•
In the ETH model, connect the network cable (RJ-45) from the device
WAN Eth connector to the Modem or Router.
Connecting to the Ethernet and Telephony Equipment
IPVgate-20x Ver. 2.4
Installation and Operation Manual
Chapter 2 Installation
3. Connect the ISDN cable (RJ-45) from BRI 1 and BRI 2 connectors to the PBX
trunks.
4. If the PBX requires BRI power from the device, connect the -48 VDC Power
Supply to ISDN Power connector.
5. If you will continue to use Telecom as a backup telephone line, connect it to
the LINE IN connector and connect the ISDN cable (RJ-45) from the LINE OUT
connector to the PBX trunk.
6. Connect the +5 VDC Power Supply to the POWER connector.
Figure 2-3. IPVgate-20B ADSL
Figure 2-4. IPVgate-20B ETH
IPVgate-20P
To connect IPVgate-20P to the Ethernet and telephony equipment:
1. Connect the network cable (RJ-45) from the device LAN connector to the PC.
2. Connect the cables as follows:
If you are using the ADSL uplink, connect the standard telephone cable
(RJ-11) from the device ADSL connector to a DSLAM.
If you are using the network uplink, connect the network cable (RJ-45)
from the WAN connector to the DSLAM.
3. Connect the E1 cable (RJ-45) from the E1/T1 connector to the PBX PRI trunk.
4. Connect the AC power.
5. If you will continue to use Telecom as a backup telephone line, connect the
E1 cable to the PSTN connector.
PST N
IPVgate-20P
100 240VAC
ADSL
PWR
SYS
LINK
DCE
LAN
48 / 60VDC
WAN
ACT
E1/T 1
RETURN
POW ER
Figure 2-5. IPVgate-20P
IPVgate-20x Ver. 2.4
Connecting to the Ethernet and Telephony Equipment
2-5
Chapter 2 Installation
Installation and Operation Manual
2.7
Connecting the Power Cables
Connecting the Power
IPVgate-20A, IPVgate-20B
Power is supplied to the IPVgate-20A and IPVgate-20B devices via an external
power supply, which receives power from a 100–240 VAC source and converts it to
+5 VDC. The external power supply unit is provided with the IPVgate-20A/B units.
To connect power to the IPVgate-20A and IPVgate-20B devices:
1. Connect the connector of the external power supply to the Power connector
on the IPVgate-20A or IPVgate-20B rear panel.
2. Connect the power supply 3-prong plug to a mains outlet.
The unit turns on automatically upon connection to the mains. The green
PWR indicator turns on, and the IPVgate-20A/B indicator blinks for
approximately 10 seconds during startup.
IPVgate-20P
IPVgate-20P is equipped with a dual input AC/DC power supply. AC or DC power is
supplied to IPVgate-20P via a standard 3-prong power input connector on the
rear panel.
AC power is supplied to the IPVgate-20P through a standard 3-prong plug.
AC power should be supplied via a 1.5m (5 ft) standard power cable terminated
by a standard 3-prong socket. The cable is provided with the unit.
DC power is supplied to IPVgate-20P via a compatible AC/DC plug for attaching DC
power supply lines.
To connect AC power to an IPVgate-20P:
1. Connect the power cable socket to the power connector on the IPVgate-20P
rear panel.
2. Connect the power cable plug to the mains outlet.
The unit turns on automatically upon connection to the mains.
To connect DC power to an IPVgate-20P:
•
2-6
Refer to the DC power supply connection supplement on the Technical
Documentation CD.
Connecting the Power Cables
IPVgate-20x Ver. 2.4
Installation and Operation Manual
Warning
Chapter 2 Installation
Before switching on this unit and connecting or disconnecting any other cable,
the protective earth terminals of this unit must be connected to the protective
ground conductor of the mains power cord. If you are using an extension cord
(power cable) make sure it is grounded as well.
Any interruption of the protective (grounding) conductor (inside or outside the
instrument) or disconnecting of the protective earth terminal can make this unit
dangerous. Intentional interruption is prohibited.
The line fuse is located in an integral-type fuse holder located on the rear panel.
Make sure that only fuses of the required rating, as marked on the rear panel,
are used for replacement. Do not use repaired fuses or short-circuit the fuse
holder. Always disconnect the mains cable before removing or replacing the fuse.
Whenever it is likely that the fuse protection has been damaged, make the unit
inoperative and secure it against unintended operation.
Connecting the ISDN Power to IPVgate-20B
The ISDN power connector is needed when the BRI is connected to an ISDN
device with no external power supply of its own. In this case the IPVgate-20B can
supply the power to that device.
To connect ISDN power to the IPVgate-20B device:
1. Connect the ISDN power converter to the ISDN power connector on the
IPVgate-20B rear panel.
2. Connect the ISDN converter 3-prong plug to a mains outlet.
IPVgate-20x Ver. 2.4
Connecting the Power Cables
2-7
Chapter 2 Installation
2-8
Connecting the Power Cables
Installation and Operation Manual
IPVgate-20x Ver. 2.4
Chapter 3
Using the Command Line
Interface
This chapter provides information for creating a terminal connection to the unit,
and a complete reference to the unit Command Line Interface (CLI).
This chapter assumes that you are a network administrator or technician, and
that you have prior knowledge of the following topics:
•
Networking concepts and terminology
•
Network topologies
•
Distributed networks and IP routing.
The chapter also assumes that you are familiar with the unit capabilities.
This document uses the following syntax conventions:
Table 3-1. Syntax Conventions
Convention
Description
boldface font
Commands are in boldface font.
<>
Arguments for which you supply values are in angle
brackets. When the text refers to an argument it is
written in italics.
[]
Arguments for which you optionally supply values are in
square brackets.
<x|y|z>
Alternative keywords are grouped in angle brackets and
separated by vertical bars. When the text refers to a
keyword it is written in bold.
[x|y|z]
Optional alternative keywords are grouped in square
brackets and separated by vertical bars.
screen font
3.1
Terminal sessions and information the system displays are
in screen font.
Command Line Processing
This section discusses the functionalities of the command line processing.
IPVgate - 20x Ver. 2.4
Command Line Processing
3-1
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Using the Command Line Editing Features
The unit software includes an enhanced editing mode that provides a rich set of
editing functions:
Note
•
Unit commands are not case sensitive. You can enter commands in
lowercase. Only passwords are case sensitive.
•
You can scroll through the last 20 commands stored in the history buffer with
the arrow keys, and enter or edit the command at the prompt.
The arrow keys only function on ANSI-compatible terminals such as VT100s.
Using Command Completion
Use the command completion function to complete a command or keyword. If
you cannot remember a complete command name, enter the first few letters and
press the Tab key. The system will complete the partial entry if the first few
letters cannot indicate more than one command.
For example, if you enter bil at the command prompt and press <Tab>, the
system completes the command as billsrv because it is the only command that
matches the criteria. The cursor appears immediately after the completed
command, allowing you to enter additional information.
If you enter a set of characters that could indicate more than one command, no
action is carried out and the system returns to the prompt and the last command.
Accessing Command Help
Use a question mark (?) to access the system help as follows:
Location of question
mark
Result
At the command prompt
A listing of all the root commands and categories.
After entering a command
category
A listing of its commands and subcategories.
After entering a command
The system displays usage information.
Command Modes
The unit recognizes two distinct command modes:
•
Privileged mode gives access to all the commands available.
•
User mode gives access to a much smaller subset of the commands, with no
access to critical system settings. The User Mode is typically used to view the
system settings, set a local e-mail account and configure DNS server settings.
The unit has a different password for each mode. Access is determined on this
basis when connecting to the unit.
3-2
Command Line Processing
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
3.2
Chapter 3 Using the Command Line Interface
Accessing the Unit
There are two distinct methods to create a terminal connection to the unit:
•
Telnet
•
Serial Console.
Telnet
You can open a terminal commander session on the unit from a remote PC via a
telnet client application. You can open a connection to the unit and send commands
using the telnet console. You can open multiple sessions to the unit via Telnet.
To access the unit from a remote PC via telnet:
1. Select Start > Run to open the Run Program dialog box.
2. Enter the telnet command and the name (for example, telnet
972499999.isp.com) or IP address of the unit you want to access (for
example: telnet 34.54.63.102).
3. Press <Enter> or click the <OK> button.
The telnet session opens and the following message appears:
IPCenterII Copyright(c) 2000-2005 RAD Systems Ltd.
Password:
4. Enter the password for the unit and press <Enter>.
Serial Console
You can open a serial console session on unit from a PC connected via a RS-232
cable connection. The following procedure uses Microsoft HyperTerminal as an
example.
To access the unit from a serial console via HyperTerminal:
1. Open HyperTerminal.
2. On the File menu, select <New Connection>.
The New Connection Properties dialog box appears.
3. Type a name for the connection and click <OK>.
4. Select <Direct to COM1> in the drop-down box (or the serial port on the PC if
different from COM1) and click <OK>.
IPVgate - 20x Ver. 2.4
Accessing the Unit
3-3
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
5. In the Properties dialog box, enter the following information:
Bits per second
9600
Data bits
8
Parity
None
Stop bits
1
Flow control
None
6. Click <OK>.
The session opens and the following message is displayed:
IPCenterII. Copyright(c) 2000-2005 RAD Systems Ltd.
Password:
7. Enter the password for the unit and press <Enter>.
3.3
Unit Command Line Interface (CLI)
This section discusses the unit Command Line Interface, which is an extensive
library of commands for controlling various settings.
Telnet Manager Commands
The unit can open several sessions simultaneously. Use the tm commands to
remove sessions and change passwords:
•
show
•
kick
•
kick_all
•
psw_set
•
psw_def
•
write
•
telnet
•
conf_get
•
conf_set
•
conf_print.
show
Displays all sessions currently connected to the unit. Information appears in
tabular form and includes the IP address and starting time of the connection.
Syntax:
tm show
Syntax Description:
No arguments or keywords.
3-4
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Telnet Manager Commands (tm).
Command Mode:
Privileged.
Note
• Each session is assigned a number. This session number is needed when
terminating a session.
• The session preceded by an asterisk (*) is the one you are logged on with.
Example:
IPC>tm show
Num Terminal
0
/tyCo/1
*
1
212.179.33.34
Start Date&Time
15:29:45 2/25/2002
10:35:43 3/3/2002
kick
Ends a specific session. Immediately terminates the connection of the session
chosen.
Syntax:
tm kick <session>
Syntax Description:
Part
Description
session
The number of the session to terminate.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Telnet Manager Commands (tm).
Command Mode:
Privileged.
Note
• First use the show command to identify the number of the session you want
to terminate.
• To terminate all sessions, use the kickall command.
Example:
IPC>tm kick 2
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-5
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
kick_all
Terminates all sessions on the unit. Also terminates the current session.
Syntax:
tm kick_all
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Telnet Manager Commands (tm).
Command Mode:
Privileged.
Note
This command terminates all sessions, including your session. Use the kick
command to terminate a specific session.
Example:
IPC>tm kick_all
psw_set
Changes the current password. Both the User and Privileged command modes
have separate passwords. Changes the password for the mode in which you are
currently logged on.
Syntax:
tm psw_set <password>
Syntax Description:
Part
Description
password
The new password to set.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Telnet Manager Commands (tm).
Command Mode:
Privileged.
Note
3-6
Passwords are case sensitive.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Example:
IPC>tm psw_set p5t65
psw_def
Sets the password to default.
Syntax:
tm psw_def
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Telnet Manager Commands (tm).
Command Mode:
Privileged.
Note
Each unit has its own default password. Verify this password before using the
psw_def command.
Example:
IPC>tm psw_def
write
Displays text on all consoles connected to the unit. Enables communication with
other users simultaneously logged in to the same unit.
Syntax:
tm write <text>
Syntax Description:
Part
Description
Text
The text to display in the console window.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Telnet Manager Commands (tm).
Command Mode:
Privileged.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-7
Chapter 3 Using the Command Line Interface
Note
Installation and Operation Manual
All connected users will see the written text.
Example:
IPC>tm write Hi
telnet
Opens a new session with another host.
Syntax:
tm telnet <host[,port]>
Syntax Description:
Part
Description
Host
IP address.
Port
Port number.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Telnet Manager Commands (tm).
Command Mode:
Privileged.
Example:
IPC>tm telnet 192.168.0.123,23
conf_get
Copies a unit configuration. The unit can be the host unit or another.
Syntax:
tm conf_get <host,psw[,port] >
Syntax Description:
Part
Description
Host
IP address for remote unit.
‘localhost’ for host unit .
Psw
unit password.
Port
telnet port number.
Defaults:
No default settings.
3-8
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Location in Hierarchy:
Belongs to the Telnet Manager Commands (tm).
Command Mode:
Privileged.
Note
Configuration file location: F:\Config.dat
Example:
IPC>tm conf_get 192.168.0.123,321,23
conf_set
Sets a unit using Config.dat configuration file.
Syntax:
tm conf_set
Defaults:
No default settings.
Location in Hierarchy:
This command belongs to the Telnet Manager Commands (tm).
Command Mode:
Privileged.
Note
The Config.dat file should be located in F:\.
Example:
IPC>tm conf_set
conf_print
Prints a unit configuration.
Syntax:
tm conf_print
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Telnet Manager Commands (tm).
Command Mode:
Privileged.
Example:
IPC>tm conf_print
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-9
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
IP and Basic Configuration
Defines the unit connection to the LAN and WAN, and its various functions in this
environment.
ip
Adds an IP address to the routing table, or removes an existing IP address from
the table.
Syntax:
ipcfg ip <ext | int> <add | rem> <ip address> <mask> <pri |
sec>
Syntax Description:
Part
Description
ext
Keyword to set external IP address.
int
Keyword to set internal IP address.
add
Keyword to add a new IP address.
rem
Keyword to remove an existing IP address.
ip address
IP address to be added to, or removed from, the list.
mask
Subnet mask of the specified IP address.
pri
Keyword to specify a primary address.
sec
Keyword to specify a secondary address.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
Note
• unit can have up to twenty IP addresses configured as follows:
i. External: one primary and ten secondary.
ii. Internal: one primary and ten secondary.
• Adding or removing an IP Address only takes effect after restarting the unit
(see Restart on page 3-133).
Example:
IPC>ipcfg ip int add 12.18.0.22 255.255.255.0 sec
gtw
Sets the default gateway of the unit.
3-10
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Syntax:
ipcfg gtw <ip address>
Syntax Description:
Part
Description
ip address
The IP address to set as the default gateway.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
Note
Changing the default gateway only takes effect after restarting the unit (see
Restart on page 3-133).
Example:
IPC>ipcfg gtw 33.66.40.205
dns
Sets the IP address of the primary DNS server. See dns2 (on page 3-12) for
setting the secondary DNS server.
Syntax:
ipcfg dns <ip>
Syntax Description:
Part
Description
ip
The IP address of the primary DNS server.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-11
Chapter 3 Using the Command Line Interface
Note
Installation and Operation Manual
• This IP Address is ignored when the unit is configured as a DHCP Client (on
page 3-15).
• Setting the IP address of the primary DNS server only takes effect after
restarting the unit.
• DNS settings take effect in all cases except for a configured pppoe or pptp
connection.
Example:
IPC>ipcfg dns 34.67.102.43
dns2
Sets the IP address of the secondary DNS server. See dns (on page 3-11) for
setting the primary DNS server.
Syntax:
ipcfg dns2 <ip>
Syntax Description:
Part
Description
ip
The IP address of the secondary DNS server.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
Note
• This IP Address is ignored when the unit is configured as a DHCP Client (on
page 3-15).
• Setting the IP address of the secondary DNS server only takes effect after
restarting the unit.
• DNS settings take effect in all cases except for a configured pppoe or pptp
connection.
Example:
IPC>ipcfg dns2 34.67.112.43
Dhcp
Commands in this category include:
3-12
•
server
•
client.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
server
Configures the unit as a DHCP server for LAN or office network.
Commands in this category:
•
enable
•
pool
•
show
•
interface.
enable
Syntax:
ipcfg dhcp server enable <y | n>
Syntax Description:
Part
Description
y
Keyword to enable the unit as a DHCP server.
n
Keyword to disable the unit as a DHCP server.
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the DHCP subset of the TCP/IP Configuration Commands (ipcfg dhcp).
Command Mode:
Privileged.
Note
• The unit needs a pool (on page 3-13) of IP addresses when enabled as a DHCP
server for a LAN.
• Configuring the unit as a DHCP server only takes effect after restarting the
unit.
Example:
IPC>ipcfg dhcp server y
pool
Sets the range of consecutive IP Addresses available to the unit DHCP server pool.
The unit DHCP server assigns an IP address to a DHCP client from this pool of IP
addresses.
Syntax:
ipcfg dhcp server pool <low> <high>
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-13
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Syntax Description:
Part
Description
low
A number between 0 and 255, representing the 1st IP
address in the range.
high
A number between 0 and 255, representing the last IP
address in the range.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DHCP subset of the TCP/IP Configuration Commands (ipcfg dhcp).
Command Mode:
Privileged.
Note
• The unit assigns IP Addresses from this pool when enabled as a DHCP server
for a LAN or office network. The low and high values represent the last byte in
the IP address of the DHCP server. For example, if the DHCP server IP address
is 10.0.0.1, setting a low value of 2 and a high value of 254, means that the
available pool of IP addresses is between 10.0.0.2 and 10.0.0.254.
• Setting the pool of IP Addresses only takes effect after restarting the unit.
Example:
IPC>ipcfg dhcp server pool 2 254
show
Displays the DHCP lease. This information is printed to the terminal screen.
Syntax:
ipcfg dhcp server show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DHCP subset of the TCP/IP Configuration Commands (ipcfg dhcp).
Command Mode:
Privileged.
Example:
IPC>ipcfg dhcp server show
3-14
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
interface
Sets the DHCP server IP interface.
Syntax:
ipcfg dhcp server interface <ip/mask | default>
Syntax Description:
Part
Description
ip/mask
The IP address and network mask of the DHCP server
interface, or the keyword default.
Default
Keyword to use the Primary internal IP address.
Defaults:
Default setting is default.
Location in Hierarchy:
Belongs to the DHCP subset of the TCP/IP Configuration Commands (ipcfg dhcp).
Command Mode:
Privileged.
Note
Setting the DHCP server IP interface only takes effect after restarting the unit.
Example:
IPC>ipcfg dhcp server interface 23.56.45.33/255.255.255.0
client
Commands in this Category
•
enable
•
show
•
dns_by_dhcp
•
send_client_id.
enable
Enables/disables the unit as a DHCP client. If this setting is not enabled, the unit
uses the dns (on page 3-11) and dns2 (on page 3-12) settings.
Syntax:
ipcfg dhcp client enable <y | n>
Syntax Description:
Part
Description
y
Keyword to enable the unit as a DHCP client.
n
Keyword to disable the unit as a DHCP client.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-15
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the DHCP Client subset of the TCP/IP Configuration Commands (ipcfg
dhcp client).
Command Mode:
Privileged.
Note
Enabling or disabling the unit as a DHCP client only takes effect after restarting
the unit.
Example:
IPC>ipcfg dhcp client enable y
show
Displays the DHCP client parameters. This information is printed to the terminal
screen.
Syntax:
ipcfg dhcp client show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DHCP subset of the TCP/IP Configuration Commands (ipcfg dhcp).
Command Mode:
Privileged.
Example:
IPC>ipcfg dhcp client show
dns_by_dhcp
Enables/disables DHCP in obtaining the IP addresses of DNS servers.
Syntax:
ipcfg dhcp client dns_by_dhcp <y | n>
Syntax Description:
3-16
Part
Description
y
Keyword to enable DHCP.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
n
Chapter 3 Using the Command Line Interface
Keyword to disable DHCP.
Defaults:
Default setting is y.
Location in Hierarchy:
Belongs to the DHCP Client subset of the TCP/IP Configuration Commands (ipcfg
dhcp client).
Command Mode:
Privileged.
Note
Enabling or disabling DHCP to obtain the IP addresses of DNS servers only takes
effect after restarting the unit.
Example:
IPC>ipcfg dhcp client dns_by_dhcp y
send_client_id
Enables/disables the sending of DHCP client identifiers.
Syntax:
ipcfg dhcp client send_client_id <y | n>
Syntax Description:
Part
Description
y
Keyword to enable the sending of DHCP client identifiers.
n
Keyword to disable the sending of DHCP client identifiers.
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the DHCP Client subset of the TCP/IP Configuration Commands (ipcfg
dhcp client).
Command Mode:
Privileged.
Example:
IPC>ipcfg dhcp client send_client_id y
rip
Commands in this Category
•
IPVgate - 20x Ver. 2.4
enable
Unit Command Line Interface (CLI)
3-17
Chapter 3 Using the Command Line Interface
•
version
•
mcast
•
password.
Installation and Operation Manual
enable
Enables/disables the Routing Information Protocol (RIP).
Syntax:
ipcfg rip enable <y | n>
Syntax Description:
Part
Description
y
Keyword to enable RIP.
n
Keyword to disable RIP.
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the RIP subset of the TCP/IP Configuration Commands (ipcfg rip).
Command Mode:
Privileged.
Note
Enabling or disabling the Routing Information Protocol only takes effect after
restarting the unit.
Example:
IPC>ipcfg rip enable y
version
Sets the RIP version.
Syntax:
ipcfg rip <1 | 2>
Syntax Description:
Part
Description
1
Keyword to set RIP version 1.
2
Keyword to set RIP version 2.
Defaults:
Default setting is 2.
3-18
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Location in Hierarchy:
Belongs to the RIP subset of the TCP/IP Configuration Commands (ipcfg rip).
Command Mode:
Privileged.
Example:
IPC>ipcfg rip version 1
mcast
Implements RIP multicast instead of RIP broadcast.
Syntax:
ipcfg rip mcast <y | n>
Syntax Description:
Part
Description
y
Keyword to set RIP multicast.
n
Keyword to set RIP broadcast.
Defaults:
Default setting is y.
Location in Hierarchy:
Belongs to the RIP subset of the TCP/IP Configuration Commands (ipcfg rip).
Command Mode:
Privileged.
Note
Setting RIP multicast or RIP broadcast only takes effect after restarting the unit.
Example:
IPC>ipcfg rip mcast n
password
Sets the RIP authentication password. Used only when RIP version 2 is enabled
(see version on page 3-18).
Syntax:
ipcfg rip password <password>
Syntax Description:
Part
Description
password
The new password to set.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-19
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the RIP subset of the TCP/IP Configuration Commands (ipcfg rip).
Command Mode:
Privileged.
Note
• Passwords are case sensitive.
• The password can have a maximum of 16 characters.
Example:
IPC>ipcfg rip password ht6lU7
time
Sets the IP address or domain name of the SNTP server that synchronizes the
time and date of the unit.
Syntax:
ipcfg time <ip | domain name>
Syntax Description:
Part
Description
ip
The IP address of the SNTP server.
domain name
The domain name of the SNTP server.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
Note
• The IP address of the SNTP server is usually the same as the IP address of the
IPVSuite in the service provider’s network.
• Setting the IP address of the SNTP server only takes effect after restarting the
unit.
Examples:
IPC> ipcfg time 34.56.78.99
IPC> ipcfg time rad.com
3-20
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
domain
Enters the domain name of the ISP.
Syntax:
ipcfg domain <domain>
Syntax Description:
Part
Description
domain
The domain name of the ISP.
Defaults:
Default setting is mysite.com.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
Note
Setting the domain name of the ISP only takes effect after restarting the .
Example:
IPC>ipcfg domain rad.com
tel
Sets the E.164 telephone number of the unit.
Syntax:
ipcfg tel <tel num>
Syntax Description:
Part
Description
tel num
The primary telephone number of the unit.
Defaults:
Default setting is 97249991212.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
Note
• The E.164 telephone number includes: country code + area code + telephone
number.
• Setting the telephone number only takes effect after restarting the unit.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-21
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Example:
IPC> ipcfg tel 97249991212
area
Sets the area code of unit's telephone number.
Syntax:
ipcfg area < area code | empty >
Syntax Description:
Part
Description
area code
The area code of unit's telephone number.
empty
Type ‘empty’ when no area code is required
Defaults:
Default setting is 4.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
Note
Setting the area code only takes effect after restarting the unit.
Example:
IPC> ipcfg area 4
country
Sets the country code of unit's telephone number.
Syntax:
ipcfg country <country code>
Syntax Description:
Part
Description
country code
The country code of unit's telephone number.
Defaults:
Default setting is 972.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
3-22
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Command Mode:
Privileged.
Note
Setting the country code only takes effect after restarting the unit.
Example:
IPC> ipcfg country 972
router
Configures the unit to function as a router, or displays information on the routing
tables.
Commands in this Category
•
add
•
del
•
show
•
ashow
•
flash.
add
Adds a static route entry to the router table.
Syntax:
ipcfg router add <ip/mask> <gateway>
Syntax Description:
Part
Description
ip/mask
The IP address and network mask of the static route
entry.
gateway
The gateway of the static route entry.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
Example:
IPC>ipcfg router add 45.36.56.120/255.255.255.0 56.26.35.124
del
Removes a static route entry from the router table.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-23
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Syntax:
ipcfg router del <ip/mask> <gateway>
Syntax Description:
Part
Description
ip/mask
The IP address and network mask of the static route
entry.
gateway
The gateway of the static route entry.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
Example:
IPC>ipcfg router add 45.36.56.120/255.255.255.0 56.26.35.12
show
Displays the routing tables.
Syntax:
ipcfg router show
Syntax Description:
No arguments or keywords
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
Example:
IPC>ipcfg router show
ashow
Displays the routing tables and all the network buffers
Syntax:
ipcfg router ashow
3-24
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
Example:
IPC>ipcfg router ashow
flash
Removes all the entries from the routing table.
Syntax:
ipcfg router flash
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
Example:
IPC>ipcfg router flash
nat
Commands in this Category
•
enable
•
interface.
enable
Enables NAT on the unit.
Syntax:
ipcfg nat enable <y | n>
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-25
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Syntax Description:
Part
Description
y
Keyword to enable NAT.
n
Keyword to disable NAT.
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the NAT subgroup of the TCP/IP Configuration Commands (ipcfg nat).
Command Mode:
Privileged.
Note
• Enabling/disabling NAT on the unit only takes effect after the unit.
• Enabling NAT automatically enables unit to function as a router
(on page 3-23).
Example:
IPC>ipcfg nat enable y
interface
Sets the NAT IP interface.
Syntax:
ipcfg nat interface <global | local> <ip/mask | default>
Syntax Description:
Part
Description
global
Keyword to set the external IP interface.
local
Keyword to set the internal IP interface.
ip/mask
The IP address and network mask of the NAT IP interface,
or the keyword default.
Defaults:
Default setting is default (primary internal IP address and netmask).
Location in Hierarchy:
Belongs to the NAT subset of the TCP/IP Configuration Commands (ipcfg nat).
Command Mode:
Privileged.
Note
3-26
Setting the NAT IP interface only takes effect after restarting the unit.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Example:
IPC>ipcfg nat interface global 26.56.25.33/255.255.255.0
ftpip
Sets the IP address of the FTP server with the unit software upgrade.
Syntax:
ipcfg ftpip <ip>
Syntax Description:
Part
Description
ip
The IP address of the FTP server.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
Example:
IPC>ipcfg ftpip 212.45.65.33
ftpfile
Sets the filename of the software upgrade to retrieve by FTP.
Syntax:
ipcfg ftpfile <file name>
Syntax Description:
Part
Description
file name
The name of the file to be downloaded.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-27
Chapter 3 Using the Command Line Interface
Note
Installation and Operation Manual
• The software upgrade is a file in the format IPCxxx.BIN, where xxx is the
version number of the software.
• The file name is case sensitive.
Example:
IPC>ipcfg ftpfile IPC050.BIN
ddns
Sets the IP interface updated at the DDNS server.
Syntax:
ipcfg ddns <ext | int>
Syntax Description:
Part
Description
Ext
Keyword to set the external IP interface to be updated.
Int
Keyword to set the internal IP interface to be updated.
Defaults:
Default setting is ext.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
Privileged.
Note
The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg ddns int
mem
Displays the network pool and memory of the unit.
Syntax:
ipcfg mem
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
3-28
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Command Mode:
User.
stat
Displays the current network TCP/IP statistics.
Syntax:
ipcfg stat
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
User.
ppp
Use the ppp commands to set the Point to Point Protocol parameters.
Commands in this category:
•
user
•
psw
•
retry_num
•
retry_timeout
•
pptp
•
pptp_ip
•
pptp_quirk
•
pppoe
•
pppoa
•
pppoeoa
•
trace_event
•
pppoe_svc
•
lcp_echo
•
reload
•
show.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-29
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
user
Sets the PPP username.
Syntax:
ipcfg ppp user <username | empty>
Syntax Description:
Part
Description
username
The name of the user account.
empty
Type ‘empty’ when no user name is required.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the PPP subgroup of the TCP/IP Configuration Commands (ipcfg ppp).
Command Mode:
Privileged.
Note
• The username must include the ISP’s domain name.
• The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg ppp username example@ispdomain.com
psw
Sets the password for the PPP username.
Syntax:
ipcfg ppp psw <password | empty>
Syntax Description:
Part
Description
Password
The password of the user account.
empty
Type ‘empty’ when no user name is required.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the PPP subgroup of the TCP/IP Configuration Commands (ipcfg ppp).
Command Mode:
Privileged.
3-30
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Note
Chapter 3 Using the Command Line Interface
The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg ppp psw As4xTy
retry_num
Sets the number of times to attempt establishing a connection before aborting.
Syntax:
ipcfg ppp retry_num <number>
Syntax Description:
Part
Description
number
The number of times to attempt connecting [1-5]
Defaults:
Default is 3.
Location in Hierarchy:
Belongs to the PPP subgroup of the TCP/IP Configuration Commands (ipcfg ppp).
Command Mode:
Privileged.
Note
The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg ppp retry_num 2
retry_timeout
Sets the delay (in seconds) between attempts to establish a connection.
Syntax:
ipcfg ppp retry_timeout <number>
Syntax Description:
Part
Description
Number
The amount of time to wait between connection attempts
[seconds, by steps of 30].
Defaults:
Default setting is 30 seconds.
Location in Hierarchy:
Belongs to the PPP subgroup of the TCP/IP Configuration Commands (ipcfg ppp).
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-31
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Command Mode:
Privileged.
Note
The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg ppp retry_timeout 10
pptp
Enables/disables Point to Point Tunnel Protocol.
Syntax:
ipcfg ppp pptp <y | n>
Syntax Description:
Part
Description
Y
Keyword to enable pptp.
N
Keyword to disable pptp.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the PPP subgroup of the TCP/IP Configuration Commands (ipcfg ppp).
Command Mode:
Privileged.
Note
The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg ppp pptp y
pptp_ip
Sets the PPTP server ip address.
Syntax:
ipcfg ppp pptp_ip <ip address>
Syntax Description:
Part
Description
Ip address
The IP address of the PPTP.
Defaults:
No default settings.
3-32
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Location in Hierarchy:
Belongs to the PPP subgroup of the TCP/IP Configuration Commands (ipcfg ppp).
Command Mode:
Privileged.
Note
The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg ppp pptp_ip 34.65.143.03
pptp_quirk
Includes the quirk string when connecting with PPTP.
Syntax:
ipcfg ppp pptp_quirk <y | n>
Syntax Description:
Part
Description
Y
Keyword to connect using the quirk string.
N
Keyword to connect without the quirk string.
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the PPP subgroup of the TCP/IP Configuration Commands (ipcfg ppp).
Command Mode:
Privileged.
Note
• The new setting only takes effect after restarting the unit.
• The quirk string is only needed when connecting with an ORCHID type modem.
Example:
IPC>ipcfg ppp pptp_quirk y
pppoe
Enables/disables Point to Point Protocol Over Ethernet.
Syntax:
ipcfg ppp pppoe <y | n>
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-33
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Syntax Description:
Part
Description
Y
Keyword to enable PPPOE.
N
Keyword to disable PPPOE.
Defaults:
Default setting is n.
Location in Hierarchy:
This command belongs to the PPP subgroup of the TCP/IP Configuration
Commands (ipcfg ppp).
Command Mode:
Privileged.
Note
• The new setting only takes effect after restarting the unit.
• Make sure that either PPTP or PPPOE is enabled (both can be disabled).
Example:
IPC>ipcfg ppp pppoe y
pppoe_svc
Sets the specific service name for connecting with PPPOE.
Syntax:
ipcfg ppp pppoe_svc <name>
Syntax Description:
Part
Description
Name
The name of the service to use when connecting with
PPPOE.
Defaults:
No default setting.
Location in Hierarchy:
Belongs to the PPP subgroup of the TCP/IP Configuration Commands (ipcfg ppp).
Command Mode:
Privileged.
Note
The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg ppp pppoe_svc rad
3-34
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
pppoa
Enables/disables Point to Point Protocol Over ATM.
Syntax:
ipcfg ppp pppoa <y | n>
Syntax Description:
Part
Description
Y
Keyword to enable pptp.
N
Keyword to disable pptp.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the PPP subgroup of the TCP/IP Configuration Commands (ipcfg ppp).
Command Mode:
Privileged.
Note
The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg ppp pppoa y
pppoeoa
Enables/disables Point to Point Protocol over Ethernet over ATM.
Syntax:
ipcfg ppp pppoeoa <y | n>
Syntax Description:
Part
Description
Y
Keyword to enable pptp.
N
Keyword to disable pptp.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the PPP subgroup of the TCP/IP Configuration Commands (ipcfg ppp).
Command Mode:
Privileged.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-35
Chapter 3 Using the Command Line Interface
Note
Installation and Operation Manual
The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg ppp pppoa y
lcp_echo
Enables/disables the lcp echo.
Syntax:
ipcfg ppp lcp_echo <y | n>
Syntax Description:
Part
Description
Y
Keyword to enable the lcp echo.
N
Keyword to disable the lcp echo.
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the PPP subgroup of the TCP/IP Configuration Commands (ipcfg ppp).
Command Mode:
Privileged.
Note
The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg ppp lcp_echo y
reload
Use this command to manually reload the PPP connection.
Syntax:
ipcfg ppp reload
Syntax Description:
No arguments or keywords.
Defaults:
No default setting.
Location in Hierarchy:
Belongs to the PPP subgroup of the TCP/IP Configuration Commands (ipcfg ppp).
3-36
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Command Mode:
Privileged.
Note
The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg ppp reload
show
Shows the current PPP settings.
Syntax:
ipcfg ppp show
Syntax Description:
No arguments or keywords.
Defaults:
No default setting.
Location in Hierarchy:
Belongs to the PPP subgroup of the TCP/IP Configuration Commands (ipcfg ppp).
Command Mode:
Privileged.
Example:
IPC>ipcfg ppp show
trace_event
Enables/disables PPP event log.
Syntax:
ipcfg trace_event <y | n>
Syntax Description:
Part
Description
Y
Keyword to enable pptp.
N
Keyword to disable pptp.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the PPP subgroup of the TCP/IP Configuration Commands (ipcfg ppp).
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-37
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Command Mode:
Privileged.
Note
The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg ppp trace_event y
QoS
The QoS commands define the priority of the voice packets over the data
packets.
Commands in this category:
•
Show
•
Enable
•
Bitrate.
Show
Displays QoS configuration settings. See each of the specific qos commands for
further details about the information displayed.
Syntax:
ipcfg qos show
Syntax Description:
No arguments or keywords.
Defaults:
No default setting.
Location in Hierarchy:
Belongs to the QoS subgroup of the TCP/IP Configuration Commands (ipcfg qos).
Command Mode:
Privileged.
Example:
IPC>ipcfg qos show
enable
Enables/disables the QoS.
Syntax:
ipcfg qos enable <y | n>
3-38
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Syntax Description:
Part
Description
y
Keyword to enable the QoS.
n
Keyword to disable the QoS.
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the QoS subgroup of the TCP/IP Configuration Commands (ipcfg qos).
Command Mode:
Privileged.
Note
The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg qos enable y
bitrate
Defines the upstream bitrate (bandwidth).
Syntax:
ipcfg qos bitrate < number >
Syntax Description:
Part
Description
number
The upstream Bitrate in Kbits per second.
Defaults:
No default settings. However, if no bitrate is specified, the minimum bitrate is
64Kbits per second.
Location in Hierarchy:
Belongs to the QoS subgroup of the TCP/IP Configuration Commands (ipcfg qos).
Command Mode:
Privileged.
Note
The new setting only takes effect after restarting the unit.
Example:
IPC>ipcfg qos bitrate 64
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-39
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
show
Displays the IP Configuration settings. See each of the specific ipcfg commands
for further details about the information displayed.
Syntax:
ipcfg show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the TCP/IP Configuration Commands (ipcfg).
Command Mode:
User.
Example:
IPC>ipcfg show
MACext
10:05:22:01:01:3e MACint
10:05:22:01:01:3f
IPext
22.19.33.40
MASKext
255.255.255.224
IPint
12.16.0.2
MASKint
255.255.255.0
Gateway
22.19.33.33
DnsFromDhcp YES
DNS1
12.15.106.10
DNS2
12.15.106.11
DHCPclient
NO
DHCPserver NO
Domain
rad.com
Tel
97245551243
SNTP
202.109.102.25
Router
NO
DHCPpool
2-254
Nat
NO
DNSUpdate
2
DDNS
EXT
RIP
NO
RIPConfig
ver 2 mcast YES
FTPServer
202.109.102.25
FtpFile
IPC2400A.BIN
NatInterface default
DhcpInterface default
AddIpExt
none
AddIpInt
102.108.0.22/255.255.255.0
Billing Server
Commands in this category:
•
glob
•
loc.
glob
The unit needs to routinely connect to the global billing server and upload its raw
data. Use the billsrv glob commands to configure the URL of the script file that
accepts this data.
Commands in this category:
3-40
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
•
set_addr
•
set_port
•
set_path
•
set_head
•
set_period
•
show.
Chapter 3 Using the Command Line Interface
set_addr
Sets the domain name or IP address of the Global Billing Server.
Syntax:
billsrv glob set_addr <address>
Syntax Description:
Part
Description
address
The domain name or IP address of the Global Billing
Server.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the global subset of the Billing Server Commands (billsrv glob).
Command Mode:
Privileged.
Example:
IPC>billsrv glob set_addr bill.rad.com
set_port
Sets the port number of the Global Billing Server.
Syntax:
billsrv glob set_port <port>
Syntax Description:
Part
Description
port
The port number of the Global Billing Server.
Defaults:
Default port is 80.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-41
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Location in Hierarchy:
Belongs to the global subset of the Billing Server Commands (billsrv glob).
Command Mode:
Privileged.
Example:
IPC>billsrv glob set_port 80
set_path
Sets the path to the Global Billing Server script file.
Syntax:
billsrv glob set_path <path>
Syntax Description:
Part
Description
path
The path to the Global Billing Server script file.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the global subset of the Billing Server Commands (billsrv glob).
Command Mode:
Privileged.
Note
The path variable is the full path to the Global Billing Server script file and begins
with a forward slash (/).
Example:
IPC>billsrv glob set_path /ipc/bill_1.php
set_head
Sets the protocol header of the Global Billing Server.
Syntax:
billsrv glob set_head <http:// | https://>
Syntax Description:
3-42
Part
Description
http://
Keyword to set http as the protocol.
https://
Keyword to set https as the protocol.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Defaults:
Default setting is https://.
Location in Hierarchy:
Belongs to the global subset of the Billing Server Commands (billsrv glob).
Command Mode:
Privileged.
Example:
IPC>billsrv glob set_head https://
set_period
Sets the global billing reporting period.
Syntax:
billsrv glob set_period < e | h | d>
Syntax Description:
Part
Description
e
Send global billing after every transaction.
h
Send global billing every hour.
d
Send global billing once a day.
Defaults:
Default setting is to send global billing every transaction (e).
Location in Hierarchy:
Belongs to the global subset of the Billing Server Commands (billsrv glob).
Command Mode:
Privileged.
Example:
IPC>billsrv glob set_period e
show
Displays the Global Billing Server settings.
Syntax:
billsrv glob show
Syntax Description:
No arguments or keywords.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-43
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the global subset of the Billing Server Commands (billsrv glob).
Command Mode:
User.
Note
This command displays the four components of the URL to the Global Billing
Server script file (see glob on page 3-40).
Example:
IPC>billsrv glob show
Global billing server parameters
Head:
https://
Addr:
bill.rad.com
Port:
80
Path:
/ipc/bill_1.php
loc
The unit can send an abbreviated version of the billing information to a specified
e-mail address. Use the billsrv loc commands to configure the e-mail address and
specify the frequency of delivery.
Commands in this category:
•
set_e-mail
•
set_period
•
show.
set_email
Sets the e-mail address that will receive a copy of the billing information.
Syntax:
billsrv loc set_email <e-mail address | none>
Syntax Description:
Part
Description
e-mail address
The e-mail address to receive the billing information.
none
Type none when no email address is required.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the local subset of the Billing Server Commands (billsrv loc).
3-44
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Command Mode:
Privileged.
Note
• The e-mail address receives an abbreviated version of the same data sent to
the Global Billing Server, and with the same frequency (see set_period on page
3-45).
• Only one e-mail address can receive the billing information - repeated use of
this command replaces the old e-mail address with the new one.
Example:
IPC>billsrv loc set_email john@doe.com
set_period
Sets the frequency of the updates sent from the unit to the global billing server
(see glob on page 3-40) and the e-mail address (see set_e-mail on page 3-44).
Syntax:
billsrv loc set_period <auto | daily | weekly | monthly>
Syntax Description:
Part
Description
d
Keyword to set the frequency to once every day.
w
Keyword to set the frequency to once every week.
m
Keyword to set the frequency to once every month.
Defaults:
Default setting is d.
Location in Hierarchy:
Belongs to the local subset of the Billing Server Commands (billsrv loc).
Command Modes:
Privileged.
Examples:
IPC>billsrv loc set_period d
show
Displays the local billing server settings.
Syntax:
billsrv loc show
Syntax Description:
No arguments or keywords.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-45
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the local subset of the Billing Server Commands (billsrv loc).
Command Mode:
User.
Example:
IPC>billsrv loc show
E-mail address: john@doe.com
Period: WEEK
File System
Control unit's File System utilities with the fs commands.
Commands in this category:
•
dir
•
type
•
del
•
copy
•
format
•
iniws
•
create.
dir
Lists the contents of a directory. The path to the directory includes the drive
letter but without a trailing slash after the directory name.
Syntax:
fs dir <path>
Syntax Description:
Part
Description
path
The path to the directory.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the File System Commands (fs).
3-46
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Command Mode:
Privileged.
Example:
IPC>fs dir f:/ssl
type
Prints a text file to the console.
Syntax:
fs type <file>
Syntax Description:
Part
Description
file
The name of the file, including the full path.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the File System Commands (fs).
Command Mode:
Privileged.
Example:
IPC>fs type f:/siplog.txt
del
Deletes an existing file.
Syntax:
fs del <file>
Syntax Description:
Part
Description
file
The name of the file, including the full path.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the File System Commands (fs).
Command Mode:
Privileged.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-47
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Example:
IPC>fs del f:/ssl/example.txt
copy
Copies an existing file.
Syntax:
fs copy <src> <dst>
Syntax Description:
Part
Description
src
Source - The name of the file, including the full path.
dst
Destination - The name of the file, including the full path.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the File System Commands (fs).
Command Mode:
Privileged.
Example:
IPC>fs copy f:/ssl/example.txt R:/temp/example.txt
format
Formats a drive.
Syntax:
fs format <drive>
Syntax Description:
Part
Description
drive
The drive to format.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the File System Commands (fs).
Command Mode:
Privileged.
3-48
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Note
Chapter 3 Using the Command Line Interface
• This command returns all settings to their default values (except for IP
Configuration settings).
• The unit automatically initiates a restart after formatting the drive.
• All data on the specified drive will be erased.
• Warning: There is no confirmation message after issuing this command!
Example:
IPC>fs format f:
iniws
Writes a string directly to the unit INI file.
Syntax:
fs iniws <section> <key> <string>
Syntax Description:
Part
Description
Section
The name of the section in the INI file.
Key
The name of the parameter in the section.
String
The value of the parameter.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the File System Commands (fs).
Command Mode:
Privileged.
Note
• The unit writes the configuration string to the SysConf.ini file located in the
root directory of the F drive (F:/sysconf.ini). Use the type (on page 3-47)
command to view the contents of this file.
• Adding new entry to the INI file takes effect only after restarting the unit.
Example:
IPC>fs iniws phone digest off
create
Creates a new file.
Syntax:
fs create
IPVgate - 20x Ver. 2.4
<FilePath>
Unit Command Line Interface (CLI)
3-49
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Syntax Description:
Part
Description
filepath
The name of the file, including the full path.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the File System Commands (fs).
Command Mode:
Privileged.
Example:
IPC>fs create f:/ssl/example.txt
DNS Server
The unit can act as a DNS Server. Use the dns commands to control this functionality.
Commands in this category:
•
A
•
mx
•
add
•
rem
•
reload
•
show
•
domain.
a
Resolves the A DNS records for a specific host name.
Syntax:
dns a <host name>
Syntax Description:
Part
Description
host name
The host name to resolve.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DNS Server Commands (dns).
3-50
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Command Mode:
User.
Example:
IPC>dns a www.rad.com
mx
Resolves the MX DNS records for a specific host name.
Syntax:
dns mx <host name>
Syntax Description:
Part
Description
host name
The host name to resolve.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DNS Server Commands (dns).
Command Modes:
User.
Examples:
IPC>dns mx mail.rad.com
add
Adds an entry to the DNS database of the unit.
Syntax:
dns add <host name> <ip>
Syntax Description:
Part
Description
host name
The host name to resolve.
Ip
The IP address of the new host.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DNS Server Commands (dns).
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-51
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Command Modes:
User.
Examples:
IPC>dns add www 10.0.0.1
rem
Removes an entry from the DNS database of the unit.
Syntax:
dns rem <host name>
Syntax Description:
Part
Description
host name
The host name to resolve.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DNS Server Commands (dns).
Command Modes:
User.
Examples:
IPC>dns rem www
reload
Reloads the DNS database of the unit.
Syntax:
dns reload
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DNS Server Commands (dns).
Command Modes:
User.
3-52
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Examples:
IPC>dns reload
show
Shows the DNS database of the unit.
Syntax:
dns show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DNS Server Commands (dns).
Command Modes:
User.
Examples:
IPC>dns show
domain
Defines the secondary domain of units' DNS server authority.
Syntax:
dns domain <domain name>
Syntax Description:
Part
Description
domain name
The secondary domain of units' DNS server authority.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DNS Server Commands (dns).
Command Modes:
Privileged.
Examples:
IPC>dns domain rad.com
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-53
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
DDNS Registration
The unit needs to routinely update the DDNS server. Use the ddns commands to
configure the URL of the script file that accepts this update data.
Commands in this category:
•
set_addr
•
set_path
•
set_port
•
set_head
•
set_method
•
retr_time
•
show.
set_addr
Sets the domain name or IP address of the DDNS server.
Syntax:
ddns set_addr <address>
Syntax Description:
Part
Description
Address
The domain name or IP address of the DDNS server.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DDNS registration commands (ddns).
Command Mode:
Privileged.
Note
The unit uses this address when the DDNS registration method (see set_method
on page 3-56) is set to 1 (static).
Example:
IPC>ddns set_addr ddns.rad.com
set_path
Sets the path to the DDNS update script file.
Syntax:
ddns set_path <path>
3-54
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Syntax Description:
Part
Description
path
The path to the DDNS update script file.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DDNS registration commands (ddns).
Command Mode:
Privileged.
Note
The path variable is the full path to the update script file and begins with a
forward slash (/).
Example:
IPC>ddns set_path /ipc/update.php
set_port
Sets the port number of the DDNS server.
Syntax:
ddns set_port <port>
Syntax Description:
Part
Description
Port
The port number of the DDNS server.
Defaults:
Default setting is 80.
Location in Hierarchy:
Belongs to the DDNS registration commands (ddns).
Command Mode:
Privileged.
Example:
IPC>ddns set_port 81
set_head
Sets the protocol header of the DDNS server.
Syntax:
ddns set_head <https:// | https://>
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-55
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Syntax Description:
Part
Description
http://
Keyword to set http as the protocol.
https://
Keyword to set https as the protocol.
Defaults:
Default setting is https://.
Location in Hierarchy:
Belongs to the DDNS registration commands (ddns).
Command Mode:
Privileged.
Example:
IPC>ddns set_head https://
set_method
Sets the DDNS registration method.
Syntax:
ddns set_method <1 | 2>
Syntax Description:
Part
Description
1
Keyword to set standard update method according to RFC
2136.
2
Keyword to set RAD's update method.
Defaults:
Default setting is 2.
Location in Hierarchy:
Belongs to the DDNS registration commands (ddns).
Command Mode:
Privileged.
Note
• The standard update method uses the IP address from the set_addr command
(see set_addr on page 3-54).
• RAD's update method uses the IP address assigned by DHCP.
Example:
IPC>ddns set_method 2
3-56
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
retr_time
Sets the DDNS registrations retry time when the unit is installed behind another
router.
Syntax:
ddns retr_time <time(min) | default>
Syntax Description:
Part
Description
Time
In minutes
Defaults:
Default is 0.
Location in Hierarchy:
Belongs to the DDNS registration commands (ddns).
Command Mode:
Privileged.
Note
• The standard update method uses the IP address from the set_addr command
(see set_addr on page 3-54).
• RAD's update method uses the IP address assigned by DHCP.
Example:
IPC>ddns set_method 2
show
Displays the DDNS registration settings.
Syntax:
ddns show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DDNS registration commands (ddns).
Command Mode:
User.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-57
Chapter 3 Using the Command Line Interface
Note
Installation and Operation Manual
This command displays the four components of the URL to the script file (see
DDNS registration on page 3-54), and the update method (see set_method on
page 3-56) that the unit uses to connect.
Example:
IPC>ddns show
DNS Update parameters
Head:
https://
Addr:
ddns.rad.com
Port:
80
Path:
/ipc/update.php
Update: 2
NAT Configuration
The unit can act as a NAT Server. Use the nat commands to set NAT configuration
settings.
Commands in this Category
•
add
•
rem
•
show.
add
Adds a NAT relocation entry.
Syntax:
nat add <ip> <global port> <local port> <tcp | udp>
Syntax Description:
Part
Description
Ip
The IP address of the NAT entry.
global port
The global (incoming) port number of the NAT entry.
local port
The local (outgoing) port number of the NAT entry.
Tcp
Keyword to set TCP protocol.
Udp
Keyword to set UDP protocol.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the NAT Configuration commands (nat).
Command Mode:
Privileged.
3-58
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Note
Chapter 3 Using the Command Line Interface
• Adding a NAT relocation entry only takes effect after restarting the unit.
• 20 NAT entries are available.
Examples:
IPC>nat add 33.33.33.33 55 26 tcp
rem
Removes a NAT relocation entry.
Syntax:
nat rem <ip> <global port> <local port> <tcp | udp>
Syntax Description:
Part
Description
Ip
The IP address of the NAT entry.
global port
The global (incoming) port number of the NAT entry.
local port
The local (outgoing) port number of the NAT entry.
Tcp
Keyword to set TCP protocol.
Udp
Keyword to set UDP protocol.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the NAT Configuration commands (nat).
Command Mode:
Privileged.
Note
Removing a NAT relocation entry only takes effect after restarting the unit.
Examples:
IPC>nat rem 33.33.33.33 55 26 tcp
show
Displays the NAT relocation tables.
Syntax:
nat show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-59
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Location in Hierarchy:
Belongs to the NAT Configuration commands (nat).
Command Mode:
User.
Example:
IPC>nat show
Port Services
The service commands configure the port values for the various unit services.
Commands in this Category
•
set
•
show.
set
Sets the port value for the various unit services.
Syntax:
service set <service> <port|default>
Syntax Description:
3-60
Part
Description
service
One of the following services: telnet, ftpdaemon, ftpdata,
RTP, http, dns, SIP or upgrade.
port
The port value of the service, or the keyword default.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Defaults:
Default settings are:
Service
Default Port
Telnet
23
FTPDaemon
21
FTPData
20
HTTP
80
DNS
53
Upgrade
54321
SIP
5060
RTP
40000
Location in Hierarchy:
Belongs to the Port Services Commands (service).
Command Mode:
Privileged.
Note
Changes to Port Service settings only take effect after restarting the unit.
Example:
IPC>service set rtp 40020
show
Displays the port values for the various unit services.
Syntax:
service show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Port Services Commands (service).
Command Modes:
User.
Examples:
IPC>service show
Telnet: 23
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-61
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
FTPDaemon: 21
FTPData: 20
HTTP: 80
DNS: 53
Upgrade: 54321
SIP: 5060
RTP: 40000
Telephony Gain
The gain commands control the telephony input and output gain values.
Commands in this Category
•
show
•
input
•
output.
show
Displays the gain values for all the telephony ports.
Syntax:
gain show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Telephony Gain Commands (gain).
Command Mode:
User.
Example:
IPC>gain show
Gain
Input
Output Fax
=====================================
Trunk 1
0
0
4
Trunk 2
0
0
4
Trunk 3
0
0
4
Trunk 4
0
0
4
Trunk 5
0
0
4
Trunk 6
0
0
4
Trunk 7
0
0
4
Trunk 8
0
0
4
Input
Commands in this category:
3-62
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Note
•
trunk1
•
trunk2
•
trunk3
•
trunk4.
Chapter 3 Using the Command Line Interface
When the unit is digital (D2+/D4+), the syntax will be changed to trunk1/2 (3/4,
5/6, 7/8) to configure each B-channel.
Trunk1
Use this command to set the input gain of the 1st telephone device.
Syntax:
gain input trunk1 <gain value>
Syntax Description:
Part
Description
gain value
An integer between -32 and 31 inclusive, or the keyword
default.
Defaults:
Default setting of the hardware is used (default).
Location in Hierarchy:
Belongs to input subset of the Telephony Gain Commands (gain input).
Command Mode:
Privileged.
Note
Use the keyword default to set the gain value to the default setting of the
hardware.
Example:
IPC>gain input trunk1 -2
trunk2
Sets the input gain of the 2nd telephone device.
Syntax:
gain input trunk2 <gain value>
Syntax Description:
Part
Description
gain value
An integer between -32 and 31 inclusive, or the keyword
default.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-63
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Defaults:
Default setting of the hardware is used (default).
Location in Hierarchy:
Belongs to input subset of the Telephony Gain Commands (gain input).
Command Mode:
Privileged.
Note
Use the keyword default to set the gain value to the default setting of the
hardware.
Example:
IPC>gain input trunk2 -2
Trunk3
Sets the input gain of the 3rd telephone device.
Syntax:
gain input trunk3 <gain value>
Syntax Description:
Part
Description
gain value
An integer between -32 and 31 inclusive, or the keyword
default.
Defaults:
Default setting of the hardware is used (default).
Location in Hierarchy:
Belongs to input subset of the Telephony Gain Commands (gain input).
Command Mode:
Privileged.
Note
• Use the keyword default to set the gain value to the default setting of the
hardware.
• The command is valid only in 4 ports or ISDN hardware versions.
Example:
IPC>gain input trunk3 -2
Trunk4
Sets the input gain of the 4th telephone device.
Syntax:
gain input trunk4 <gain value>
3-64
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Syntax Description:
Part
Description
gain value
An integer between -32 and 31 inclusive, or the keyword
default.
Defaults:
Default setting of the hardware is used (default).
Location in Hierarchy:
Belongs to input subset of the Telephony Gain Commands (gain input).
Command Mode:
Privileged.
Note
• Use the keyword default to set the gain value to the default setting of the
hardware.
• The command is valid only in 2FXS/4FXS/2BRI/4BRI hardware versions.
Example:
IPC>gain input trunk1 -2
Output
Commands in this Category
Note
•
trunk1
•
trunk2
•
trunk3
•
trunk4.
When the unit is digital (D2+/D4+) the syntax will be changed to trunk1/2 (3/4,
5/6, 7/8) to configure each B-channel.
trunk1
Sets the output gain of the 1st telephone device.
Syntax:
gain output trunk1 <gain value>
Syntax Description:
Part
Description
gain value
An integer between -32 and 31 inclusive, or the keyword
default.
Defaults:
Default setting of the hardware is used (default).
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-65
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Location in Hierarchy:
Belongs to output subset of the Telephony Gain Commands (gain output).
Command Mode:
Privileged.
Note
Use the keyword default to set the gain value to the default setting of the
hardware.
Example:
IPC>gain output trunk1 4
trunk2
Sets the output gain of the 2nd telephone device.
Syntax:
gain output trunk2 <gain value>
Syntax Description:
Part
Description
gain value
An integer between -32 and 31 inclusive, or the keyword
default.
Defaults:
Default setting of the hardware is used (default).
Location in Hierarchy:
Belongs to output subset of the Telephony Gain Commands (gain output).
Command Mode:
Privileged.
Note
Use the keyword default to set the gain value to the default setting of the
hardware.
Example:
IPC>gain output trunk2 -4
trunk3
Sets the output gain of the 3rd telephone device.
Syntax:
gain output trunk3 <gain value>
3-66
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Syntax Description:
Part
Description
gain value
An integer between -32 and 31 inclusive, or the keyword
default.
Defaults:
Default setting of the hardware is used (default).
Location in Hierarchy:
Belongs to output subset of the Telephony Gain Commands (gain output).
Command Mode:
Privileged.
Note
Use the keyword default to set the gain value to the default setting of the
hardware.
Example:
IPC>gain output trunk3 -default
trunk4
Sets the output gain of the 4th telephone device.
Syntax:
gain output trunk4 <gain value>
Syntax Description:
Part
Description
gain value
An integer between -32 and 31 inclusive, or the keyword
default.
Defaults:
Default setting of the hardware is used (default).
Location in Hierarchy:
Belongs to output subset of the Telephony Gain Commands (gain output).
Command Mode:
Privileged.
Note
Use the keyword default to set the gain value to the default setting of the
hardware.
Example:
IPC>gain output trunk4 -26
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-67
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Voice Over IP
The voip commands control the various VOIP settings.
Commands in this category:
•
secure
•
digest
•
codec
•
show.
secure
Enables/disables Voice Over IP media encryption support.
Syntax:
voip secure <on | off | must>
Syntax Description:
Part
Description
on
Keyword to enable Voice Over IP media encryption
support.
off
Keyword to disable Voice Over IP media encryption
support.
must
Keyword to enable Voice Over IP media encryption
support. Only encrypted data is allowed.
Defaults:
Default setting is off.
Location in Hierarchy:
Belongs to the Voice Over IP Commands (voip).
Command Mode:
Privileged.
Note
Changes to Voice Over IP settings only take effect after restarting the unit.
Example:
IPC>voip secure on
digest
Enables/disables the MD5 digest for Voice Over IP media encryption.
Syntax:
voip digest <on | off>
3-68
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Syntax Description:
Part
Description
on
Keyword to enable the MD5 digest.
off
Keyword to disable the MD5 digest.
Defaults:
Default setting is on.
Location in Hierarchy:
Belongs to the Voice Over IP Commands (voip).
Command Mode:
Privileged.
Note
• The secure (on page 3-68) command takes precedence. The MD5 digest is
only used if secure Voice Over IP media encryption is enabled.
• Changes to Voice Over IP settings only take effect after restarting the unit.
Example:
IPC>voip digest on
codec
Defines the preferred DSP compression.
Syntax:
voip codec <g723 | g729>
Syntax Description:
Part
Description
g723
Codec g723.
g729
Codec g729.
Defaults:
Default setting is g723.
Location in Hierarchy:
Belongs to the Voice Over IP Commands (voip).
Command Mode:
Privileged.
Example:
IPC>voip codec g723
Note
Changes to Voice Over IP settings only take effect after restarting the unit.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-69
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
show
Displays the Voice Over IP settings.
Syntax:
voip show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Voice Over IP Commands (voip).
Command Mode:
User.
Example:
IPC>voip show
Encryption - Off
Use MD5 digest - ON
Default DSP compression - G7231
SIP Commands
The sip commands control the various SIP settings.
Commands in this category:
•
timeout
•
redirect
•
proxy
•
show
•
reg_en
•
reg_exp
•
reg_url
•
reg_from
•
reg_to
•
reg_national.
timeout
Use these commands to set the SIP timeouts.
Commands in this category:
•
3-70
invite.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
invite
Sets the SIP invite timeout in seconds.
Syntax:
sip timeout invite <value | default>
Syntax Description:
Part
Description
value
The length in seconds of the invite timeout (3-60) or use
the wording ‘default’.
Defaults:
Default value is 5.
Location in Hierarchy:
Belongs to the SIP Commands (sip).
Command Mode:
Privileged.
Note
Changes to the SIP URI setting takes effect only after restarting the unit.
Example:
IPC>sip timeout invite 10
10
redirect
Sets the SIP URI (Universal Resource Identifier) for redirection.
Syntax:
sip redirect <uri|none>
Syntax Description:
Part
Description
uri
The URI to be used for redirection, or the keyword none.
Defaults:
Default value is none.
Location in Hierarchy:
Belongs to the SIP Commands (sip).
Command Mode:
Privileged.
Note
Changes to the SIP URI setting only takes effect after restarting the unit.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-71
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Example:
IPC>sip redirect 112@97249991212.rad.com
Proxy
Commands in this Category
•
addr
•
port
•
user
•
pwd.
addr
Sets the IP address or domain name of the SIP proxy.
Syntax:
sip proxy addr < ip | domain name | none>
Syntax Description:
Part
Description
ip
The IP address of the SIP proxy, or the keyword none.
Domain name
The domain name of the Sip proxy, or the keyword none.
Defaults:
Default value is none.
Location in Hierarchy:
Belongs to the proxy subset of the SIP Commands (sip proxy).
Command Mode:
Privileged.
Note
Changing the IP address of the SIP proxy only takes effect after restarting the
unit.
Example:
IPC>sip proxy ip 34.74.97.111
port
Sets the port number of the SIP proxy.
Syntax:
sip proxy port <port>
3-72
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Syntax Description:
Part
Description
port
The port of the SIP proxy, or the keyword none.
Defaults:
Default value is none.
Location in Hierarchy:
Belongs to the proxy subset of the SIP Commands (sip proxy).
Command Mode:
Privileged.
Note
Changing the port number of the SIP proxy only takes effect after the unit.
Example:
IPC>sip proxy port 5060
user
Sets the username of the SIP proxy.
Syntax:
sip proxy user <name>
Syntax Description:
Part
Description
name
The username of the SIP proxy.
Defaults:
No default value.
Location in Hierarchy:
Belongs to the proxy subset of the SIP Commands (sip proxy).
Command Mode:
Privileged.
Note
Changing the username of the SIP proxy only takes effect after restarting the
unit.
Example:
IPC>sip proxy user johndoe
psw
Sets the password of the SIP proxy account.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-73
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Syntax:
sip proxy psw <password>
Syntax Description:
Part
Description
password
The password of the SIP proxy account.
Defaults:
No default value.
Location in Hierarchy:
Belongs to the proxy subset of the SIP Commands (sip proxy).
Command Mode:
Privileged.
Note
Changing the password of the SIP proxy only takes effect after restarting the
unit.
Example:
IPC>sip proxy psw p3Rdew
show
Displays the current SIP settings.
Syntax:
sip show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the SIP Commands (sip).
Command Mode:
User.
Example:
IPC>sip show
SIP gateway is behind NAT - Yes
SIP invite timeout - 3 sec
SIP proxy IP address - 88.153.44.183
SIP proxy port - None
SIP redirect URI - None
SIP proxy registration enable - No
3-74
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
SIP proxy registration expiration time - 86400
SIP proxy registration URL - empty
SIP proxy registration field FROM - empty
SIP proxy registration field TO - empty
National format enable - No
Treat SIP proxy user name - 9991212
SIP external ip address - 88.152.117.102
Registration on the SIP Proxy server
Enables/disables registration to SIP Proxy server.
Syntax:
sip reg_en < y | n >
Syntax Description:
Part
Description
n
Keyword to disable Registration on the SIP Proxy server.
y
Keyword to enable Registration on the SIP Proxy server.
Defaults:
Default setting is no.
Location in Hierarchy:
Belongs to SIP configuration commands.
Command Mode:
Privileged.
Example:
IPC>sip reg_en y
Registration on the SIP Proxy server expiration time
Configures expiration time for registration on the SIP Proxy.
Syntax:
sip reg_exp [value]
Syntax Description:
Part
Description
value
The variable in seconds. For sip registration time
expiration.
Defaults:
Default setting is 86400 (24 hours).
Location in Hierarchy:
Belongs to SIP configuration commands.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-75
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Command Mode:
Privileged.
Example:
IPC>sip reg_exp 180
SIP URL for SIP Registration
Configures SIP Proxy URL for registration on the SIP Proxy server.
Syntax:
sip reg_url [value]
Syntax Description:
Part
Description
value
URL of SIP proxy server.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to SIP configuration commands.
Command Mode:
Privileged.
Example:
IPC>sip reg_url sip_proxy.com
SIP Registration format, field “FROM”
Configures field “FROM” for SIP Registration.
Syntax:
sip reg_from [value]
Syntax Description:
Part
Description
value
Telephone number with proxy URL.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to SIP configuration commands.
Command Mode:
Privileged.
3-76
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Example:
IPC>sip reg_from 49991212@sip_proxy.com
SIP Registration format, field “TO”
Configures field “TO” for SIP Registration.
Syntax:
sip reg_to [value]
Syntax Description:
Part
Description
value
Telephone number with proxy URL.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to SIP configuration commands.
Command Mode:
Privileged.
Example:
IPC> sip reg_to 49991212@sip_proxy.com
National Format
Configures SIP Proxy Invite with the number that was dialed by the user without
any manipulation.
Syntax:
sip reg_national < y | n >
Syntax Description:
Part
Description
n
Keyword to disable National format.
y
Keyword to enable National format.
Defaults:
Default setting is n
Location in Hierarchy:
Belongs to SIP configuration commands.
Command Mode:
Privileged.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-77
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Example:
IPC> sip reg_national y
Phone Interface
The phone commands control the operation of the unit telephony ports.
Commands in this category:
Note
•
Trunk1
•
Trunk 2
•
Trunk 3
•
Trunk 4
•
Metering
•
Show
•
Hot-line
•
Call-waiting.
When the unit is a PRI device, the only commands are ‘show’ and ‘metering’.
Trunk1
Enables/disables the trunk 1 port.
Syntax:
phone trunk1 <yes | no>
Syntax Description:
Part
Description
yes
Keyword to enable the port.
no
Keyword to disable the port.
Defaults:
Default setting is yes.
Location in Hierarchy:
Belongs to the Phone Interface Commands (phone).
Command Mode:
Privileged.
Note
Changes to phone settings only take effect after restarting the unit.
Example:
IPC>phone trunk1 yes
3-78
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Trunk2
Enables/disables the trunk2 port.
Syntax:
phone trunk2 <yes | no>
Syntax Description:
Part
Description
yes
Keyword to enable the port.
no
Keyword to disable the port.
Defaults:
Default setting is yes.
Location in Hierarchy:
Belongs to the Phone Interface Commands (phone).
Command Mode:
Privileged.
Note
Changes to phone settings only take effect after restarting the unit.
Example:
IPC>phone trunk2 yes
Trunk3
Enables/disables the trunk3 port.
Syntax:
phone trunk3 <yes | no>
Syntax Description:
Part
Description
yes
Keyword to enable the port.
no
Keyword to disable the port.
Defaults:
Default setting is yes.
Location in Hierarchy:
Belongs to the Phone Interface Commands (phone).
Command Mode:
Privileged.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-79
Chapter 3 Using the Command Line Interface
Note
Installation and Operation Manual
Changes to phone settings only take effect after restarting the unit.
Example:
IPC>phone trunk3 yes
Trunk4
Enables/disables the trunk4 port.
Syntax:
phone trunk4 <yes | no>
Syntax Description:
Part
Description
yes
Keyword to enable the port.
no
Keyword to disable the port.
Defaults:
Default setting is yes.
Location in Hierarchy:
Belongs to the Phone Interface Commands (phone).
Command Mode:
Privileged.
Note
Changes to phone settings only take effect after restarting the unit.
Example:
IPC>phone trunk4 yes
Metering
This service enables to work with PBX’s that can create local billing according to
pulse counting. This section is valid for analog or digital units.
Commands in this category:
•
enable
•
show
•
isdn_aoc (for isdn only).
enable
Enables the metering service.
Syntax:
phone metering enable <y | n >
3-80
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Syntax Description:
Part
Description
yes
Keyword to enable the port.
no
Keyword to disable the port.
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the Phone Metering Commands.
Command Mode:
Privileged.
Example:
IPC>phone metering enable y
show
Displays Metering settings.
Syntax:
phone metering show
Syntax Description:
No arguments or keywords.
Location in Hierarchy:
Belongs to the Phone Metering Commands.
Command Mode:
Privileged.
Example:
IPC>phone metering show
Metering Profile
- 0x00, 0xFA, 0x80, 0x3F
Metering Enable
- Yes
isdn_aoc
Defines and configures ISDN and PRI Advice of Charge service.
Commands in this category:
•
show
•
aoc_mode
•
chrg_mode
•
curr_rate
•
aocs_enable
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-81
Chapter 3 Using the Command Line Interface
•
aocd_enable
•
aoce_enable
•
aocs_basic
•
aocs_attempt
•
aocs_setup.
Installation and Operation Manual
show
Displays Advice of Charge configuration.
Syntax:
phone metering isdn_aoc show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Phone Metering Commands.
Command Mode:
Privileged.
Example:
IPC>phone metering isdn_aoc show
===============
AOC Mode
- ETS300
ChargeMode
- units
CurrencyRate
- 5
AOCS Enable
- No
AOCD Enable
- Yes
AOCE Enable
- Yes
AOCS Basic
- 0
AOCS Attempt
- 0
AOCS Setup
- 0
aoc_mode
Defines AOC Mode.
Syntax:
phone metering isdn_aoc aoc_mode <e | c>
Syntax Description:
3-82
Part
Description
e
ETS300 – European Telecom standard.
c
Codeset6 – Italian Telecom standard.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Defaults:
Default setting is e (ETS300).
Location in Hierarchy:
Belongs to the Phone Metering ISDN AOC Commands.
Command Mode:
Privileged.
Example:
IPC>phone metering isdn_aoc aoc_mode e
chrg_mode
Defines Charge Mode.
Syntax:
phone metering isdn_aoc chrg_mode <c | u>
Syntax Description:
Part
Description
c
Currency.
u
unit – pulse counting.
Defaults:
Default setting is u (unit).
Location in Hierarchy:
Belongs to the Phone Metering ISDN AOC Commands.
Command Mode:
Privileged.
Example:
IPC>phone metering isdn_aoc chrg_mode u
curr_rate
Use this command to define currency to unit rate.
Syntax:
phone metering isdn_aoc curr_rate <value>
Syntax Description:
Part
Description
value
Number in cents.
Example: 5 = 0.05 € / $ per unit count.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-83
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Defaults:
Default setting is 5 (5 cents).
Location in Hierarchy:
Belongs to the Phone Metering ISDN AOC Commands.
Command Mode:
Privileged.
Example:
IPC>phone metering isdn_aoc curr_rate 10
aocs_enable
Enables Start currency definition.
Syntax:
phone metering isdn_aoc aocs_enable <y | n>
Syntax Description:
Part
Description
yes
Keyword to enable the port.
no
Keyword to disable the port.
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the Phone Metering ISDN AOC Commands.
Command Mode:
Privileged.
Example:
IPC>phone metering isdn_aoc aocs_enable y
aocd_enable
Enables During currency definition. “During”, enables to report the AOC status
during the phone conversation.
Syntax:
phone metering isdn_aoc aocd_enable <y | n>
Syntax Description:
3-84
Part
Description
yes
Keyword to enable the port.
no
Keyword to disable the port.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Defaults:
Default setting is y.
Location in Hierarchy:
Belongs to the Phone Metering ISDN AOC Commands.
Command Mode:
Privileged.
Example:
IPC>phone metering isdn_aoc aocd_enable y
aoce_enable
Enables End currency definition. “End”, enables to report the AOC status at the
End of the phone conversation.
Syntax:
phone metering isdn_aoc aoce_enable <y | n>
Syntax Description:
Part
Description
yes
Keyword to enable the port.
no
Keyword to disable the port.
Defaults:
Default setting is y.
Location in Hierarchy:
Belongs to the Phone Metering ISDN AOC Commands.
Command Mode:
Privileged.
Example:
IPC>phone metering isdn_aoc aoce_enable y
aocs_basic
Defines basic rate when aocs_enable is enable.
Syntax:
phone metering isdn_aoc aocs_basic <value>
Syntax Description:
Part
Description
value
Number in cents.
Example: 5 = 0.05 € / $ per unit count.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-85
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Defaults:
Default setting is 0.
Location in Hierarchy:
Belongs to the Phone Metering ISDN AOC Commands.
Command Mode:
Privileged.
Example:
IPC>phone metering isdn_aoc aocs_basic 10
aocs_attempt
Defines call attempt rate when aocs_enable is enable.
Syntax:
phone metering isdn_aoc aocs_attempt <value>
Syntax Description:
Part
Description
value
Number in cents.
Example: 5 = 0.05 € / $ per unit count.
Defaults:
Default setting is 0.
Location in Hierarchy:
Belongs to the Phone Metering ISDN AOC Commands.
Command Mode:
Privileged.
Example:
IPC>phone metering isdn_aoc aocs_attempt 10
aocs_setup
Defines call setup rate when aocs_setup is enable.
Syntax:
phone metering isdn_aoc aocs_setup <value>
Syntax Description:
Part
Description
value
Number in cents.
Example: 5 = 0.05 € / $ per unit count.
3-86
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Defaults:
Default setting is 0.
Location in Hierarchy:
Belongs to the Phone Metering ISDN AOC Commands.
Command Mode:
Privileged.
Example:
IPC>phone metering isdn_aoc aocs_setup 10
show
Displays information about the phone settings.
Syntax:
phone show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Phone Interface Commands (phone).
Command Mode:
User.
Note
The information is displayed in a table.
Example:
From analog unit:
IPC>phone show
Hot-Line - Disable
Hot-Line Timeout - 10
Call-Waiting - Enable
Port
Enable
============================
Trunk 1
Yes
Trunk 2
YES
#Idx
State
CallType
Duration
Codec
From/To
===============================================================
1
CONNECTED
>97249991212]
2
IDLE
IPVgate - 20x Ver. 2.4
Phone
0010
aLaw
T:[911940030-
Unit Command Line Interface (CLI)
3-87
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
From digital unit:
IPC>phone show
Port
Enable
============================
Trunk 1
Yes
Trunk 2
Yes
Trunk 3
Yes
Trunk 4
Yes
Trunk 5
Yes
Trunk 6
Yes
Trunk 7
Yes
Trunk 8
Yes
#Idx
State
CallType
Duration
Codec
From/To
===============================================================
1
CONNECTED
>97249991213]
2
IDLE
3
IDLE
4
IDLE
5
IDLE
6
IDLE
7
IDLE
8
IDLE
Phone
0012
G723H
T:[9991212-
Hot Line
Service discretion:
•
When picking up the handset without any dialing for a few seconds the
phone will dial automatically to a predefined number.
•
The service is available ONLY when using an analog unit.
Commands in this category:
•
enable
•
timeout.
enable
Enables the hot-line service.
Syntax:
phone hot-line enable <y | n >
Syntax Description:
3-88
Part
Description
yes
Keyword to enable the port.
no
Keyword to disable the port.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the Phone Hot-line Commands.
Command Mode:
Privileged.
Example:
IPC>phone hot-line enable y
timeout
Defines Hot-line timeout.
Syntax:
phone hot-line timeout
Syntax Description:
Part
Description
value
Time in seconds to define the off-hook time until the
predefined number will be dialed automatically.
Defaults:
Default setting is 10 sec.
Location in Hierarchy:
Belongs to the Phone Hot-line Commands.
Command Mode:
Privileged.
Example:
IPC>phone hot-line timeout 15
Call Waiting
Service discretion:
•
When a call is coming in and the line is busy with another call, the receiving
party will hear beeps of the second incoming call.
•
The service is available ONLY when using an analog unit.
Commands in this category:
•
enable.
enable
Enables the call-waiting service.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-89
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Syntax:
phone call-waiting enable <y | n >
Syntax Description:
Part
Description
yes
Keyword to enable the port.
no
Keyword to disable the port.
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the Phone Call-Waiting Commands.
Command Mode:
Privileged.
Example:
IPC>phone call-waiting enable y
Phone Number configuration
When defining one trunk as fax and all others as normal phones, it is
recommended to define the fax number for the designated trunk which contains
the fax number. The following command defines that requirement.
Trunk Number configuration
Configures trunk telephone number.
Syntax:
fs iniws PhoneDevice1 TelNum < value >
Syntax Description:
Part
Description
value
Telephone number, international format.
*
Allow the entire numbers range.
Defaults:
No default settings.
Location in Hierarchy:
Inserts the parameter directly to configuration file.
Command Mode:
Privileged.
3-90
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Note
Chapter 3 Using the Command Line Interface
When PhoneDeviceX is not configured, the default configuration is <*>.
Not supported by command completion.
Example:
IPC> fs iniws PhoneDevice1 TelNum 97249991210,*
IPC> fs iniws PhoneDevice4 TelNum 97249991213
IP Filter Settings
The unit can use filters to control the flow of data through it ports by allowing or
denying access to certain IP addresses, protocols and/or ports. The ipfilter
commands control the creation and maintenance of the units' IP filter settings.
Commands in this category:
•
show
•
permit
•
add
•
del
•
trace.
show
Displays information about the IP Filter settings.
Syntax:
ipfilter show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the IP Filter Commands (ipfilter).
Command Mode:
User.
Note
Each rule is assigned an index number. This number is needed when deleting a
rule (see del on page 3-94).
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-91
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Example:
IPC>ipfilter show
Permission: All
Index Record
=====================================================
1
Deny, Any, <->, Any, 23-34:45-76:77, ICMP:3-13
2
Deny, Any, <->, localhost, Any, ICMP
3
Deny, Any, <->, localhost, Any, Any
permit
Changes the global permission rule. This rule determines which IP filters are
implemented or not.
Syntax:
ipfilter permit <all | none>
Syntax Description:
Part
Description
all
Keyword to implement the IP filters set with deny (see
add on page 3-92). All other traffic is allowed.
none
Keyword to implement the IP filters set with allow (see
add on page 3-92). All other traffic is denied.
Defaults:
Default setting is all.
Location in Hierarchy:
Belongs to the IP Filter Commands (ipfilter).
Command Mode:
Privileged.
Example:
IPC>ipfilter permit none
add
Adds a new IP filter rule. It is very important to organize and plan the filters
before input. Unit applies the filters in sequential order until it finds a filter it can
apply. The only way to rearrange the order of the filters once inputted, is to
delete them all and start again.
Syntax:
ipfilter add
<permission>,<net1>,<direction>,<net2>,[port],[protocol]
3-92
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Syntax Description:
Part
Description
permission
Keyword to set the filter permission type as either allow
or deny.
Filters set as type allow are implemented when the global
permission rule is set to none (see permit on page 3-92).
Filters set as type deny are implemented when the global
permission rule is set to all (see permit on page 3-92).
net1
The IP address and network mask of the 1st network, in
the format IP/mask - or the keyword localhost to specify
the unit. Use the keyword any to specify all IP addresses.
direction
Keyword to specify the direction of traffic on which to
apply the filter:
Use:
<- to filter traffic sent by net2 to net1.
-> to filter traffic sent by net1 to net2.
<-> to filter all traffic between net1 and net2.
net2
The IP address and network mask of the 2nd network in
the format IP/mask - or the keyword localhost to specify
the unit. Use the keyword any to specify all IP addresses.
port
Optional argument specifying the port number to filter.
A range of port numbers may be used, for example 2-17.
Multiple parameters are supported as long as they are
separated with colons (:), for example 2:14:16.
If this argument is not specified then all ports are filtered.
protocol
Optional argument specifying the protocol type to filter.
Use the keyword TCP, ICMP, UDP or IGMP, or the protocol
number.
A range of protocol numbers may be specified, for
example 1-4.
Multiple parameters are supported as long as they are
separated with colons (:), for example TCP:UDP:3:6.
If this argument is not specified then all protocols are
filtered.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the IP Filter Commands (ipfilter).
Command Mode:
Privileged.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-93
Chapter 3 Using the Command Line Interface
Note
Installation and Operation Manual
• All the arguments are separated by commas (,) with no spacing on either side
of the comma.
• It is possible to omit the port argument and still use the protocol argument. In
this case it is important that the comma still appears (see the second example
below).
• If both optional arguments are omitted then the commas may be omitted for
these arguments as well (see the third example below).
Examples:
IPC>ipfilter add deny,any,<->,any,23-34:45-76:78,TCP:ICMP:3-13
IPC>ipfilter add deny,any,<-,23.45.73.212/255.255.255.2,,ICMP
IPC>ipfilter add allow,localhost,->,any
del
Removes a specific IP filter rule according to its sequence number.
Syntax:
ipfilter del <sequence number>
Syntax Description:
Part
Description
sequence number
The number of the rule to remove.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the IP Filter Commands (ipfilter).
Command Mode:
Privileged.
Note
First use the show (on page 3-91) command to identify the number of the rule
you want to remove.
Example:
IPC>ipfilter del 2
trace
Enables IP filter tracing. The IP filter tracing is printed to the console as the filter
rules are applied.
Syntax:
ipfilter trace <on | off>
3-94
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Syntax Description:
Part
Description
on
Keyword to enable IP filter tracing.
off
Keyword to disable IP filter tracing.
Defaults:
Default setting is off.
Location in Hierarchy:
Belongs to the IP Filter Commands (ipfilter).
Command Mode:
Privileged.
Note
Enabling/disabling IP filter tracing on the unit only takes effect after restarting
the unit.
Example:
IPC>ipfilter trace on
DMZ Settings
Commands in this category:
•
show
•
add
•
del.
show
Displays information about the DMZ settings.
Syntax:
dmz show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DMZ Settings Commands (dmz).
Command Mode:
User.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-95
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Example:
IPC>dmz show
Host1: 192.18.05.1
Host2: 192.18.05.2
Host3: 192.18.05.3
add
Adds a new IP address to the DMZ.
Syntax:
dmz add <ip>
Syntax Description:
Part
Description
ip
The IP address to add to the DMZ.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DMZ Settings Commands (dmz).
Command Mode:
Privileged.
Example:
IPC>dmz add 77.63.213.22
del
Removes an IP address from the DMZ.
Syntax:
dmz del <ip>
Syntax Description:
Part
Description
ip
The IP address to add to the DMZ.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the DMZ Settings Commands (dmz).
Command Mode:
Privileged.
3-96
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Note
Chapter 3 Using the Command Line Interface
It is advisable to first verify the existing IP addresses using show (on page 3-95).
Example:
IPC>dmz del 77.63.213.22
VPN Settings
The unit VPN (Virtual Private Network) is based on the IPSec protocol with key
exchange and secure authentication by IKE. The vpn commands control the
creation and maintenance of the units' Virtual Private Network.
Commands in this category:
•
enable
•
ipsec
•
isakmp
•
advanced
•
phase_2
•
dns_bypass.
enable
Enables VPN on the unit.
Syntax:
vpn enable <y | n>
Syntax Description:
Part
Description
y
Keyword to enable VPN.
n
Keyword to disable VPN.
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the VPM Settings Commands (vpn).
Command Mode:
Privileged.
Note
Enabling/disabling VPN on the unit only takes effect after restarting the unit.
Example:
IPC>vpn enable y
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-97
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Ipsec
Commands in this category:
•
show
•
mode
•
add_policy
•
del_policy
•
trace.
show
Displays the IP Security settings.
Syntax:
vpn ipsec show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the ipsec subset of the VPN Settings Commands (vpn ipsec).
Command Mode:
User.
Note
Each policy is assigned an index number. This number is needed when deleting a
policy (see del_policy on page 3-100).
Example:
IPC>vpn ipsec show
VPN enable: YES
Ipsec mode: tunnel
Index Policy records
=============================================================
1
localhost,12.18.0.32/255.255.0.0,Any,Any,Any,12.18.0.32
mode
Sets the IPSec mode of authentication for all VPN connections.
Syntax:
vpn ipsec mode <transport | tunnel>
3-98
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Syntax Description:
Part
Description
transport
Keyword to set data only authentication.
tunnel
Keyword to set data and header authentication.
Defaults:
Default setting is tunnel.
Location in Hierarchy:
Belongs to the ipsec subset of the VPN Settings Commands (vpn ipsec).
Command Mode:
Privileged.
Note
• The unit can work in either tunnel or transport mode for all VPN connections.
There is no possibility to configure one VPN connection to be in tunnel mode
and another one in transport mode.
• Changing the IPSec mode only takes effect after restarting the unit.
Example:
IPC>vpn ipsec mode transport
add_policy
Adds an IPSec policy (VPN connection).
Syntax:
vpn ipsec add_policy
<ip1/mask>,<ip2/mask>,<prot>,<port1>,<port2>,<gtw>
Syntax Description:
Part
Description
ip1/mask
The IP address and network mask of the source of the
connection - or the keyword localhost for the unit.
ip2/mask
The IP address and network mask of the destination of
the connection - or the keyword localhost for the unit.
prot
The protocol type number - or the keyword any for all
protocol types.
port1
The port number of the source of the connection - or the
keyword any for all ports.
port2
The port number of the destination of the connection - or
the keyword any for all ports.
gtw
The default gateway or tunnel endpoint of the
connection.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-99
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the ipsec subset of the VPN Settings Commands (vpn ipsec).
Command Mode:
Privileged.
Note
• All the arguments are separated by commas (,) with no spacing on either side
of the comma.
• Up to 10 VPN connections are supported by the unit.
• Adding a new IPSec policy only takes effect after restarting the unit.
Example:
IPC>vpn ipsec add_policy
localhost,12.1.0.3/255.255.0.0,Any,Any,Any,12.1.0.3
del_policy
Removes an IPSec policy according to its sequence number.
Syntax:
vpn ipsec del_policy <sequence number>
Syntax Description:
Part
Description
sequence number
The number of the policy to remove.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the ipsec subset of the VPN Settings Commands (vpn ipsec).
Command Mode:
Privileged.
Note
• First use the show (on page 3-98) command to identify the number of the
policy you want to remove.
• Removing an IPSec policy only takes effect after restarting the unit.
Example:
IPC>vpn ipsec del_policy 1
trace
Enables IPSec tracing. The IPSec tracing is printed to the console.
3-100
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Syntax:
vpn ipsec trace <on | off>
Syntax Description:
Part
Description
on
Keyword to enable IPSec tracing.
off
Keyword to disable IPSec tracing.
Defaults:
Default setting is off.
Location in Hierarchy:
Belongs to the ipsec subset of the VPN Settings Commands (vpn ipsec).
Command Mode:
Privileged.
Note
Enabling/disabling IPSec tracing on the unit only takes effect after restarting the
unit.
Example:
IPC>vpn ipsec trace on
Isakmp
Commands in this category:
•
show
•
retransmit
•
timeout
•
add_secret
•
del_secret
•
trace.
show
Displays the IKE/ISAKMP settings.
Syntax:
vpn isakmp show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-101
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Location in Hierarchy:
Belongs to the isakmp subset of the VPN Settings Commands (vpn isakmp).
Command Mode:
User.
Note
Each secret is assigned an index number. This number is needed when deleting a
secret (see del_secret on page 3-104).
Example:
IPC>vpn isakmp show
Retransmit: 5
Timeout:
8(sec)
Index
Secret key records
===================================
1
192.168.0.181,itsasecret1
2
192.168.0.132,itsasecret2
3
192.168.0.32,itsasecret3
retransmit
Sets the retransmit counter. This is the number of times that the unit will
attempt to retransmit data before aborting.
Syntax:
vpn isakmp retransmit <number>
Syntax Description:
Part
Description
number
The number of times unit will attempt to transmit the
data.
Defaults:
Default setting is 5.
Location in Hierarchy:
Belongs to the isakmp subset of the VPN Settings Commands (vpn isakmp).
Command Mode:
Privileged.
Note
• The maximum value of this setting is 5.
• Changing the retransmit number only takes effect after restarting the unit.
Example:
IPC>vpn isakmp retransmit 3
3-102
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
timeout
Sets the timeout counter. This is the number of seconds that the unit will wait
between attempts to retransmit data.
Syntax:
vpn isakmp timeout <seconds>
Syntax Description:
Part
Description
seconds
The number of seconds the unit will wait between
attempts to retransmit the data.
Defaults:
Default setting is 8.
Location in Hierarchy:
Belongs to the isakmp subset of the VPN Settings Commands (vpn isakmp).
Command Mode:
Privileged.
Note
• The maximum value of this setting is 10.
• Changing the timeout value only takes effect after restarting the unit.
Example:
IPC>vpn isakmp timeout 6
add_secret
Adds a secret key.
Syntax:
vpn isakmp add_secret <IP Address>,<secret>
Syntax Description:
Part
Description
IP Address
The IP Address of the secret key.
secret
A string representing the secret key.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the isakmp subset of the VPN Settings Commands (vpn isakmp).
Command Mode:
Privileged.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-103
Chapter 3 Using the Command Line Interface
Note
Installation and Operation Manual
• The arguments are seperated by a comma (,) with no spacing on either side of
the comma.
• The maximum length of the secret key is 128 characters
• Adding a secret key only takes effect after restarting the unit.
Example:
IPC>vpn isakmp add_secret 23.76.52.111,asecretkeyexample
del_secret
Removes a secret key according to its sequence number.
Syntax:
vpn isakmp del_secret <sequence number>
Syntax Description:
Part
Description
sequence number
The sequence number of the secret key to remove.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the isakmp subset of the VPN Settings Commands (vpn isakmp).
Command Mode:
Privileged.
Note
• First use the show (on page 3-101) command to identify the sequence
number of the secret key that you want to remove.
• Removing a secret key only takes effect after restarting the unit.
Example:
IPC>vpn isakmp del_secret 2
trace
Enables IKE/ISAKMP tracing. The IKE/ISAKMP tracing is printed to the console.
Syntax:
vpn isakmp trace <on | off>
Syntax Description:
3-104
Part
Description
on
Keyword to enable IPSec tracing.
off
Keyword to disable IPSec tracing.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Defaults:
Default setting is off.
Location in Hierarchy:
Belongs to the isakmp subset of the VPN Settings Commands (vpn isakmp).
Command Mode:
Privileged.
Note
Enabling/disabling IKE/ISAKMP tracing on the unit only takes effect after
restarting the unit.
Example:
IPC>vpn isakmp trace on
advanced
Use these commands to control the advanced settings for IPSEC/IKE
Commands in this category:
•
show
•
phase_1
•
phase_2.
show
Displays the advanced settings.
Syntax:
vpn advanced show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the advanced subset of the VPN Settings Commands (vpn advanced).
Command Mode:
User.
Example:
IPC>vpn advanced show
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-105
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
phase_1
Commands in this category:
•
life_time_sec
•
life_time_kb
•
trans_set.
life_time_sec
Sets the lifetime of the connection in seconds.
Syntax:
vpn advanced phase_1 life_time_sec <value>
Syntax Description:
Part
Description
value
The lifetime of the connection in seconds.
Defaults:
Default setting is 1800.
Location in Hierarchy:
Belongs to the advanced phase_1 subset of the VPN Settings Commands (vpn
advanced phase_1).
Command Mode:
Privileged.
Example:
IPC>vpn advanced phase_1 life_time_sec 1000
life_time_kbytes
Use this command to set the lifetime of the connection in kilobytes.
Syntax:
vpn advanced phase_1 life_time_kbytes <value>
Syntax Description:
Part
Description
value
The lifetime of the connection in kilobytes.
Defaults:
Default setting is 10240.
3-106
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Location in Hierarchy:
Belongs to the advanced phase_1 subset of the VPN Settings Commands (vpn
advanced phase_1).
Command Mode:
Privileged.
Example:
IPC>vpn advanced phase_1 life_time_kbytes 10000
trans_set
Sets the available transform set (encryption) of the connection. The individual
encryption transforms in the set are separated by commas.
Syntax:
vpn advanced phase_1 trans_set <value>
Syntax Description:
Part
Description
value
The transform set to be used for the connection, or the
keyword default.
Defaults:
Default setting is default.
Location in Hierarchy:
Belongs to the advanced phase_1 subset of the VPN Settings Commands (vpn
advanced phase_1).
Command Mode:
Privileged.
Note
The order that the transforms are entered is important. unit attempts to use the
transforms in the order presented.
Example:
IPC>vpn advanced phase_1 trans_set 3des-sha,3des-md5
phase_2
Commands in this category:
•
life_time_sec
•
life_time_kb
•
trans_set_esp
•
trans_set_ah
•
Inactivity.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-107
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
life_time_sec
Sets the lifetime of the connection in seconds.
Syntax:
vpn advanced phase_2 life_time_sec <value>
Syntax Description:
Part
Description
value
The lifetime of the connection in seconds.
Defaults:
Default setting is 3600.
Location in Hierarchy:
Belongs to the advanced phase_2 subset of the VPN Settings Commands (vpn
advanced phase_2).
Command Mode:
Privileged.
Example:
IPC>vpn advanced phase_2 life_time_sec 1000
life_time_kbytes
Sets the lifetime of the connection in kilobytes.
Syntax:
vpn advanced phase_2 life_time_kbytes <value>
Syntax Description:
Part
Description
value
The lifetime of the connection in kilobytes.
Defaults:
Default setting is 51200.
Location in Hierarchy:
This command belongs to the advanced phase_2 subset of the VPN Settings
Commands (vpn advanced phase_2).
Command Mode:
Privileged.
Example:
IPC>vpn advanced phase_2 life_time_kbytes 30000
3-108
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
trans_set_esp
Sets the available transform set (encryption) of the Encapsulated Security
Protocol. The individual encryption transforms in the set are separated by
commas.
Syntax:
vpn advanced phase_2 trans_set_esp <value>
Syntax Description:
Part
Description
value
The transform set to be used for the Encapsulated
Security Protocol, or use the keyword default.
Defaults:
Default setting is default.
Location in Hierarchy:
Belongs to the advanced phase_2 subset of the VPN Settings Commands (vpn
advanced phase_2).
Command Mode:
Privileged.
Note
The order that the transforms are entered is important. unit attempts to use the
transforms in the order presented.
Example:
IPC>vpn advanced phase_2 trans_set_esp 3des-sha,3des-md5
trans_set_ah
Sets the available transform set (encryption) of the Authentication Header. The
individual encryption transforms in the set are separated by commas.
Syntax:
vpn advanced phase_2 trans_set_ah <value>
Syntax Description:
Part
Description
value
The transform set to be used for encrypting the
Authentication Header, or uses the keyword default.
Defaults:
Default setting is default.
Location in Hierarchy:
Belongs to the advanced phase_2 subset of the VPN Settings Commands (vpn
advanced phase_2).
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-109
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Command Mode:
Privileged.
Note
The order that the transforms are entered is important. unit attempts to use the
transforms in the order presented.
Example:
IPC>vpn advanced phase_2 trans_set_ah 3des-sha,3des-md5
inactivity
Sets inactivity detection of the VPN tunnel.
Syntax:
vpn advanced phase_2 inactivity <time(seconds)| 0>
Syntax Description:
Part
Description
time
Set the time for inactivity detection in seconds.
0
For none
Defaults:
Default setting is none (0).
Location in Hierarchy:
Belongs to the advanced phase_2 subset of the VPN Settings Commands (vpn
advanced phase_2).
Command Mode:
Privileged.
Example:
IPC>vpn advanced phase_2 inactivity 180
dns_bypass
Defines that the DNS packets path will be out of the VPN tunnel.
Syntax:
vpn dns_bypass <y | n>
Syntax Description:
3-110
Part
Description
y
Keyword to activate the command.
n
Keyword to deactivate the command.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the VPN Settings Commands (vpn).
Command Mode:
Privileged.
Example:
IPC>vpn dns_bypass y
Time
Displays the current time and date, and the amount of time the unit has been
used.
Syntax:
time
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Root command.
Command Mode:
User.
Example:
Current time: WED DEC 27 13:04:49 2006
IPCenter(TM) has been used for 70 hours and 58 minutes.
Last wake up status is: 3.
Version Commands
Commands in this category:
•
show
•
upgrade.
show
Shows which software version is running on the unit.
Syntax:
Version show
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-111
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Version Commands (version).
Command Mode:
User.
Example:
IPC>version show
upgrade
Upgrades the software running on the unit.
Syntax:
Version upgrade
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the Version Commands (version).
Command Mode:
Privileged.
Note
• The location of the ftp server is set with ipcfg ftpip (see page 3-27).
• The name of the new file is set with ipcfg ftpfile (see page 3-27).
Example:
IPC>version upgrade
ATM Settings
The ATM settings enables to configure and define the ATM connection.
Commands in this category:
3-112
•
show
•
add
•
del
•
stat.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
show
Shows the ATM configuration.
Syntax:
atm show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the ATM Commands.
Command Mode:
User.
Example:
IPC>atm show
ATM if:
VPI,VCI,LLC/VC,ENCAP,CLASS,PCR,IP_ADDRESS,IP_MASK,IP_GTW
===============================================================
#1:
8,48,LLC,PPPOA,UBR,0,Automatic,N/A,N/A
#2:
not_assign
#3:
not_assign
#4:
not_assign
add
Adds an ATM connection.
Syntax:
Atm add <value>
<VPI,VCI,LLC|VC,PPPOE|PPPoA|ROUTED,UBR|CBR,PCR,IP_ADD
R, IP_MASK,IP_GTW>
Syntax Description:
Part
Description
value
Number of connection <1-4>.
VPI
Virtual Path Identifier-<value> according to the provider’s
defaults.
VCI
Virtual Channel Identifier-<value> according to the
provider’s defaults.
LLC
Multiplexing type LLC.
VC
Multiplexing type VC.
PPPoA
Connection type – Point to Point Protocol over ATM.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-113
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Part
Description
PPPoEoA
Connection type – Point to Point Protocol over Ethernet
over ATM PPP oATM.
Routed
Connection type Routed mode, RFC 1483.
UBR
ATM QoS type – UBR, doesn’t guarantee bandwidth
availability .
CBR
ATM QoS type – CBR.
PCR
Pick Cell Rate. Defined when ATM QoS type is CBR. <020000>.
IP_ADDR
IP Address when the connection type is routed.
IP_MASK
Mask, when the connection type is routed.
IP_GTW
Default GW IP Address when the connection type is
routed.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the ATM Command (atm).
Command Mode:
Privileged.
Note
Adding an ATM connection takes effect only after restarting the unit.
Example:
IPC>atm add 1 8,48,LLC,PPPOA,UBR,0
del
Deletes an ATM connection.
Syntax:
Atm add <value>
Syntax Description:
Part
Description
value
Number of connection <1-4>.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the ATM Command (atm).
3-114
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Command Mode:
Privileged.
Note
Removing an ATM connection takes effect only after restarting the unit.
Example:
IPC>atm del 2
stat
Prints the ATM connections status.
Syntax:
atm stat
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the ATM Commands.
Command Mode:
User.
Example:
IPC>atm stat
ATM Device 0:
------------------------------------RX errors:
unknown_ci
120
bad_hec
0
aal5_abt
0
aal5_bad_len
932
bad_crc32
8
bad_crc10
0
clp_set
881272
charge_failed
0
skb_dropped
1060
large_skb_missed_last
180
large_skb_missed_first
37
large_skb_missed_mid
0
large_skb_too_big
212
large_skb_bad_sz
0
large_skb_charge_failed 0
large_skb_drop
429
bsy
1
General errors:
intr_q_ov
0
reset_channel
0
APC Overflows:
CBR Ring: 0
UBR Ring: 0
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-115
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
ADSL Settings
The ISDN Configuration settings control how the BRI/PRI interfaces are connected
and its various functions.
Commands in this category:
•
show
•
stat
•
reconnect
•
mode
•
event.
show
Shows the ADSL configuration.
Syntax:
adsl show
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the ADSL Commands.
Command Mode:
User.
Example:
IPC>adsl show
Configuration settings:
----------------------ADSL sub function code:
ADSL line open mode:
ADSL status:
-----------ADSL line status:
ADSL firmware version:
ADSL sub-function:
ADSL line mode:
ADSL downstream F:
ADSL downstream I:
ADSL upstream F:
ADSL upstream I:
ADSL frame transmited F:
ADSL frame transmited I:
ADSL frame received F:
ADSL frame received I:
3-116
Unit Command Line Interface (CLI)
0xa0
G.dmt
Active
13.10.5
0xa0
G.dmt
6208 Kbps
0 Kbps
320 Kbps
0 Kbps
3497073
0
31568801
0
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
stat
Prints ADSL connections status.
Syntax:
adsl stat
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the ADSL Commands.
Command Mode:
User.
Example:
IPC>adsl stat
Near line data
-------------Capacity Occup Dnstr:
Noise Margin Dnstr:
Output Power Upstr:
Attenuation Dnstr:
63
22
23
22
%
dB
dBm
dB
Far line data
------------Capacity Occup Upstr:
Noise Margin Upstr:
Output Power Dnstr:
Attenuation Upstr:
36
31
40
24
%
dB
dBm
dB
Near performance data
--------------------Near end fec non-int:
Near end fec int:
Near end crc non-int:
Near end crc int:
Near end hec non-int:
Near end hec int:
0
0
9
0
8
0
Far performance data
-------------------Far end fec non-int:
Far end fec int:
Far end crc non-int:
Far end crc int:
Far end hec non-int:
Far end hec int:
0
0
4
0
1
0
Near ITU identification:
N/A
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-117
Chapter 3 Using the Command Line Interface
Far
Installation and Operation Manual
ITU identification:
Far carrier load:
00 00 00 00 00
00 00 00 44 44
90 99 99 99 99
99 99 99 99 99
99 99 99 99 99
99 99 99 89 99
88 88 88 88 88
88 88 88 88 77
32
55
99
99
99
89
88
77
44
65
99
99
99
88
88
55
N/A
55
66
99
99
99
98
88
45
66
77
99
99
99
98
88
24
66
77
99
99
99
98
88
02
66
87
99
99
99
99
88
00
66
88
99
99
99
88
88
00
56
88
99
99
99
88
88
00
55
88
99
99
99
88
88
00
55
88
29
99
99
88
88
00
00
88
99
99
99
88
88
00
reconnect
Reconnects the ADSL connection.
Syntax:
adsl reconnect
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the ADSL Commands.
Command Mode:
Privilege.
Example:
IPC>adsl reconnect
mode
Changes the ADSL mode of connection.
Syntax:
adsl mode <G.dmt | G.lite>
Syntax Description:
Part
Description
G.dmt
G.dmt mode.
G.lite
G.lite mode.
Defaults:
Default value is G.dmt.
Location in Hierarchy:
Belongs to the ADSL Command (adsl).
3-118
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Command Mode:
Privileged.
Note
Changing ADSL connection mode takes effect only after restarting the unit.
Example:
IPC>adsl mode g.lite
event
Defines the time interval for reporting the IPVsuite with the ADSL status.
Syntax:
adsl event <time>
Syntax Description:
Part
Description
time
In hours.
Defaults:
Default value is 0.
Location in Hierarchy:
Belongs to the ADSL Command (adsl).
Command Mode:
Privileged.
Note
Changing ADSL event time takes effect only after restarting the unit.
Example:
IPC>adsl event 2
ISDN Configuration Commands
The ISDN Configuration settings control how the BRI/PRI interfaces are connected
and its various functions.
Commands in this category:
•
show
•
bri1
•
bri2
•
pri
•
line_in
•
termination.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-119
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
show
Shows ISDN/BRI configuration status.
Syntax:
isdn show
Defaults:
No default settings.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (isdn).
Command Mode:
User.
Note
Note
The unit/PowerGateD2+ has 2 BRI interfaces that can be configured.
Example:
LINE_IN
==========
Status:
Enable:
Type:
TEI0:
Internal Clock
YES
TE
Auto
BRI1
==========
Status:
Enable:
Type:
TEI0:
BRI2
==========
Status:
Enable:
Type:
TEI0:
ETSI
Line active
Yes
nt
Auto
Protocol:
TEI1:
ETSI
1
Line active
Yes
NT
Auto
Protocol:
TEI1:
ETSI
1
IPCenter/PowerGateD4+ has 4 BRI interfaces that can be configured.
Example:
LINE_IN
==========
Status:
Enable:
Type:
TEI0:
3-120
Protocol:
Internal Clock
YES
TE
Auto
Unit Command Line Interface (CLI)
Protocol:
ETSI
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
BRI1
==========
Status:
Enable:
Type:
TEI0:
Line active
Yes
nt
Auto
Protocol:
TEI1:
ETSI
1
BRI2
==========
Status:
Enable:
Type:
TEI0:
Line active
Yes
NT
Auto
Protocol:
TEI1:
ETSI
1
BRI3
==========
Status:
Enable:
Type:
TEI0:
Line not active
Yes
NT
0
Protocol:
TEI1:
ETSI
Auto
BRI4
==========
Status:
Enable:
Type:
TEI0:
Line not active
Yes
NT
0
Protocol:
TEI1:
ETSI
Auto
Bri1
Configures BRI1 interfaces settings.
Commands in this category:
•
tei0
•
tei1
•
strip_digit.
tei0
Sets the terminal equipment addresses of the first device.
Syntax:
isdn bri1 tei0 <0-63 | auto>
Syntax Description:
Part
Description
0-63
Static assignment of address to the terminal equipment
device. 64 addresses in the pool.
Auto
Automatic assignment of address to the terminal
equipment devices.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-121
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Defaults:
Default setting is Auto.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (bri1).
Command Mode:
Privileged.
Example:
IPC>isdn bri1 tei0 0
tei1
Sets the terminal equipment addresses of the first device.
Syntax:
isdn bri1 tei1 <0-63 | auto>
Syntax Description:
Part
Description
0-63
Static assignment of address to the terminal equipment
device. 64 addresses in the pool.
Auto
Automatic assignment of address to the terminal
equipment devices.
Defaults:
Default setting is Auto.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (bri1).
Command Mode:
Privileged.
Example:
IPC>isdn bri1 tei1 0
strip_digit
Defines the number of digits to strip when sending the phone number to the PBX.
Syntax:
isdn bri1 strip_digit <value>
Syntax Description:
3-122
Part
Description
value
Number of digits to strip when sending the phone number
to the PBX.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Defaults:
Default setting is 0.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (bri1).
Command Mode:
Privileged.
Example:
IPC>isdn bri1 strip_digit 3
Bri2
Configures BRI2 interfaces settings.
Commands in this category:
•
enable
•
tei0
•
tei1
•
strip_digit.
enable
Enables/disables bri2 interface.
Syntax:
isdn bri2 enable <y | n>
Syntax Description:
Part
Description
y
Keyword to activate the command.
n
Keyword to deactivate the command
Defaults:
Default setting is y.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (bri1).
Command Mode:
Privileged.
Note
Enabling/disabling BRI2 on the unit only takes effect after restarting the unit.
Example:
IPC>isdn bri2 enable y
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-123
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
tei0
Sets the terminal equipment addresses of the first device.
Syntax:
isdn bri2 tei0 <0-63 | auto>
Syntax Description:
Part
Description
0-63
Static assignment of address to the terminal equipment
device. 64 addresses in the pool.
Auto
Automatic assignment of address to the terminal
equipment devices.
Defaults:
Default setting is Auto.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (bri1).
Command Mode:
Privileged.
Note
Setting up TEI0 address on the unit takes effect only after the unit.
Example:
IPC>isdn bri2 tei0 0
tei1
Sets the terminal equipment addresses of the first device.
Syntax:
isdn bri2 tei1 <0-63 | auto>
Syntax Description:
Part
Description
0-63
Static assignment of address to the terminal equipment
device. 64 addresses in the pool.
Auto
Automatic assignment of address to the terminal
equipment devices.
Defaults:
Default setting is Auto.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (bri1).
3-124
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Command Mode:
Privileged.
Note
Setting up TEI1 on the unit takes effect only after restarting the unit.
Example:
IPC>isdn bri2 tei1 0
strip_digit
Defines the number of digits to strip when sending the phone number to the
PBX.
Syntax:
isdn bri2 strip_digit <value>
Syntax Description:
Part
Description
value
Number of digits to strip when sending the phone number
to the PBX.
Defaults:
Default setting is 0.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (bri1).
Command Mode:
Privileged.
Example:
IPC>isdn bri2 strip_digit 3
Note
• Configuration of BRI3 and BRI4 is done in the same way.
• Definition of striping digits on the unit takes effect only after restarting the
unit.
PRI
Configures PRI interface settings.
Commands in this category:
•
pri_group
•
fraiming_crc
•
line_coding
•
strip_digit.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-125
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
pri_group
Defines number of channels.
Syntax:
isdn pri pri_group <<first channel> <last channel> | default>>
Syntax Description:
Part
Description
value
Group of activated channels (0-30).
Defaults:
Default setting is 1-31.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (pri).
Command Mode:
Privileged.
Note
Group definition on E1 unit takes effect only after restarting the unit.
Example:
IPC>isdn pri pri_group 0 15
fraiming_crc
Enables Framing CRC..
Syntax:
isdn pri fraiming_crc <y | n>
Syntax Description:
Part
Description
y
Keyword to activate the command.
n
Keyword to deactivate the command.
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (pri).
Command Mode:
Privileged.
Note
3-126
Framing CRC enable on the unit takes effect only after restarting the unit.
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Example:
IPC>isdn pri fraiming_crc y
line_coding
Defines Line coding.
Syntax:
isdn pri line_coding <hdb3 | ami | default>
Syntax Description:
Part
Description
hdb3
HDB3 code.
ami
AMI code.
Defaults:
Default setting is hdb3.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (pri).
Command Mode:
Privileged.
Note
Setting up line coding on the unit takes effect only after restarting the unit.
Example:
IPC>isdn pri line_coding hdb3
strip_digit
Defines the number of digits to strip when sending the phone number to the
PBX.
Syntax:
isdn pri strip_digit <value>
Syntax Description:
Part
Description
value
Number of digits to strip when sending the phone number
to the PBX.
Defaults:
Default setting is 0.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (bri1).
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-127
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Command Mode:
Privileged.
Note
Setting up PRI strip digit on the unit takes effect only after restarting the unit.
Example:
IPC>isdn pri strip_digit 3
Line_in
Configures PRI interface settings.
Commands in this category:
•
Enable (D2/4 only)
•
tei0 (D2/4 only)
•
type (D2/4 only)
•
pri_group (PRI only)
•
fraiming_crc (PRI only)
•
line_coding (PRI only.
enable
Enables/disables line in interface.
Syntax:
isdn line_in enable <y | n>
Syntax Description:
Part
Description
y
Keyword to activate the command.
n
Keyword to deactivate the command.
Defaults:
Default setting is y.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (line_in).
Command Mode:
Privileged.
Note
Enable/disable line in interface on the unit takes effect only after restarting the
unit.
Example:
IPC>isdn line_in enable y
3-128
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
tei0
Sets the terminal equipment addresses of the first device.
Syntax:
isdn line_in tei0 <0 | auto>
Syntax Description:
Part
Description
0
Point to point.
Auto
Point to multi point.
Defaults:
Default setting is Auto.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (line_in).
Command Mode:
Privileged.
Example:
IPC>isdn line_in tei0 0
type
Define type of Line-In interface.
Syntax:
isdn line_in type <te | sync>
Syntax Description:
Part
Description
te
TE – Terminal Equipment interface. When using line_in
interface as backup line to Telecom.
sync
Synchronization – to synchronize the internal unit isdn
clock with an external clock connected to line_in.
Defaults:
Default setting is TE.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (line_in).
Command Mode:
Privileged.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-129
Chapter 3 Using the Command Line Interface
Note
Installation and Operation Manual
Defining the line in interface on the unit takes effect only after the unit.
Example:
IPC>isdn line_in type te
pri_group
Defines the number of channels.
Syntax:
isdn pri pri_group <<first channel> <last channel> | default>>
Syntax Description:
Part
Description
value
Group of activated channels (1-31).
Defaults:
Default setting is 1-31.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (pri).
Command Mode:
Privileged.
Note
Defining number of channels on the E1 unit takes effect only after restarting the
unit.
Example:
IPC>isdn pri pri_group 0 15
fraiming_crc
Enables Framing CRC.
Syntax:
isdn pri fraiming_crc <y | n>
Syntax Description:
Part
Description
y
Keyword to activate the command.
n
Keyword to deactivate the command.
Defaults:
Default setting is n.
3-130
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (pri).
Command Mode:
Privileged.
Note
Defining framing crc on the unit takes effect only after restarting the unit.
Example:
IPC>isdn pri fraiming_crc y
line_coding
Defines Line coding.
Syntax:
isdn pri line_coding <hdb3 | ami | default>
Syntax Description:
Part
Description
hdb3
HDB3 code.
ami
AMI code.
Defaults:
Default setting is hdb3.
Location in Hierarchy:
Belongs to the ISDN Configuration Commands (pri).
Command Mode:
Privileged.
Note
Defining line coding on the unit takes effect only after restarting the unit.
Example:
IPC>isdn pri line_coding hdb3
termination
Defines PowerGate E1+ as termination gateway.
Syntax:
Isdn termination <y | n>
Syntax Description:
Part
Description
y
Keyword to define PowerGate E1+ as termination gateway.
n
Keyword to define PowerGate E1+ as CPE.
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-131
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Defaults:
Default setting is n.
Location in Hierarchy:
Belongs to the ISDN Settings Commands (isdn).
Command Mode:
Privileged.
Note
Enabling/disabling ISDN Termination on the unit only takes effect after restarting
the unit.
Example:
IPC>isdn termination y
Ping
Tests a connection by pinging a specific IP address.
Syntax:
ping <ip address>
Syntax Description:
Part
Description
ip address
The IP address to test.
Defaults:
No default settings.
Command Mode:
User.
Location in Hierarchy:
Root command.
Note
An IP alias or host name can be used instead of the actual IP address.
Example:
IPC>ping www.rad.com
Quit
Ends your session and terminates your connection to the unit.
3-132
Unit Command Line Interface (CLI)
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
Syntax:
quit
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Root command.
Command Mode:
User.
Example:
IPC>quit
Factory Default Settings
When there is a need to the unit back to factory defaults use the following
command ONLY from terminal.
Factory Defaults
Return to Factory defaults.
Syntax:
factory_default enter
Do you want set factory default?
< y | n >
Location in Hierarchy:
Root path.
Command Mode:
Privileged.
Note
• This command is valid and can be used ONLY when terminal is connected.
• The command creates an automatic restart.
Example:
IPC>factory_default
Do you want set factory default? y
Restart
Shuts down the system and does a warm boot.
Syntax:
restart
IPVgate - 20x Ver. 2.4
Unit Command Line Interface (CLI)
3-133
Chapter 3 Using the Command Line Interface
Installation and Operation Manual
Syntax Description:
No arguments or keywords.
Defaults:
No default settings.
Location in Hierarchy:
Root command.
Command Mode:
Privileged.
Example:
IPC>restart
3.4
Boot Commands
The boot commands are only available when using a serial connection to the unit.
To log on to the boot prompt, quickly press any key while the system is running
its auto-boot routine (after using the restart command or when connecting for
the first time).
Commands in this category:
•
p
•
c
•
ap
•
ac
•
b<x>
•
r.
p
Prints the boot parameters to the console.
Syntax:
p
Syntax Description:
No arguments or keywords.
Note
The command displays information for the following parameters: External MAC
address, External IP address, External Network Mask, Default gateway, DHCP
client, FTP server IP Address, FTP file name and External Net.
Example:
[Boot Prompt]> p
3-134
Boot Commands
IPVgate - 20x Ver. 2.4
Installation and Operation Manual
Chapter 3 Using the Command Line Interface
c
Changes the boot parameters.
Syntax:
c
Syntax Description:
No arguments or keywords.
Note
The parameters are listed one at a time followed by a prompt. Enter new
information if needed or just press Return to move to the next parameter.
The following parameters can be changed: External MAC address, External IP
address, External Network Mask, Default gateway, DHCP client, FTP server IP
Address, FTP file name and External Net.
Example:
[Boot Prompt]> c
ap
Prints the application parameters to the console.
Syntax:
ap
Syntax Description:
No arguments or keywords.
Note
The following parameters are displayed: Internal MAC address, Internal IP address,
Internal Network Mask, Tel, Country, Area, Domain, DNS, DNS2, Date & Time,
Router, Dhcp Server, Pool Low, Pool Hi, Use NAT, FTP password, Use RIP, RIP
version, RIP multicast and DDNS update.
Example:
[Boot Prompt]> ap
ac
Changes the application parameters.
Syntax:
ac
Syntax Description:
No arguments or keywords.
IPVgate - 20x Ver. 2.4
Boot Commands
3-135
Chapter 3 Using the Command Line Interface
Note
Installation and Operation Manual
The parameters are listed one at a time followed by a prompt. Enter new
information if needed or just press Return to move to the next parameter.
The following parameters can be changed: Internal MAC address, Internal IP
address, Internal Network Mask, Tel, Country, Area, Domain, DNS, DNS2, Date &
Time, Router, Dhcp Server, Pool Low, Pool Hi, Use NAT, FTP password, Use RIP,
RIP version, RIP multicast and DDNS update.
Example:
[Boot Prompt]> ac
b<x>
Sets the boot flag.
Syntax:
b<0 | 3>
Syntax Description:
Note
s
Description
0
Keyword to set the boot flag to 0.
3
Keyword to set the boot flag to 3.
The boot flag keeps track of how many attempts have been made to run the
software file in memory. After three failed attempts the unit contacts the FTP
Server and downloads an update file.
• Set the flag to 3 to force download of the software file.
• Set the flag to 0 if the previous download failed.
Example:
[Boot Prompt]> b3
r
Reboots the unit.
Syntax:
r
Syntax Description:
This command has no arguments or keywords.
Note
Use this command at the end of your boot session to restart the unit with the
new settings.
Example:
[Boot Prompt]> r
3-136
Boot Commands
IPVgate - 20x Ver. 2.4
Appendix A
VPN Configuration
Examples
This appendix provides VPN configuration examples.
A.1
VPN Test 1
This test is used to check VPN connection between 2 Units with different
networks.
1. The Unit 1 configured with IP 213.24.79.12 External primary and
192.168.0.1/255.255.255.0 internal network.
2. The Unit 2 configured with IP 62.219.24.15 External primary and
10.0.0.1/255.255.255.0 internal network.
3. Open tunnel between Unit1 LAN and Unit 2 LAN
4. Unit 1 has the following VPN policy:
IPC>vpn ipsec add_policy localhost,10.0.0.1/255.255.255.0,any,any,any,
62.219.24.15
IPC>vpn isakmp add_secret 62.219.24.15,secretkey123
5. Unit 2 has the following VPN policy:
IPC>vpn ipsec add_policy localhost,192.168.0.1/255.255.255.0,any,any,any,
213.24.79.12
IPC>vpn isakmp add_secret 213.24.79.12,secretkey123
6. Try to connect from PC from LAN of Unit 1 to PC2 from LAN of Unit 2 by ftp
protocol.
7. Unit 1 will open a VPN tunnel to Unit 2.
IPVgate - 20x Ver. 2.4
VPN Test 1
A-1
Appendix A VPN Configuration Examples
Installation and Operation Manual
Figure A-1. VPN Tunnel Configuration
A.2
VPN Test 2
This test is used to check VPN connections between LAN of the Unit that is
located in office and home PC.
1. The Unit 1 configured with IP 213.24.79.12 External primary and
192.168.0.1/255.255.255.0 internal network.
2. Home PC configured with static legal IP 62.219.42.12/255.255.255.255 .
3. Open tunnel between Unit LAN and Home PC
4. Unit 1 has the following VPN policy:
IPC>vpn ipsec add_policy localhost,
62.219.42.12/255.255.255.255,any,any,any, 62.219.42.12
IPC>vpn isakmp add_secret 62.219.24.15,secretkey123
5. Home PC should be configured with required operation system parameters.
Figure A-2. VPN Test Configuration
A-2
VPN Test 2
IPVgate - 20x Ver. 2.4
Appendix B
Typical ADSL Connection
Configurations
This appendix discusses typical ADSL connection configurations.
B.1
Example 1
A simple configuration with a dynamic IP address. This is a typical Home/Small
office connection. This example uses a PPTP connection. All commands are
entered through the terminal after logging on.
1. Enable Point to Point Tunnel Protocol:
ipcfg ppp pptp y
2. Enter the username of the account:
ipcfg ppp user username@isp-domain
3. Enter the password of the account:
ipcfg ppp psw 123123
4. Add the external primary ip address:
ipcfg ip ext add 10.0.0.1 255.0.0.0 pri
5. Add the ip address of the gateway (ip of ADSL modem):
ipcfg gtw 10.0.0.138
6. Add the internal primary ip address:
ipcfg ip int add 192.168.0.1 255.255.255.0 pri
7. Restart the Unit.
After a successful ADSL connection, the unit should receive a dynamic IP
address.
IPVgate - 20x Ver. 2.4
Example 1
B-1
Appendix B Typical ADSL Connection Configurations
B.2
Installation and Operation Manual
Example 2
A configuration with a range of eight legal IP addresses. This is a typical SMB
office with Mail Server on the LAN. This example uses a PPPoE connection. All
commands are entered through the terminal after logging on.
1. Enable Point to Point Protocol Over Ethernet:
pcfg ppp pppoe y
2. Enter the username of the account:
ipcfg ppp user username@isp.com
3. Enter the password of the account:
ipcfg ppp psw 123123
4. Add the internal primary network:
ipcfg ip int add 192.168.0.1/255.255.255.0 pri
5. Add a secondary internal network with a pool of 8 legal IP addresses:
ipcfg ip int add 62.219.128.57/255.255.255.48 sec
6. Configure the DHCP server interface:
ipcfg dhcp server interface 192.168.0.1/255.255.255.0
7. Configure the ddns to update with the internal primary IP address
62.219.128.57:
ipcfg ddns int
8. Add a NAT relocation entry for the SNTP server:
nat add 192.168.0.2 25 25 tcp
9. Add a NAT relocation entry for the POP3 server:
nat add 192.168.0.2 110 110 tcp
10. Restart Unit.
After a successful ADSL connection, the unit should receive a dynamic IP
address.
B-2
Example 2
IPVgate - 20x Ver. 2.4
Index
—A—
Accessing unit
serial console, 3-3
Telnet, 3-3
ADSL Connection
configurations, B-1
ADSL settings, 3-118
event, 3-121
mode, 3-121
reconnect, 3-120
show, 3-118
stat, 3-119
area, 3-22
ATM settings, 3-115
add, 3-116
del, 3-117
show, 3-115
stat, 3-117
—B—
basic configuration, 3-10
billing server, 3-41
Boot commands
ac, 3-139
ap, 3-138
b<x>, 3-139
c, 3-138
p, 3-137
r, 3-140
—C—
Cables
CBL-DB9F-DB9M-STR, 2-5
CBL-DB9F-DB9M-STR, 2-5
Command completion, 3-2
Command help, 3-2
Command line
syntax conventions, 3-1
Command Line Interface (CLI)
boot commands, 3-137
commands, 3-4
editing features, 3-2
processing, 3-2
using, 3-1
Command modes, 3-3
configuration
IP, 3-10
Configuration
basic, 3-10
Connecting to Ethernet and telephony equipment
IPVgate-20A ADSL, 2-5
IPVgate-20A ETH, 2-6
IPVgate - 20x Ver. 2.4
IPVgate-20B ADSL, 2-6
IPVgate-20B ETH, 2-7
IPVgate-20P, 2-7
Connection
AC power, 2-8
country, 3-23
—D—
ddns, 3-28
DDNS registration
retr_time, 3-58
set_addr, 3-55
set_head, 3-56
set_method, 3-57
set_path, 3-55
set_port, 3-56
show, 3-58
DDNS Registration, 3-55
del, 3-98
Device
installation, 2-2
Dhcp, 3-13
client, 3-15
server, 3-13
DMZ settings, 3-97
add, 3-97
del, 3-98
show, 3-97
dns, 3-11
DNS server
a, 3-51
add, 3-52
domain, 3-54
mx, 3-52
reload, 3-53
rem, 3-53
show, 3-54
DNS Server, 3-51
dns2, 3-12
domain, 3-21
—E—
Equipment
hand tools, 2-2
kits, 2-2
power cable, 2-2
Etherent
connecting, 2-5
Ethernet
ports, 2-5
I-1
Index
—F—
Factory default settings, 3-136
Factory defaults, 3-136
File system, 3-47
copy, 3-48
create, 3-50
del, 3-48
dir, 3-47
format, 3-49
iniws, 3-50
type, 3-47
ftpfile, 3-28
ftpip, 3-27
—G—
glob, 3-41
set_addr, 3-41
set_head, 3-43
set_path, 3-42
set_period, 3-43
set_port, 3-42
show, 3-44
gtw, 3-11
—H—
Hand Tools, 2-2
—I—
Installation, 2-1
Introduction, 1-1
IP configuration, 3-10
IP filter settings, 3-93
add, 3-94
del, 3-95
permit, 3-93
show, 3-93
trace, 3-96
IPVgate-20A/B, 1-1
IPVgate-20P, 1-2
ISDN configuration commands, 3-122
bri1, 3-124
brie2, 3-126
Line_in, 3-131
PRI, 3-128
show, 3-122
termination, 3-134
—K—
Kits, 2-2
—L—
loc, 3-45
set_email, 3-45
set_period, 3-45
set_show, 3-46
—M—
mem, 3-29
Mounting the unit, 2-2
I-2
User’s Manual
—N—
nat, 3-26
enable, 3-26
interface, 3-26
NAT configuration, 3-59
add, 3-59
rem, 3-60
show, 3-60
—P—
Package contents
IPVgate-20A, 2-1
IPVgate-20B, 2-1
IPVgate-20P, 2-2
Phone interface, 3-79
call waiting, 3-91
hot line, 3-90
metering, 3-82
show, 3-89
trunk1, 3-79
trunk2, 3-80
trunk3, 3-81
trunk4, 3-81
Phone number configuration, 3-92
Physical Description, 1-4
Ping, 3-135
Port services, 3-61
set, 3-61
show, 3-62
Ports
connecting, 2-5
Ethernet, 2-5
Power Cable, 2-2
ppp, 3-30
lcp_echo, 3-36
pppoa, 3-35
pppoe, 3-34
pppoe_svc, 3-35
pppoeoa, 3-36
pptp, 3-32
pptp_ip, 3-33
pptp_quirk, 3-33
psw, 3-31
reload, 3-37
retry_num, 3-31
retry_timeout, 3-32
show, 3-37
trace_event, 3-38
user, 3-30
—Q—
QoS, 3-38
bitrate, 3-40
enable, 3-39
show, 3-39
Quit, 3-136
—R—
Registration on the SIP proxy server, 3-76
expiration time, 3-76
Restart, 3-137
rip, 3-18
enable, 3-18
IPVgate - 20x Ver. 2.4
User’s Manual
mcast, 3-19
password, 3-20
version, 3-19
router, 3-23
add, 3-23
ashow, 3-25
del, 3-24
flash, 3-25
show, 3-24
—S—
Serial console, 3-3
show, 3-40
SIP commands, 3-71
proxyt, 3-73
redirect, 3-72
show, 3-75
timeout, 3-72
SIP registration
national format, 3-78
SIP URL, 3-77
SIP registration format
FROM field, 3-77
TO field, 3-78
Site Requirements, 2-1
stat, 3-29
System
overview, 1-1
—T—
Technical Specifications, 1-5, 2-1
tel, 3-21
Telephone gain, 3-63
Telephoney
connecting, 2-5
Telephony gain
input, 3-64
output, 3-66
show, 3-63
Telnet, 3-3
IPVgate - 20x Ver. 2.4
Index
Telnet manager commands, 3-4
conf_print, 3-9
conf_set, 3-9
get, 3-8
kick, 3-5
kick_all, 3-6
psw_def, 3-7
psw_set, 3-6
show, 3-5
telnet, 3-8
write, 3-7
time, 3-20
Time, 3-113
Trunk number configuration, 3-92
—U—
unit
mounting, 2-2
Unit
accessing, 3-3
—V—
Version commands, 3-114
Vesion commands
show, 3-114
upgrade, 3-114
Voice over IP, 3-69
codec, 3-70
digest, 3-69
secure, 3-69
show, 3-71
VPN
configuration examples, A-1
VPN settings, 3-99
advanced, 3-107
dns_bypass, 3-113
enable, 3-99
Ipsec, 3-100
isakmp, 3-103
phase_2, 3-110
I-3
Index
I-4
User’s Manual
IPVgate - 20x Ver. 2.4
24 Raoul Wallenberg Street, Tel Aviv 69719, Israel
Tel: +972-3-6458181, Fax +972-3-6483331, +972-3-6498250
E-mail: erika_y@rad.com, Web site: http://www.rad.com
Customer Response Form
RAD Data Communications would like your help in improving its product documentation.
Please complete and return this form by mail or by fax or send us an e-mail with your
comments.
Thank you for your assistance!
Manual Name:
IPVgate-20A, IPVgate-20B, IPVgate-20P Ver. 2.4
Publication Number:
803-200-12/07
Please grade the manual according to the following factors:
Excellent
Installation instructions
Operating instructions
Manual organization
Illustrations
The manual as a whole
What did you like about the manual?
Good
Fair
Poor
Very Poor
Error Report
Type of error(s) or
problem(s):
Incompatibility with product
Difficulty in understanding text
Regulatory information (Safety, Compliance, Warnings, etc.)
Difficulty in finding needed information
Missing information
Illogical flow of information
Style (spelling, grammar, references, etc.)
Appearance
Other
Please list the exact page numbers with the error(s), detail the errors you found (information missing,
unclear or inadequately explained, etc.) and attach the page to your fax, if necessary.
Please add any comments or suggestions you may have.
You are:
Distributor
End user
VAR
Other
Who is your distributor?
Your name and company:
Job title:
Address:
Direct telephone number and extension:
Fax number:
E-mail:
Publication No. 803-200-12/07
International Headquarters
24 Raoul Wallenberg Street
Tel Aviv 69719, Israel
Tel. 972-3-6458181
Fax 972-3-6498250, 6474436
E-mail market@rad.com
North America Headquarters
900 Corporate Drive
Mahwah, NJ 07430, USA
Tel. 201-5291100
Toll free 1-800-4447234
Fax 201-5295777
E-mail market@radusa.com
www.rad.com
The Access Company
Download PDF
Similar pages