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

Snom 4S Administrator's Manual

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

Advertisement

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

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.42...
  • Page 2 © 2001-2004 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: Table Of Contents

    ............................................................... 3.2.2 Administrator Access 3.2.3 Importing Certificates ..............................3.3 System Settings..............25 ...................................... 3.3.1 Log Level 3.3.2 Log Filename ..................................3.3.3 Internal Length ....................................................................3.3.4 Cache Sizes 3.3.5 Maximum Number of Subscriptions ...................... snom technology AG • 3...
  • Page 4 4 S P S N O M R O X Y E G I S T R A R A N U A L 3.3.6 Unavailable Host TTL ....................................................... 3.3.7 Handle Dialog Subscriptions 3.3.8 Act as Presence-Server ............................3.3.9 Perform Number Guessing ..........................
  • Page 5 11.3 Dial Plan ................66 11.3.1 How it works ..................................................................... 11.3.2 Call Pickup .................... 11.3.3 Example 1: North American Dial Plan 11.3.4 Example 2: Do not allow cell phone numbers to certain users ....11.4 Error-Information .............. 69 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 12 Call Hunting............71 12.1 Defining Stages..............71 12.2 Defining the Algorithm ............72 12.3 Default Actions..............73 13 Address Books.............75 13.1 Number Guessing ..............
  • Page 7: 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 snom technology AG • 7...
  • Page 8 We also keep a list of bug fixes in the release notes, which is available at the software download site at http://snom.com/down4s_ en.php. Before you make a software update, you may check this document if the update is necessary or not.
  • 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 the proxy.
  • Page 11: Windows

    Please read them carefully, and then select the “accept” button and press “next” to accept the conditions. If you decline, the installation will be aborted. After accepting the license agreement, the next screen asks you snom technology AG • 11...
  • Page 12 Check that the installation has been successful by checking the Services window 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 check if the proxy is starting again after the reboot.
  • Page 13: Uninstalling In Windows

    “netstat” to find the proxy http port. 2.3.2 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. 2.4 Linux Installation The software runs under SuSE and Red Hat Linux;...
  • Page 14: 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 registrations. It typically also contains the configuration information. su - cd /usr/local tar xvfz ~/snom_sip_proxy-i386-suse8-2.42.tgz Go to the directory where you extracted the new version: cd snom_sip_proxy-i386-suse8-2.42 The tarball includes a shell script with the name install.sh which sets up the necessary files and links for you:...
  • Page 15: Licensing

    (for example, one VoIP phone and one mailbox count as one registration if they are using the same account). Name Code Registrations Call Log Entry snom technology AG • 15...
  • Page 16 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 17: Dns Setup

    A configuration file for Linux might look like this: $TTL 1D anycom.de. IN SOA fox.anycom.de. hostmaster.anycom.de. ( 2002050111 ; serial ; refresh ; retry ; expiry 1D ) ; minimum IN NS snom technology AG • 17...
  • Page 18 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 NS ns2.anycomns.de. 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. IN SRV 1 5 5060 www.anycom.de.
  • Page 19: General Setup

    These addresses will also be offered in the pull down menu as if they had been found on the host. 3.1.2 Receiving forwarded packets If you forward packets to the proxy from a firewall or NAT, the 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 proxy needs to act as if it was using this address. If you are doing this, you need to specify which address the proxy should use.
  • Page 21: Stun Settings

    IP addresses. However, in these cases you should be careful that you don’t screw the ARP caches up by choosing the IP address of a host sitting next to you. In such cases, it is sufficient to choose IP addresses like 1.1.1.1. snom technology AG • 21...
  • Page 22: Security Setup

    4 S P S N O M R O X Y E G I S T R A R A N U A L 3.2 Security Setup 3.2.1 https/http Access The proxy supports a secure web access starting from version 2.42.
  • Page 23: Administrator Access

    3.2.3 Importing Certificates Normally, the proxy automatically generates a syntactically correct certificate automatic („self signed certificate“). However, most web browsers will complain about the presented certificate. You may buy certificates from a number of trusted vendors. You 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 can see and edit this list in your browser and search the Internet for vendors. Typically, when you order a certificate, you receive a text file that looks like the one below: -----BEGIN CERTIFICATE----- MIIDTDCCArWgAwIBAgIBADANBgkqhkiG9w0BAQQFADB9MQswCQYDVQQGEwJERTET...
  • Page 25: System Settings

    Therefore, it is recommended to use the file snom technology AG • 25...
  • Page 26: Internal Length

    4 S P S N O M R O X Y E G I S T R A R A N U A L logging feature only in cases where you want to identify a problem on a temporary basis. 3.3.3 Internal Length The proxy keeps a lot of internal information in memory.
  • Page 27: Handle Dialog Subscriptions

    The proxy includes the mobility information set by the users for additional presence information. As described in the user manual, the users can tell the proxy to redirect calls to other locations. This is indicated with “office”, “home”, “road” or “offline” indications. snom technology AG • 27...
  • Page 28: Perform Number Guessing

    4 S P S N O M R O X Y E G I S T R A R A N U A L 3.3.9 Perform Number Guessing When the users start entering a number, the proxy may help complete this number. This function is called number guessing. By turning this flag on you enable this feature.
  • Page 29: License Reporting

    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 • 29...
  • Page 30 4 S P S N O M R O X Y E G I S T R A R A N U A L 30 • General Setup...
  • Page 31: Stun

    DNS SRV entry, they will try the DNS A address of the registrar. For example, if a client registers as „sip:abc@snom.com“, it will try to resolve the DNS A address „snom.com“. • If this is also not possible or if the clients don’t support the automat- ic detection of the STUN server, you must set up the STUN server snom technology AG •...
  • Page 32: 128 Bit Stun

    Fortunately, it is possible if a client uses the 32 bit or the 128 bit version of STUN. The proxy automatically decides if it should return with a 32 bit or a 128 bit header. This maximizes the compatibility of the snom STUN server with the implementations of other vendors.
  • Page 33: 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 • 33...
  • Page 34: 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 35: Deleting A Domain

    The proxy will then display all information in the domain context as if you logged on in the domain context. 5.6 Determining the Domain Context 5.6.1 Purpose Operating the proxy in a multiple domain environment gives the snom technology AG • 35...
  • Page 36: Usage

    R O X Y E G I S T R A R A N U A L snom proxy advantages against other SIP proxy products. However, the determination of the domain may have different requirements, depending on the environment. The decision affects the visibility of calls in the domain context (for domain administrators).
  • Page 37: Backup

    The domains of stored in the runtime directory as directory and contain a file named “domain.xml”. However, if you change the files in the file system, you need to restart the proxy as it caches the information related to the domains. 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 • Domains...
  • Page 39: Server Farm

    6.2 Number of necessary servers The number of 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 • 39...
  • Page 40: 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 41: 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 • 41...
  • Page 42 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 43: Domain Settings

    For a domain, you should specify a password, so that the domain administrator can do changes specifically for this domain. If you don’t assign a password, everybody will be able to change settings for the domain. snom technology AG • 43...
  • Page 44: Conferencing And Call-Back

    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 45: 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 • 45...
  • Page 46: 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 47: Uploading User Accounts From File

    To import data from a spreadsheet tool, you need to set up one header line that contains the name of the fields that you like to import. You can choose any name; however the following names are reserved for snom technology AG • 47...
  • Page 48 4 S P S N O M R O X Y E G I S T R A R A N U A L proxy-internal use. alias The alias field defines the names of the account. The field is separated by space; the first name is the primary name of the account and the other fields contain the alias names of the account.
  • Page 49: Storing Information

    8.5.1 Single Registration By checking “Single Registration” you may allow the user to register only one contact. Previously registered contacts are dropped when a new registration is received. This feature is helpful when user snom technology AG • 49...
  • Page 50: 3Rd Party Registration

    Instead of changing all affected accounts, the snom proxy allows the domain administrator to specify the affected accounts by a pattern (“Answer Challenging for Account-Pattern”). The pattern is a list of patterns known from the dial plan that is matched against the account name that is challenged.
  • Page 51: Automatic User Agent Configuration

    • If the DHCP server provided a domain name, the user agent tries to contact the host with the name „sip“ in that domain (for example, if the domain is company.com it will try sip.company.com). This loca- snom technology AG • 51...
  • Page 52: Setting Groups

    • Otherwise, it will use the setting „setting_server“ and download the settings from that location. If none of the steps succeed, the user agent uses a default value (for snom phones, for example http: //www.snomag.de/snom200/snom200.htm). Practically, that means you should try the following setups: •...
  • Page 53: Mac Addresses

    “:” symbols between the digits. If you enter incomplete MAC address, the proxy will automatically complete it with the “000413” prefix of snom phones. If you want to remove an assignment, just clear the respective field in the list and press “Save”.
  • Page 54: Settings

    The setting names and their meanings depend on the used products. Please refer to the product documentation for this purpose. However, the snom 4S offers a set of standardized settings. These settings are the language, the tone scheme and the time zone which can be selected via a select input.
  • Page 55: Software Version

    Before the proxy offers a software version, it matches some fields. The “vendor” field represents the manufacturer of the end point, the product the product name (for snom, the vendor name is “snom”, the product “snom100” for snom 100, “snom105” for snom 105, “snom200”...
  • Page 56 4 S P S N O M R O X Y E G I S T R A R A N U A L 56 • Automatic User Agent Confi guration...
  • Page 57: Registration

    User agents register for a specific amount of time. If a user agent does not refresh a registration before this time, the registration is silently discarded. The registration time may be limited to a minimum and maximum time. Limiting the minimum registration time avoids too many snom technology AG • 57...
  • Page 58: Keep-Alive Registry 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 refreshes which cause network overhead. Limiting the maximum registry time reduces the danger of a user agent being unreachable for a longer period of time.
  • Page 59 This is the purpose of this setting. However, there may be cases when the proxy should accept these registrations. In these cases you should turn this flag to off. snom technology AG • 59...
  • Page 60 4 S P S N O M R O X Y E G I S T R A R A N U A L 60 • Registration...
  • Page 61: Routing

    11 Routing Routing is one of the most important tasks of the proxy. As you can 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 62: 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 If you leave the field blank, the proxy will forward any packet without challenging. If you enter just “*”, the proxy will challenge every request.
  • Page 63: System Administrator Settings

    The name of the domain which is used for this is stored in this setting. This name must be the primary name of the domain, not an alias name. snom technology AG • 63...
  • Page 64: Enum Suffix

    4 S P S N O M R O X Y E G I S T R A R A N U A L 11.2.3 ENUM Suffix When converting a tel URL into a URL, the proxy needs a suffix for the translated telephone number.
  • Page 65: 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 66: Dial Plan

    4 S P S N O M R O X Y E G I S T R A R A N U A L 11.3 Dial Plan 11.3.1 How it works The dial plan is a flexible way to tell the proxy what to do with calls that do not go to a registered user.
  • Page 67: Call Pickup

    The proxy checks all rules of the dial plan. This has the effect that the last matching rule will be executed, not the first one. 11.3.2 Call Pickup The proxy may initiate a call pickup for an account that is being snom technology AG • 67...
  • Page 68: Example 1: North American Dial Plan

    4 S P S N O M R O X Y E G I S T R A R A N U A L called. In order to use this feature you must use the dialog agent feature on the proxy and the call destination must be an account on this proxy. Both hunt groups and normal accounts may be picked up.
  • Page 69: Example 2: Do Not Allow Cell Phone Numbers To Certain Users

    SIP URL. While most VoIP phones can not display http content, they can place a call to an announcement server that reads out the error message. This means that the system is much snom technology AG • 69...
  • Page 70 “{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 71: Call Hunting

    The ringing melody that you select for the stage is proposed by the proxy in the call setup message. This feature depends on the SIP user agent that is used. If it does not support this feature, it will ring with its snom technology AG • 71...
  • Page 72: Defining The Algorithm

    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 ringing melody. When you create a hunt account, it does not contain stages in the beginning. Whenever you want to add another stage, simply fill in the empty line and press the save button.
  • Page 73: Default Actions

    You may also specify a SIP return code. In this case, you should choose a 4xx-class code. To do this, simply put the error code in front of the message like “404 This was not found”. By default, the proxy will use code 480. snom technology AG • 73...
  • Page 74 4 S P S N O M R O X Y E G I S T R A R A N U A L 74 • Call Hunting...
  • Page 75: Address Books

    In order to make SIP telephony a more enjoyable experience, the proxy searches the above listed address sources for completions of numbers. This mechanism works between snom phones and the snom 4S; however other vendors can easily integrate this feature into their products. 13.2 Defining Address Book Groups To set up an address book group, enter a name for the group and set the members.
  • Page 76: Setting Up An Address Book

    4 S P S N O M R O X Y E G I S T R A R A N U A L administrator for this group. This account will be able to set and change the actual address book. 13.3 Setting Up an Address Book The administration of the address book is described in the user manual.
  • Page 77: Controlling

    In office environments, the controlling department typically needs to distribute the telephone bill on cost or profit centers at the end of each month. The snom 4S proxy supports this task with the controlling settings. Controlling is not billing. The information that you receive from the controlling module does normally not match the exact cost that a call caused.
  • Page 78: Defining Groups

    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 “Normal” type beautifies the destination URL before feeding into the rate pattern matching algorithm. That means that it strips the domain name (if it is in the domain context) and removes the scheme and parameters.
  • Page 79 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 data are automatically reflected in the sums. snom technology AG • 79...
  • Page 80 4 S P S N O M R O X Y E G I S T R A R A N U A L 80 • Controlling...
  • Page 81: Message Handling

    When a new user signs in for the first time, the proxy may send him or her a welcome message which is initiated by the proxy. This is a nice feature that informs users about the operator’s capabilities or downloads operator images onto the phones. When the snom technology AG • 81...
  • Page 82 4 S P S N O M R O X Y E G I S T R A R A N U A L location of the attachment file changes, the proxy notifies all registered users about the change. The proxy allows two methods for notifying users: MESSAGE and NOTIFY.
  • Page 83: Status Reports

    • Name: The name of the user as given in the registration. • User: The account that is used as identification in the proxy. This corresponds to the “telephone number” of the user within the proxy snom technology AG • 83...
  • Page 84: 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 realm. • Registrar: The registrar the user is registered on. This is one of the names listed in the hostnames. •...
  • Page 85: Call Logs In The Web Interface

    If network elements violate this rule, the packets do not flow through the proxy and the proxy is not able to determine the length of the call. Please remember that the call log is sensitive information and snom technology AG • 85...
  • Page 86: Call Attempts

    4 S P S N O M R O X Y E G I S T R A R A N U A L should not be accessible to unauthorized persons. See the comments on security in this manual. 16.2.3 Call Attempts Similar to the finished calls the proxy keeps a list about the not- finished calls.
  • Page 87: Logs

    16.4 Logs If you want to see the log file, just go to the Log file menu item. To clear the log, go to the bottom and click on “Clear”. snom technology AG • 87...
  • Page 88: Unavailable Hosts

    4 S P S N O M R O X Y E G I S T R A R A N U A L 16.5 Unavailable Hosts The proxy keeps a list of IP addresses that did not respond to SIP messages.
  • Page 89 The web interface gives information on the number of allocated objects. This information 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 • 89...
  • Page 90 4 S P S N O M R O X Y E G I S T R A R A N U A L 90 • Status Reports...
  • Page 91: Billing

    (using a named pipe). This way, a very simple call processing can be done. 17.1.2 XML-Based format When using the “sip:” prefix in the Call Log File setting, the proxy sends SIP NOTIFY messages to the provided destination instead of writing snom technology AG • 91...
  • Page 92 <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 93: Radius

    A N U A L snom. 17.2 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 94: 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 96 Aktiengesellschaft Pascalstr. 10B, 10587 Berlin, Germany Phone/ENUM: +49 (30) 39833-0 mailto:info@snom.com http://www.snom.com sip:info@snom.com © 2001-2004 snom technology AG All rights reserved.

Table of Contents