F REQUENTLY A SKED Q UESTION - Snom

More documents

Recommendations

Info

Problem Statement In some environments, users of the snom 4S would like to be able to automatically perform actions such as registering new users and deactivating accounts. In principle, these actions are not critical to performance. The snom 4S software components have a built-in web server that supports the features required. It therefore makes sense to have a “remote control” that uses the web interface of the Proxy or the Media Server in the same fashion as real users do. The snom 4S does not recognize that a shell script controls its behavior. Initiating Web Access from the Command Line Interface The problem of controlling a remote web server from a shell is well known. There are programs available for performing this task - “curl” is available for Linux and for Windows and can be integrated into shell scripts and PHP programs. For more information, see http://curl.haxx.se. Other web programs work in a similar way. The proxy and the media server do not differentiate between POST and GET with parameters in the URL. Parameter values are “url-encoded”. That means that some special characters have a particular meaning. For instance, the “&” is a separator symbol between the parameters, the “+” means a space character and “=” is used to indicate an assignment of a value to a variable. If you want to encode one of these special characters (and other characters that are not in the normal character set), you can use the % followed by the two-digit hex code of the character to encode the character that you need. If in doubt, you should use the %xx notation. [ F R E Q U E N T L Y A S K E D Q U E S T I O N ] Proxy Version 2.3x and Higher In the 3.x versions of the proxy, we use a scripting language to control the behavior of the proxy. When the proxy receives a request to post information to a predefined webpage (post.htm), it first determines the domain and the password for this domain. If there is a match, it sets all variables in the http post accordingly and calls the subroutine “on_post”. This function can then perform the necessary actions (a predefined behavior is available, see below). Sending information to the proxy does not require a session context. For example, if you use “curl http:// myproxy:8080/post.htm?domain=abc.com&p ass=secret&var1=abc&var2=hello+here%21” , the proxy will execute the function “on_post” in the domain context of “abc.com” (if it exists and the password is “secret”). The variable “$var1” will be set to “abc” and the variable “$var2” will be set to “hello here!”. The Default on_post() Function The proxy comes with several predefined default functions. If you load another on_ post() function in the domain, these functions are overwritten. The default script uses the variable “action” to indicate what the proxy should do. • create_user: This function uses the variables “account” (which indicates the account to use), “username” (which indicates the user name for challenging) and “password” (the password for challenging) to create or update a user account. • delete_user: This function deletes a user account (indicated in the variable “account”). • disable_user: This function disables a user account (indicated in the variable “account”). • enable_user: 2 snom technology AG
This function enables a user account (indicated in the variable “account”). Available Actions for the Proxy Versions 2.2x We highly recommend upgrading to proxy versions 2.3x or higher. However, if you do wish to continue operating the 2.2x or previous versions, you will need to use a different web interface. You can take a look at the html source code before pressing the “save” button to a web request in order to see which parameters are used to post a request. This chapter shows and explains to you which parameters are valid. Setting Parameters in 2.2x Setting parameters is carried out with the SAVE=Save parameter. The table on the next page shows which parameters are available (also see the manual). For example, to set the retry_t1 time, you would use: curl -d save=save -d retry_t1=400 -u user:pass myproxy.com:5068 >/dev/null Add a User To add a user, use the parameters Domain, Account, Username and Password as described in the snom 4S Proxy/Registrar manual and add the ADD_USER=Add/Edit parameter. Example to add a new user: curl -u user:pass -d ADD_USER=add/ edit -d domain=bla.com -d account=testc -d username=testc -d password=1234 myproxy.com:5068 >/dev/null Remove a User in 2.2x To remove a user, set the argument userdel to the account name of the user you want to remove. No additional parameters are required. Make sure that the domain name is [ F R E Q U E N T L Y A S K E D Q U E S T I O N ] separated from the user name by a space. Example: curl -d userdel=”bla.com testc” -u user: pass myproxy.com:5068 >/dev/null Add a Dial Plan Element in 2.2x Adding an element to the Dial Plan is similar to adding a user. The parameter SaveAdr must be set to Save. The values for the dial plan are stored in the variables apa[x], apb[x], apc[x] and apd[x]. x starts from 0 for the first entry and continues until a empty line has been found. apa elements may have the value allow, deny, incomplete, gateway or notfound according to the meaning described in the manual. apb, apc and apd have the values described in the manual. Add Error-Info Element in 2.2x The error-information list is handled in a similar fashion to the dial plan. The variables manipulated here have the name eia[x] and eib[x]. eia takes the error code (e.g. 404), eib the destination url. Parameters for 2.2x The following list shows the available parameters: Remote Control for snom 4S 3
Page 1: F REQUENTLY A SKED Q UESTION Contro
Page 5: Europe & ROW: snom technology AG Pa

F REQUENTLY A SKED Q UESTION - Snom

Create successful ePaper yourself

Delete template?

Save as template?