Snom 4S SIP Proxy Administrator's Manual
Snom 4S SIP Proxy Administrator's Manual

Snom 4S SIP Proxy Administrator's Manual

Sip proxy version 2.44
Table of Contents

Advertisement

Quick Links

Administrator's
Manual
snom 4S
SIP Proxy
Version 2.44

Advertisement

Table of Contents
loading
Need help?

Need help?

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

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Snom 4S SIP Proxy

  • Page 1 Administrator‘s Manual snom 4S SIP Proxy Version 2.44...
  • Page 2 © 2005 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 Proxy and is supplied on an “AS IS” basis, that is, without any warranties whatsoever, express or implied.
  • Page 3: Table Of Contents

    Going to a domain context ..........21 Determining the Domain Context ........21 3.5.1 Purpose ....................................3.5.2 Usage ......................................Backup ............... 22 Login ............25 Sessions ..............25 Login ................25 Creation of Accounts ............ 26 Logout ................ 27 System Settings ..........29 snom technology AG • 3...
  • Page 4 4 S P S N O M R O X Y A N U A L License ............... 29 Port Bindings ............... 30 5.2.1 Binding to the right address ................................................5.2.2 Receiving forwarded packets 5.2.3 SIP, HTTP and RADIUS Port ........................
  • Page 5 7.5.2 Defining Address Book Groups 7.5.3 Setting Up an Address Book ........................Error-Information ............72 Script ................. 73 Account Administration ..........73 7.8.1 Purpose ................................................... 7.8.2 Setting up an account from the web interface snom technology AG • 5...
  • Page 6 4 S P S N O M R O X Y A N U A L 7.8.3 Setting up a hunt group and pickup group ..................................... 7.8.4 Changing Normal User Settings 7.8.4.1 Authentication Name ............................7.8.4.2 Single Registration ..........................................................
  • Page 7: Foreword

    file system. Compared with the 2.42 version, there are several new features like pickup groups. Detailed information about the changes between the release can be found in the proxy release notes. snom technology AG • 7...
  • Page 8: Software Updates From 2.2X

    IP address. Therefore, the list of hostnames should now include the IP address of the host. If you have problems with this, please contact mailto:sales@snom.de, please include the old license information. We will give you a new license key in this case.
  • Page 9: Installation

    Tip: If you are doing an update, you need to stop and uninstall the old proxy first (see below on how to do this). After double clicking on the setup executable, the installations program starts up. Press Next to begin the installation. snom technology AG • 9...
  • Page 10 4 S P S N O M R O X Y A N U A L At the beginning of the installation the setup program asks you to accept the license conditions. Please read them carefully, then select the “accept” button and press “next” to accept the conditions. If you decline, the installation will be aborted.
  • Page 11 After this, the installation asks you for the location where the proxy information will be put. This directory needs write access and will contain the information for registered users. The snom technology AG • 11...
  • Page 12 Windows control interface. Check that the installation has been successful by checking the Services field of Windows. Open the services Window and look for “snom 12 • Installation...
  • Page 13: Uninstalling In Windows

    If you use the CLI you need to be root to install the software. Please go the directory where you saved the RPM after downloading. If this is the first installation of the snom 4S proxy on this host from a RPM package please use the following command to install the software: rpm -ihv snomproxy-2.44.*.rpm...
  • Page 14: Command Line Options

    /etc/init.d/snomproxy start Note: the process will not be started automatically any more like it was with the old snom tarball installation, because user interactions are not possible during a RPM installation, but the port settings should be verified by the user before starting the process.
  • Page 15: Migrating 2.42 Files

    DNS SRV is also a way to specify other port numbers than the default port number for a service. DNS A is the simple DNS address resolution mechanism we know from the old days that resolves exactly one address. snom technology AG • 15...
  • Page 16: Dns Example

    4 S P S N O M R O X Y A N U A L We recommend setting up DNS SRV so that you can redirect the SIP services to a different host than your main server. This way, you can use the same email addresses for a user as the sip address.
  • Page 17: Using The Proxy Without Dns

    PSTN gateway. This also means that you will not be able to have a redundant system setup. Because of this and for the sake of simple system extension, we recommend to use DNS setup. snom technology AG • 17...
  • Page 18 4 S P S N O M R O X Y A N U A L 18 • Installation...
  • Page 19: Domains

    Domains The snom 4S proxy supports multiple domains on one proxy. This is a powerful feature that allows a proper routing or requests according to the SIP and IETF paradigm of DNS domains. A domain defines a specific view on the proxy. Each domain has its own log, its own user list, its own dial plan, its own registration policy, its own password, its own welcome message policy, and so on.
  • Page 20: Creating A Domain

    4 S P S N O M R O X Y A N U A L Creating a domain To create a domain, you must log on with the administrative account of the proxy. Go to the domain administration web page and enter the primary name of the domain.
  • Page 21: Edit A Domain

    3.5.1 Purpose Operating the proxy in a multiple domain environment gives the 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 22: Usage

    4 S P S N O M R O X Y A N U A L using the literal domain name. This is necessary in order not to confuse the user-agents. 3.5.2 Usage When a request comes into the proxy, it must make a decision under which domain context the request should be processed.
  • Page 23 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 • 23...
  • Page 24 4 S P S N O M R O X Y A N U A L 24 • Domains...
  • Page 25: Login

    The domain administrator mode has rights restricted to a specific domain. To login as domain administrator, just enter the password (no username) and select the domain from the pull down menu. By default, the password is empty. snom technology AG • 25...
  • Page 26: Creation Of Accounts

    4 S P S N O M R O X Y A N U A L If you want to log on as a specific user, enter the username and the password for that user and select the domain of that user. Depending on your login type, the proxy will load the starting page for the login type.
  • Page 27: Logout

    On every web page, you will find a logout link. If you use this link, the proxy will delete the session and redirect you to the login page. If you don’t log out explicitly, the proxy will delete the session after a timeout (see settings of the administrator mode). snom technology AG • 27...
  • Page 28 4 S P S N O M R O X Y A N U A L 28 • Login...
  • Page 29: System Settings

    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 are „proxy.
  • Page 30: Port Bindings

    4 S P S N O M R O X Y A N U A L The proxy counts the number of accounts. This is done once after the proxy starts, therefore for large installations starting the proxy may take some time. Whenever you create a new account or delete an account, the proxy changes the number of used accounts.
  • Page 31: Receiving Forwarded Packets

    “Bind Address” which means that the proxy is using the address which it bound to. If you want to use something else than bind address, you must specify which port the proxy should assume. snom technology AG • 31...
  • Page 32: Sip, Http And Radius Port

    4 S P S N O M R O X Y A N U A L If you choose to operate the proxy in a DMZ, you should make sure that the proxy can be reached both from private as well as from public addresses via the address which you have specified.
  • Page 33: System Settings

    The proxy keeps a list of the last SIP packets. You can access this list also through the web interface. The Internal SIP Trace Length is the length of this list. snom technology AG • 33...
  • Page 34: Caches

    4 S P S N O M R O X Y A N U A L The Internal LOG Length is the number of log messages that the proxy keeps in memory for the display on the web interface. 5.3.2 Caches The proxy uses in several places caches.
  • Page 35: Subscription Size

    For this purpose, the Unavailable Host TTL (time to live) has been put into the proxy. It is the number of seconds that the proxy considers an IP address and port unavailable after a request timeout. snom technology AG • 35...
  • Page 36: Agents

    5.3.6 Number Guessing Number guessing is a snom-proprietary way of completing user input on the phone. When the phone tries to complete a number, it sends a request to the proxy. The response may contain a list of possible number that the user might wants to enter.
  • Page 37: Email

    Authenticated SMTP. The SMTP server may be a DNS name or an IP address. Please don’t use port numbers behind the name; the proxy expects the SMTP server on the standard port. snom technology AG • 37...
  • Page 38: Configuration In Xml

    4 S P S N O M R O X Y A N U A L The Email URl is the email address that will be used for sending emails. It must include the “@” character. The display name is the name that will be rendered to the user.
  • Page 39 • Domain Admin Mode Access: All web pages that are accessed by the domain administrator. • System Admin Mode Access: All web pages that are accessed by the system administrator. • Settings and Software Provisioning Access: Web pages that serve settings and software update information. snom technology AG • 39...
  • Page 40: Administrator Access

    4 S P S N O M R O X Y A N U A L All other web pages (images, software images) are transferred insecure. Typically, it is ok to require https for all access which is done with a web browser (as most web browsers support https access).
  • Page 41: Billing Settings

    The proxy will then present this certificate when a client connects to the web server. Billing Settings The snom 4S proxy 2.44 supports RADIUS billing. This is by far the most popular billing method, which is now wholeheartedly supported by the proxy.
  • Page 42: Radius Settings

    4 S P S N O M R O X Y A N U A L 5.5.1 RADIUS Settings The RADIUS server IP is the IP address of the RADIUS Server (e.g. 1.2.3.4). This setting does not support DNS resolution, you must enter the IP address here.
  • Page 43: Radius Scripting

    This value is used in the header P-Session- Timeout header and indicates attached user agents how long the session will last. The snom 4S NAT Filter will use this setting to limit the duration of the call. This makes it possible to implement prepaid services.
  • Page 44 Please note that there will be no Stop Accounting request without BYE request. That means you should always make sure that at least one side of the call disconnects properly. For example, the snom 4S NAT Filter will generate a BYE request if one of several timeout reasons fire.
  • Page 45: Domain Determination/Administration

    Messages in SIP may hop over a number of proxies, and sometimes the path contains loops. Sometimes the loops are endless, and in these situations the criterion for rejecting a message is to look at the number of hops the request has done so far. snom technology AG • 45...
  • Page 46: Enum Suffix

    4 S P S N O M R O X Y A N U A L This setting controls how many hops a request can make before it is rejected as an endless loop. 70 is the default value; in many environments you can significantly lower this value.
  • Page 47: Loose Routing Flag

    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 48: Symmetric Responses

    However, in order to operate devices behind NAT, we strongly recommend to use the snom 4S NAT Filter to solve these problems. Redundancy When DNS SRV is used, two snom 4S proxies can handle the requests of a user agent.
  • Page 49: Shutting Servers Down

    NFS server might become bottleneck for the overall stability (you should not use a network server for storing the files anyway). Other examples include DHCP server, PSTN gateways, network routers, and power supply. snom technology AG • 49...
  • Page 50: Refresh Rate Considerations

    4 S P S N O M R O X Y A N U A L 5.8.3 Refresh rate considerations Database replication causes additional traffic for the proxies. Therefore, if you have a highly reliable system, it is tolerable to choose long refresh intervals for registrations (for example, one hour).
  • Page 51: Exceptions

    When you use UDP transport layer, the maximum size for a file is a little bit less than 64 KB. Therefore, the proxy will not replicate files with a bigger size. Usually, files on the snom 4S proxy don’t become so big, therefore it should not be a problem.
  • Page 52: Security

    4 S P S N O M R O X Y A N U A L the address. In this case, the proxy will resolve the address using DNS For making the exchange of registration information more secure, you can enter a username and a password. This will be used by the proxy for challenging incoming replication requests.
  • Page 53 The html directory describes the path where the proxy will look for customized web pages. If you are interested in designing your own web pages, please contact snom. However, the customization will take a significant effort.
  • Page 54 4 S P S N O M R O X Y A N U A L 54 • System Settings...
  • Page 55: System Status

    (so it would trigger a RADIUS request). First, the call goes into the Current Calls list. After the proxy receives a BYE of the call times out, it goes into the Call Log. snom technology AG • 55...
  • Page 56: Current Calls

    4 S P S N O M R O X Y A N U A L The call log has the following fields: • Date/Time: The date and time when the call started (in GMT). • Duration: The duration of the call in hours, minutes and seconds. •...
  • Page 57: Sip Trace

    If you have a lot of packets flowing through the proxy, it might be that older packets are no longer available. snom technology AG • 57...
  • Page 58: Replication Trace

    4 S P S N O M R O X Y A N U A L Replication Trace The replication trace is similar to the SIP trace, but filtered by replication messages. This way, you can keep a better overview on these two issues.
  • Page 59: System Information

    System Information The system information web page shows you what version of the proxy you have and what license type you are using. You also see how many licenses you are currently using on that system. snom technology AG • 59...
  • Page 60 4 S P S N O M R O X Y A N U A L 60 • Specifi c Account Types...
  • Page 61: Domain Settings

    The E911 Location header is inserted into INVITE packets when the location information is available for a specific user. The setting on this web page merely specifies the name of the header as this has not been standardized yet. snom technology AG • 61...
  • Page 62: Authorization

    4 S P S N O M R O X Y A N U A L 7.1.3 Authorization Authorization deals with the problem that users first must make sure that they really are who they pretend to be. This is important when users want to access valuable resources, specifically resources that cost money.
  • Page 63: Canonical Names

    However, be careful with this feature. Every account that is being set up adds another license to the system. Therefore, we strongly recommend not using this feature for an open community, for example on the public Internet. snom technology AG • 63...
  • Page 64: Min/Max Registry Time

    4 S P S N O M R O X Y A N U A L 7.2.2 Min/Max Registry Time With these two settings you control for how long a user agent may register. The minimum value limits the number of REGISTER requests, which may be important if you have many user agents.
  • Page 65 • “Call User” tells the proxy to fork the request to all registered users. You must provide the user as argument, without a scheme before it and without a domain name behind it. • “Deny” tells the proxy to forbid this number (error code 403 Forbidden). snom technology AG • 65...
  • Page 66 4 S P S N O M R O X Y A N U A L • “Redirect” tells the proxy to redirect the call to the URI (including scheme and domain) in the argument. • “Redial” tells the proxy to search the last dialled number and forward the request to that number.
  • Page 67: Call Pickup

    Therefore, the call must be forwarded to a media server account, where the user hears an announcement “thank you for your feature code”. The URI for this announcement if for all feature codes the second word of the argument. snom technology AG • 67...
  • Page 68: Example 1: North American Dial Plan

    4 S P S N O M R O X Y A N U A L The optional third argument tells the proxy where to redirect a call (home number or road number). Corresponding to the web interface there are four codes: DND On: This puts the user offline.
  • Page 69: 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 70: Defining Groups

    4 S P S N O M R O X Y A N U A L the patterns. You can define a new group by using the last empty line; to remove a group, just remove the name of that group. The price is measured in units per minute.
  • Page 71: 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.
  • Page 72: Setting Up An Address Book

    4 S P S N O M R O X Y A N U A L 7.5.3 Setting Up an Address Book The administration of the address book is described in the user manual. Error-Information Error-Information is not directly part of the routing. This feature merely provides the user agent client with additional information if a request fails.
  • Page 73: Script

    “{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. If you leave the generic destination empty and no specific code has been set up, no error-information will be generated.
  • Page 74: Setting Up An Account From The Web Interface

    4 S P S N O M R O X Y A N U A L bob also under these alias names without about having to register these alias names as well. For example, you could set up bob.miller and bm as alias and then what would also be reachable under the SIP URL sip: bob.miller@company.com and bm@company.com.
  • Page 75 If you using the Japanese version of the proxy, you may also insert a “reading” field that will be used when you search a user. snom technology AG • 75...
  • Page 76: Setting Up A Hunt Group And Pickup Group

    4 S P S N O M R O X Y A N U A L To make the web and SIP access safe, you should provide web and SIP passwords. Please remember that if you don’t provide a SIP password, practically everyone can spoof the identity and use the resources of the proxy that this user has.
  • Page 77: Changing Normal User Settings

    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 snom technology AG •...
  • Page 78: 7.8.4.3 User-Visible Settings

    4 S P S N O M R O X Y A N U A L is challenged. If there is a match, the proxy accepts challenges from the 3rd party account. For example, when you put the patterns “41* 42*” in the Answer Challenging for Account-Pattern setting, the account with this setting may register accounts on behalf 411, 412, 413, 420, 421 and so on.
  • Page 79 The ring melody that should be used when the user is being called. The default value is „default“, other valid values are „melody1.wav“ … „melody8.wav“. single If set to „true“ the user may register only one contact. webpass The web password for this user snom technology AG • 79...
  • Page 80: Account List

    4 S P S N O M R O X Y A N U A L registrations, These names are reserved for internal use by the proxy. domain, last_ mwi, messages, mwi, type A typical example would look like this: alias display_name email_address...
  • Page 81: Plug And Play

    • If a username and a proxy name have been specified on the user agent (manually), it will contact the SIP server on the specified location (for example, if the user agent registers as sip:123@company.com, it will contact company.com). snom technology AG • 81...
  • Page 82: 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.snom.com/snom360/snom360.htm). Practically, that means you should try the following setups: •...
  • Page 83: 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 84: 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 85: 7.11 Other Status Information

    7.12 LED Notifications In a PBX environment, you want to see the status of incoming calls and the status of your colleagues. The snom 4S proxy supports two methods to do this. The first method uses a document that is currently being in the IETF (dialog-state).
  • Page 86: 7.12.1 Dialog-State Notifications

    4 S P S N O M R O X Y A N U A L 7.12.1 Dialog-State Notifications The previous versions of the proxy had a “dialog agent” which was monitoring the incoming and outgoing packets of the proxy. From these packets, it was trying to determine the call state of extensions.
  • Page 87 INVITE request to the proxy with the header “Replaces” set to the Call-ID in the XML attachment directed to the target URI in the attachment. An example could look like this: INVITE sip:120@domain.com SIP/2.0 Via: SIP/2.0/UDP 192.168.166.158:2051;branch=z9hG4bK- eega5da2s6ki;rport From: <sip:401@domain.com>;tag=2b9z6djnhi snom technology AG • 87...
  • Page 88: 7.12.2 Domain State Notification

    4 S P S N O M R O X Y A N U A L To: <sip:120@domain.com> Call-ID: 3c28d0db04e2-by5grmyr94n4@snom360 CSeq: 1 INVITE Max-Forwards: 70 Contact: <sip:401@domain.com;gruu=bu8m0mwa> Replaces: 0024-0032-C0B1648A-0@192.168.0.247 Accept: application/sdp Content-Type: application/sdp Content-Length: 420 o=root 1666958159 1666958159 IN IP4 192.168.166.158 s=call c=IN IP4 192.168.166.158 t=0 0...
  • Page 89: 7.12.3 Call Pickup And Takeover

    401). When an entry in the dial plan matches the pattern, the proxy searches the incomplete calls of the account. It takes the first call which is not connected and redirects the pick up call. snom technology AG • 89...
  • Page 90 4 S P S N O M R O X Y A N U A L The proxy has to route the pick up INVITE to the final destination, because the user agent does not have this route. Therefore, the incomplete call is marked for pickup;...
  • Page 91: Call Hunting

    (in seconds). If you do not provide a value in this field, the proxy will automatically choose a value of 10 seconds. 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 snom technology AG • 91...
  • Page 92: Defining The Algorithm

    4 S P S N O M R O X Y A N U A L agent that is used. If it does not support this feature, it will ring with its default ringing melody. When you create a hunt account, it does not contain stages in the beginning.
  • Page 93: 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 • 93...
  • Page 94 4 S P S N O M R O X Y A N U A L 94 • Hunting...
  • Page 95 Reader‘s Feedback snom technology AG welcomes your evaluation of this manual and any suggestions you may have. These help us to improve the quality and usefulness of our documentation. Please send your comments and suggestions to: snom technology AG Attention: Marketing Department Pascalstr.
  • Page 96 AG snom 4S Proxy Pascalstr. 10B Administrator Manual 10587 Berlin, Germany 27. Jan 2005, Version 2.44 Phone: +49 (30) 39833-0 © 2005 snom technology AG mailto:info@snom.com All rights reserved. http://www.snom.com Subject to change without notice. sip:info@snom.com...

This manual is also suitable for:

4s media server

Table of Contents