Snom 4S Administrator's Manual
Snom 4S Administrator's Manual

Snom 4S Administrator's Manual

Sip proxy/registrar version 2.37
Hide thumbs Also See for 4S:
Table of Contents

Advertisement

Administrator's
Guide
snom 4S
SIP Proxy/Registrar
Version 2.37

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the 4S and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Snom 4S

  • Page 1 Administrator‘s Guide snom 4S SIP Proxy/Registrar Version 2.37...
  • Page 2 © 2003 snom technology Aktiengesellschaft. All Rights Reserved. This document is supplied by snom technology AG for information purposes only to licensed users of the snom 4S registrar proxy and is supplied on an “AS IS” basis, that is, without any warranties whatsoever, express or implied.
  • Page 3: Read This First

    This manual does not cover all topics that are related to the usage of the proxy. We keep a list of frequently asked questions (FAQ) on our website at http://snom.com/faq_en.php for specialized topics such as remote management via shell script. They also contain topics that affect other SIP components like the media server or the phones.
  • Page 4 E G I S T R A R A N U A L available at the software download site at http://snom.com/down4s_ en.php. Before you make a software update, you make check this document if the update is necessary or not.
  • Page 5: Table Of Contents

    ................................. HTTP User and Password Configuration in XML ..................................Domains ..............25 Deriving settings ..............25 Creating a domain ..............26 Deleting a domain..............26 Edit a domain................27 Going to a domain context ............27 snom technology AG • 5...
  • Page 6 4 S P S N O M R O X Y E G I S T R A R A N U A L Backup..................27 Server Farm .............29 Shutting servers down............... 29 Number of necessary servers ............. 29 DNS considerations ..............30 Refresh rate considerations ............
  • Page 7 Unavailable Hosts ..............56 Memory Usage ................. 57 Billing...............59 CDR Generation................ 59 Call Log File Format ..................................................................... XML-Based format RADIUS ................... 61 ............................Authentication and Accounting ............................................ Setup RADIUS Server ..............................................................................Security Index ..............103 snom technology AG • 7...
  • Page 8 4 S P S N O M R O X Y E G I S T R A R A N U A L 8 • Contents...
  • Page 9: Installation

    The default http port number is 80. This is a reasonable choice in case that you are not running any other http services on that machine or that users want to access the machine. If you choose another port, users snom technology AG • 9...
  • Page 10 4 S P S N O M R O X Y E G I S T R A R A N U A L always have to specify the complete address including the port number. Unfortunately, Microsoft Internet Explorer expects the complete address including the scheme in this case (http://proxy:1234), which makes it inconvenient to access to proxy.
  • Page 11: Windows Installation

    If you decline, the installation will be aborted. After accepting the license agreement, the next screen asks you to enter your personal information. Enter your name and the name of organization. Figure 1-2: Installation License Agreement snom technology AG • 11...
  • Page 12 4 S P S N O M R O X Y E G I S T R A R A N U A L You can then select the location where the proxy’s files will be put. The installation program proposes a reasonable location but if you want to you can change it.
  • Page 13 Check that the installation has been successful by checking the Services field of Windows. Open the services Window and look for “snom 4S SIP Proxy/Registrar”. The status should be “Started”. If this is not the case you should invoke the proxy by selecting “start”. In this case, we recommend rebooting the system to make sure that the proxy is running after the reboot.
  • Page 14: Uninstalling In Windows

    Figure 1-5: Installation Port Definition Uninstalling in Windows To uninstall the proxy, first stop it in the services window. Then go to the Software Window and click on “remove” for snom 4S proxy Server. Linux Installation The software runs under SuSE (7.2 or 8.0) and Red Hat (8.0) Linux;...
  • Page 15: Manual Starting

    Open a web browser to see if the proxy is up and running. Reboot the system and check whether the sip proxy was started automatically after the reboot. You can then continue with the installation using the web snom technology AG • 15...
  • Page 16: Software Updates

    4 S P S N O M R O X Y E G I S T R A R A N U A L browser. Stop and restart the proxy with the rcsnomproxy command to check whether the configuration has been saved. Software Updates To update a version, copy the latest tarball into the directory and run the install script of the new version.
  • Page 17: Licensing

    The "Hostnames" field has a function to uniquely identify this copy of the snom SIP proxy. Therefore, when requesting the license key from snom you should use the DNS names of the host which will run the proxy. You should also include the IP address of this host. Examples "proxy.mycompany.com...
  • Page 18: Dns Setup

    E G I S T R A R A N U A L specify a fully qualified DNS name so that snom can clearly identify the copy of the SIP proxy. To see the possible license types please refer to the data sheet.
  • Page 19: Dns Example

    ( 2002050111 ; serial ; refresh ; retry ; expiry 1D ) ; minimum IN NS IN NS ns2.nameserver121.com. 10 mail.anycom.de. _sip._tcp.anycom.de. IN SRV 0 5 5060 sip-server.anycom.de. IN SRV 0 1 5060 test.anycom.de. snom technology AG • 19...
  • Page 20 4 S P S N O M R O X Y E G I S T R A R A N U A L IN SRV 1 5 5060 www.anycom.de. _sip._udp.anycom.de. IN SRV 0 5 5060 sip-server.anycom.de. IN SRV 0 1 5060 test.anycom.de. IN SRV 1 5 5060 www.anycom.de.
  • Page 21: General Setup

    The log is kept internally within the proxy. After a certain number of log entries have been reached, the oldest entries are removed from the log, so that there is no danger of memory overflow from files getting too large. snom technology AG • 21...
  • Page 22: Log Filename

    4 S P S N O M R O X Y E G I S T R A R A N U A L Log Filename If you want to write all log messages to file, you may specify the file name in this field. However, log files might become very large over time and especially when the proxy is running without any problems over a longer period the file might become too big for the file system and cause a proxy crash.
  • Page 23: Configuration In Xml

    You can save this configuration in any file you like. To upload the configuration from such a file, use the file selection box at the bottom of the web page. This way you can also easily distribute configuration files over several redundant proxies. snom technology AG • 23...
  • Page 24 4 S P S N O M R O X Y E G I S T R A R A N U A L 24 • General Setup...
  • Page 25: Domains

    When you set up a domain, most of the domain settings are copied from the global settings context. Most of the menus which are available for domains are also available under a global scope. Although snom technology AG • 25...
  • Page 26: Creating A Domain

    4 S P S N O M R O X Y E G I S T R A R A N U A L they don‘t have any effect on the global behaviour of the proxy, they serve as a template when a domain is created. Once a domain has been created, changes in the global settings context do not affect the settings of the domain anymore.
  • Page 27: Edit A Domain

    The domains of stored right in the main directory as directory and contains a file named “domain.xml”. However, if you change the files in the filesystem, you need to restart the proxy as it caches the information related to the domains. snom technology AG • 27...
  • Page 28 4 S P S N O M R O X Y E G I S T R A R A N U A L 28 • Domains...
  • Page 29: Server Farm

    Number of necessary servers The number if necessary servers depends on the reliability of the machines, the number of machines, the number of machines that are necessary to maintain service (load balancing), the number of machines snom technology AG • 29...
  • Page 30: Dns Considerations

    4 S P S N O M R O X Y E G I S T R A R A N U A L that can be set out of service by intension, the intended reliability, and (last not least) the reliability of shared equipment like power and network connectivity.
  • Page 31: Refresh Rate Considerations

    Five minutes is a good time. For making the exchange of registration information more secure, you can enter a username and a password. This will be used by the proxy snom technology AG • 31...
  • Page 32 4 S P S N O M R O X Y E G I S T R A R A N U A L for challenging incoming replication requests. However, the information itself is transported insecure. It is important that you keep the same setup information on all proxies that replicate registration information.
  • Page 33: Domain Settings

    Depending on the used media server conference type, the user may control the conference using DTMF keys. On the snom Media Server, the user may explicitly invite or exclude members from the conference.
  • Page 34 A N U A L password). To pass the conference ID, you usually include a parameter in the name, like “sip:conf@media.snom.com;conf_id=7832”. The “7832” is created by the proxy and you should place the placeholder “{cid}” into the setting, like “sip:conf@media.snom.com;conf_id={cid}”. The same applies for the call-back service.
  • Page 35: Accounts

    The user name is usually identical to the account name; however you may specify a different name if you want to make authentication even more secure. The password is not transmitted directly snom technology AG • 35...
  • Page 36: Setting Up Accounts From The Web Interface

    4 S P S N O M R O X Y E G I S T R A R A N U A L in SIP and therefore provides a good mechanism to make sure that the user is the one that he or she pretends to be. However, if you choose a four of five digit PIN code it is relatively easy to guess that PIN code by an observer by trying out all possible combinations.
  • Page 37: Storing Information

    In contrast to the domain files, the proxy does not cash account files. They all loaded on demand and if it change occurs written back to the file system. Therefore, it is not recommended to modify a these files. snom technology AG • 37...
  • Page 38 4 S P S N O M R O X Y E G I S T R A R A N U A L 38 • Accounts...
  • Page 39: Registration

    Limiting the maximum registry time reduces the danger of a user agent being unreachable for a longer period of time. Typical values for minimum and maximum times are 30 seconds and 86400 seconds (one day). snom technology AG • 39...
  • Page 40: Default Q

    4 S P S N O M R O X Y E G I S T R A R A N U A L Default Q When a user agent registers with the proxy, it should indicate the probability with which the contact can be found at this address. This value control the sequence in which the proxy searches for a user.
  • Page 41: Routing

    Routing Routing is one of the most important tasks of the proxy. As you already could see in the scripting manual for the proxy, the snom 4S SIP proxy supports numerous ways to support complex routing scenarios. This chapter focuses on the web interface to the routing. This interface controls variables which are interpreted by the default script.
  • Page 42: Sequential Forking Time

    4 S P S N O M R O X Y E G I S T R A R A N U A L Sequential Forking Time When you allow the proxy to register an account more than once, the proxy starts “sequential forking” if the registration shows different probabilities.
  • Page 43: System Administrator Settings

    UPnP or STUN). When you run a setup like this, you must be aware that the proxy might not be visible from the outside world. The functionality of the proxy snom technology AG • 43...
  • Page 44: No Loose Routing

    “loose routing” was developed, a new and better way of routing messages. For more information see the SIP standard RFC3261 or the literature available on this topic. The snom 4S supports both routing methods. Although loose routing is mandatory for new SIP equipment and is compatible with the old routing method (“strict routing”), some...
  • Page 45: Dial Plan

    ‘%’ matches E164 numbers multiple times, even if there is no digit. • ‘~’ matches one of the domain alias • ‘=’ matches the PSTN gateway. • ‘[a-z]’ matches a character range (in this example from a to z). snom technology AG • 45...
  • Page 46 4 S P S N O M R O X Y E G I S T R A R A N U A L The comparison process includes the sip identifier at the beginning of the URL. The action can be one of the following: •...
  • Page 47: Example 1: Setting Up Overlap Dialling

    404 Not Found after you dialled the first digit that could be a PSTN number. Example 2: North American Dial Plan This example is suitable for a proxy located in the USA. Rule Mode User/ Pattern Destination Group Incomplete snom technology AG • 47...
  • Page 48: Example 3: Do Not Allow Cell Phone Numbers To Certain Users

    4 S P S N O M R O X Y E G I S T R A R A N U A L Forward sip:911*@~* sip:911@gw1 Forward sip:[1-9]$$$$$$@~* sip:{user}@gw2 Forward sip:0[1- sip:{user}@gw2 9]$$$$$$$$$@~* Forward sip:00%@~* sip:{user}@gw2 Rule 1 defaults all calls (not for registered users) to “incomplete”. Rule 2 redirects all emergency calls to the gateway number one, which could be connected a local analog line.
  • Page 49: Example 4: Using Enum

    The error information may be on a web page (e.g. http://www.company.com/error-explanations/ err_404.htm), but it may also be a SIP URL. While most VoIP phones can not display http content, they can place a call to an announcement server snom technology AG • 49...
  • Page 50 “{code}” which will be replaced with the error-code (e.g. “404”). If your media server understands additional parameters in the number (as the snom 4S Media Server), then you can set up one error explanation account for all codes.
  • Page 51: Message Handling

    This is a nice feature that informs users about the operators capabilities or downloads operator images onto the phones. When the location of the attachment file changes, the proxy notifies all registered users about the change. snom technology AG • 51...
  • Page 52 4 S P S N O M R O X Y E G I S T R A R A N U A L The proxy allows two method for notifying users, message and notify. Notify is typically used for sending media attachments, message is the instant message notification style (which is compatible with most popular equipment).
  • Page 53: Status Reports

    The path is optional. • User-Agent: The user agent identification tells the proxy if a license is required. • Probability: The probability of the registration. Users are searched according to their probability. snom technology AG • 53...
  • Page 54: Call Logs

    4 S P S N O M R O X Y E G I S T R A R A N U A L • Expires: The expiry time in seconds. If you click on the link behind this number, you get to the SIP message trace that is associated with the registration.
  • Page 55: Call Attempts

    Should a problem occur, a look at the messages that went though the proxy can be very helpful. If you go to the SIP Trace web page, a list of the last messages appears on the screen. The list has the following elements: • Time: snom technology AG • 55...
  • Page 56: Logs

    4 S P S N O M R O X Y E G I S T R A R A N U A L The time when the packet was sent or received. • Type: The type indicates whether the packet was received (R) or transmitted (T).
  • Page 57: Memory Usage

    The web interface gives information on the number of allocated objects. This infromation might be more helpful for indicating memory hot spots than a pure memory usage number. The memory usage is divided by domains also. snom technology AG • 57...
  • Page 58 4 S P S N O M R O X Y E G I S T R A R A N U A L 58 • Status Reports...
  • Page 59: Billing

    CDR logging should be done. In Unix environments, this mechanism can be used to feed a process with the data (using a named pipe). This way, a very simple call processing can be done. snom technology AG • 59...
  • Page 60: Xml-Based Format

    <call-records> <record> <start>Thu, 02 Oct 2036 18:55:38 GMT</start> <end>Thu, 02 Oct 2036 18:55:52 GMT</end> <duration>14</duration> <account>0308454260</account> <from>0308454260@intern.snom.de</from> <to>411@intern.snom.de</to> <ipadr>udp:192.168.0.247:5060</ipadr> </record> </call-records> The XML packet transports the following information. The attachment is made of a list of call records (record). The proxy currently sends one record per message;...
  • Page 61: Radius

    A sample java-based billing server is available upon request from snom. RADIUS snom 4S supports RADIUS to do billing. It works as RADIUS client to a RADIUS server (where the data base for the various accounts is maintained). As a client it securely obtains information of a particular...
  • Page 62: Radius Server

    RADIUS provides the basic secure way to handle billing and to do it in a way that is compatible with any RADIUS capable device. Our snom proxy acts as a RADIUS client and can handle billing using RADIUS with a server based on RADIUS that maintains the data base.
  • Page 63 4 S P S N O M R O X Y E G I S T R A R A N U A L snom technology AG • 63...
  • Page 64 4 S P S N O M R O X Y E G I S T R A R A N U A L 64 • Billing...
  • Page 65: Index

    Installation 19 Delete 60 Installation Directory 20 DHCP 11 Instant Messaging 11 Dial Plan 45 Interoperability 3, 8, 16 Dial plan 15 IPchains 16 DiffSrv 7 ISDN 7 DNS 11, 52 DNS SRV 28 DSL 16 snom technology AG • 65...
  • Page 66 Path registration 15, 16 SIP Message Flow 63 Ports 21 SIP NAT Gateway 16 PPPoE 16 SNMP 11 Private IP Address 31 snom 100 Registration 55 Private Networks 16 Soft Switch 3 Probability 9, 30, 59 State 29 Proxies 12 Stateful Forking 15...
  • Page 67 Supplementary Services 8 Switched Network 7 TCP threshold 39 Transfer 9 Transport Layer 16, 29 UAC 32 UAS 32 Uninstalling 23 User 59 User-Agent 11, 59 VLAN 7 VoIP 7 Web Access 16 Wildcards 46 snom technology AG • 67...
  • Page 68 Coppell, Texas 75019, USA http://www.snom.com Phone: +1-972-831-0280 sip:info@snom.com sip:usa@snom.com mailto:usa@snom.de India and SAARC: snom technology (India) Pvt Ltd. No. 417, International Trade Tower Nehru Place, New Delhi-110019 Phone: +91 11 26234097 Fax: +91 11 26234079 http://www.snomindia.com mailto:info@snomindia.com sip:india@snom.com © 2003 snom technology AG...

Table of Contents