New Rock Devices Auto Provisioning Configuration Manual
Contents
1. Enable IPv6 Default Help Cancel New Rock Technologies Inc 27 Auto provision Configuration Manual Step 2 Click Settings and click the DHCP tab Then configure relevant parameters and click OK Figure 4 7 DHCP Configuration Interface for Tftpd32 S Tftpd32 Settings im GLOBAL TFTP pe SYSLOG DHCP Pool definition Size of pool Boot File WINS DNS Server 13216825 Default router 3215821 Mask 255 255 0 0 Domain Name Additional Option 55 192 168 25 DHCP Options Ping address before assignation Bind DHCP to this address 192 163 250 221 Persistant leases Default Help Cancel Table 4 2 DHCP Configuration Parameters of Tftpd32 Parameter Description IP pool starting address Available starting address Size of pool Total number of available addresses WIN DNS Server DNS server address Default router Default router address Mask Subnet mask that corresponds to the available address segment Additional Option Extended DHCP option You need to set this parameter to 66 and set the address beside it to the address of the TFTP server Bind DHCP to this address Select this option to specify the IP address of the DHCP server Step 3 Log into the Web GUI of the device choose Basic gt Network select DHCP from the IP address assignment drop down box and then click Submit New Rock Technologies Inc 282. Auto provision Configuration Manual Figure 4 8 Network Configuration Interface oc LL LZ Status KNetwork Dsystem SIP MGCP FoIP Logout Host name MX8 VoIP AG Contain letter number and but must start with letter Io m cM U C RESO UA E A MAC address 00 0E A9 31 0B 69 IP address assignment TG NEN IP address 192 168 250 52 Gateway IP address 192 168 2 1 1 o Embeg Primary server 192 168 2 1 e g 202 96 209 6 Secondary server e g 202 96 209 133 D Primary server 198 60 22 240 Secondary server 133 100 9 2 Time zone GMT 08 00 Beijing Submit Note e The GUI display may vary according to different device models Configuration sequences and items however are almost the same as described in this document Step 4 Click Advanced gt System select Auto provision Then select DHCP and Firmware upgrade if a firmware upgrade is not required do not select this option and select an update mode Two update modes are available e Power on The device detects whether to upgrade its configuration and firmware using those on the ACS only when the device is started e Power on Periodical Upon powering on the device detects whether to upgrade its configuration and firmware using those on the ACS The device will also periodically at a specific update interval detect whether to upgrade it
3. PHONE 3 PASSWD_3 REG_3 PHONE_4 PASSWD_4 REG_4 New Rock Technologies Inc 21 Auto provision Configuration Manual 3 4 Encrypting a Configuration File Optional To prevent device configuration data from being intercepted you are advised to use encryption tools mxenc for Linux or enc windows exe for Windows which are developed by New Rock Technologies Inc to encrypt a configuration file before placing the configuration file on the ACS Encryption on a Linux PC Step 1 Obtain the encryption tool mxenc and install it on a Linux PC Step2 Run the chmod 777 mxenc command to ensure that the encryption tool mxenc is executable Step 3 Upload the configuration file to the directory where the encryption tool mxenc is located Step 4 Start the encryption tool mxenc using the Amxene Name of the unencrypted file Name of the encrypted file MAC address command The encrypted file must be named in accordance with the formats described in Section 3 1 Configuration Files The name of the unencrypted file does not need to follow these formats Encryption on a Windows PC Step 1 Obtain the encryption tool enc windows exe and install it on a Windows PC Step 2 Upload the configuration file to the directory where the encryption tool enc windows exe is located Step3 Start enc windows exe and enter the name of the unencrypted file the name of the encrypted file and the MAC address of the device in sequence according to p
4. Periodically No EN_URL in the configuration file Yes gt Download the MAC naming file Transfer the MAC naming file Read firmware upgrade packeg URL x Transfer the firmware upgrade package Download the firmware upgrade package Note e If DHCP option 66 is s or a HTTPS server elected to broadcast the URL of ACS the ACS can be a TFTP server a HTTP server e The ACS URL can be in IP address or domain name format If the ACS URL is in later format you need to configure and enable the DNS server on the device log into the Web GUI of the device and choose Basic gt Network enter the IP Submit address of the primary DNS server in the Primary server text box and then click e Currently HTTP HTTPS supports the basic access authentication mode only New Rock Technologies Inc Auto provision Configuration Manual 2 Establishing the ACS This chapter uses the TFTP server as an example to describe how to set up the ACS The TFTP server can be established using software such as 3CDaemon or Tftpd32 In the following description tftpd32 is used as an example Note that tftpd32 can also be used to establish a DHCP server Step 1 Create a root TFTP directory on the local computer and place the configuration files to this root directory For preparing the configuration files see Chapter 3 Preparing Configuration Files Step 2 Do
5. 13 Auto provision Configuration Manual Node Name Parameter Meaning Value Range DTMF METHOD DTMF transmission 2833 RFC2833 mode AUDIO transparent transmission INFO SIP INFO 2833 INFO RFC2833 SIP INFO DEFAULT_CODEC Codecs supported by See User Manual or device Administrator Manual of each device OPTIONAL SDP_USING_NAT SDP using NAT address Yes A WAN address is used switch No A local IP address is used NAT_KEEP_ALIVE NAT traversal switch on enabled off disabled NAT_EXPIRE NAT refresh interval Value range More than 14 seconds the default value is 60 seconds COUNTRY Country cal 1 ing Refer to List of ITU T code Recommendation E 164 Dialling Procedures as of 15 December 2011 ITU DIGIT_ON_TIME DTMF tone duration The duration time range is 50 to 150 ms The default value is 100 ms DIGIT_OFF_TIME DTMF Interdigit pause The duration time range is 50 to 150 ms The default value is 100 ms NETWORK LLDP ENABLE LLDP switch on enabled off disabled Note These parameters are applicable to all device models as described in this document LLDP TX INTERVAL LLDP message sending 5 3600 seconds the default value is interval 30 seconds Note This parameter is mandatory when LLDP is enabled DATA VLAN Global VLAN on enabled off disabled Note Global VLAN must be disabled when multi service VLAN is enabled DATA VLAN TAG Global VLAN tag Value range 1 4094 DATA VLAN QOS Glob
6. 211 148 35 16 7547 Passwor Provisioning code Periodic inform enable Connection request UR Connection request username Wem Ce med e Medemm Periodic inform enable O 1 1 1 O ComedoeqesUR O Connection request password Submit P4 Note e The ACS URL can be in IP address or domain name format If the ACS URL is in domain name format the DNS server needs to be configured e The protocol header tftp ftp http or https must be in lower case e If the device is configured to obtain the ACS URL by using both DHCP and manual configuration the ACS URL carried by DHCP is first obtained Step 2 Select Firmware upgrade if a firmware upgrade is not required do not select this option and select an update mode instead Two update modes are available e Power on The device detects whether to upgrade its configuration and firmware using those on the ACS only when the device is started e Power on Periodical Upon powering on the device detects whether to upgrade its configuration and firmware using those on the ACS The device will also periodically at a specific update interval detect whether to upgrade its configuration and firmware using those on the ACS If this mode is used the update interval needs to be specified New Rock Technologies Inc 25 Auto provision Configuration Manual Figure 4 3 Setting the Update Mode to Power on NAT traversal
7. applicable to MX100G devices ISDN TYPE X Signaling Standard The variation of ISDN PRI signalling standards CCITT ND DMS100 DMS250 and 5ESS You are recommended to select NI2 for T1 card and CCITT for E1 card ISDN HUNT X Search mode of idle time slot e FORWARD In the case of an incoming call the MX100G first checks whether timeslot 1 is idle If not the MX100G checks whether timeslot 2 is idle the ascending order until an idle The process proceeds in timeslot is found e BACKWARD The MX100G searches for an idle timeslot in the descending order e CIRCULAR The MX100G searches for the next idle timeslot in the ascending order starting from the time slot used last time The default FORWARD value is Enable or disable ISDN interfaces 0 Disable ISDN interface 1 Enable ISDN1 interface 2 Enable ISDN2 interface 3 Enable ISDN3 interface 4 Enable ISDN4 interface ISDN_GRID_X ROUTE Configure routing rules For details see User Manual or Administrator Manual of each device Note The parameters of almost all functions configurable on the GUI interface of device can be updated in configuration files The same parameter takes effect in both the generation configuration file and the MAC addressed configuration file except for the parameter GEN URL that takes effect only in the general configuration file Parameters take effect in the following files
8. Dynamic NAT Y Refresh period 15 more than 14 s default 60 SDP address NAT IP address Local IP address agement Server tftp 192168 250 221 e g protocol 211 168 5 153 protocol http tftp ftp Management s CH e g http 211 148 35 16 7547 R Submit Figure 4 4 Setting the Update Mode to Power on Periodical Dynamic NAT 15 more than 14 s default 60 NAT IP address Local IP address Refresh perio SDP address T 2 bi a GIS g8 QF lo D E d wo N Server tftp 168 250 221 e g protocol 211 168 5 153 protocol http tftp ftp Firmware upgrade Update mode Power on Periodical 3600 seaergf 5 86400 The terminal performs the auto provisioning process at regular intervals Protocol TRO69 e g http 211 148 35 16 7547 Passwort Provisioning code Periodic inform enable Connection request URI Connection request username Connection request passwor E EE ween E EE LEE SC r T Elleng Periodicinform enable O o S Connection reegen OOOO Connection request username Connection request password 0 Submit Note To detect the firmware upgrade package the FIRM_URL parameter needs to be configured in the configuration file on the ACS For details see Table 3 2 e After the configuration file is updated the device will restart within 40 seconds e Firmware updating involves a firmware update and device restart and takes about
9. SIP proxy address here SIP PROXY Enter the SIP registration server address here SIP_REGISTRATION 192 168 2 100 Basic Rule The first row must be lt config ini gt in lower case without any blank in between If a row starts with it indicates that this row does not take effect The configuration file consists of parameter nodes and parameters and the parameters must be placed under corresponding parameter nodes For example DIGITMAP and SIP are parameter nodes DEFAULT_DIGIT_MAP SIP_PROXY and SIP_REGISTRATION are parameters The parameter DEFAULT DIGIT MAP must be placed under parameter node DIGITMAP Parameters SIP PROXY and SIP REGISTRATION must be placed under parameter node SIP The parameter node must occupy a row separately The parameter node names shall be included in square brackets and shall not contain any blank If the value of a parameter in a parameter row is null the parameter shall still be followed by an equal sign The parameter name and the equal sign are separated from each other using a blank or tab so are the parameter value and the equal sign All parameter node names and parameter names shall be in upper case Editing a MAC addressed Configuration File New Rock Technologies Inc 20 Auto provision Configuration Manual Figure 3 3 MAC addressed Configuration File lt config ini gt PROFILE PHONE 1 PASSWD_1 REG_1 PHONE_2 PASSWD_2 REG_2
10. 3 minutes e After receiving the instruction check sync carried in notify it can be used to control a device restart to trigger the auto configuration process New Rock Technologies Inc 26 Auto provision Configuration Manual 4 2 Obtaining an ACS URL via DHCP option 66 When the IP address of device is obtained by using DHCP the DHCP option 66 address on the DHCP server can be set to the ACS URL The device will automatically detect DHCP option 66 to obtain the ACS URL The ACS carried in DHCP option 66 can only be a TFIP server If the existing DHCP server does not support DHCP option 66 you can establish a DHCP server for configuration Figure 4 5 Auto discovery via DHCP option 66 If you enable Obtain ACS address via DHCP option 66 and also configure the ACS URL on the interface the device attempts to obtain the ACS URL in option 66 from a message sent by the DHCP server at first If this operation fails the ACS URL manually configured on the device is read instead Step 1 Install the DHCP server software Tftpd32 is used as an example Start Tftpd32 click Settings select the GLOBAL tab and tick DHCP Server Start Tftpd32 click Settings click the GLOBAL tab and select DHCP Server Figure 4 6 GLOBAL Configuration Interface for Tftpd32 gt Tftpd32 Settings E m GLOBAL TFTP DHCP svstoa Start Services M TFTP Server I TFTP Client I SNTP server Syslog Server M DHCP Server DNS Server
11. Auto provision Configuration Manual New Rock Technologies Inc Auto Provisioning Configuration Manual Website http www newrocktech com Email gs newrocktech com New Rock Auto provision Configuration Manual Amendment Records Document Rev 03 Sep 2015 Document Rev 02 Nov 2014 Document Rev 01 Jun 2014 Copyright O 2015 New Rock Technologies Inc All Rights Reserved All or part of this document may not be excerpted reproduced and transmitted in any form or by any means without prior written permission from the company New Rock Technologies Inc 1 Auto provision Configuration Manual Contents Amendment 1 Brian CPP HC 2 Contents Of Figure PERO H 3 Contents 0f Lables Sosa ESS 4 JE daga PET pH DE 5 WR KEE 5 1 2 How Autos Provision WOTKkS d nier tere ee e e ep enn dee eee ep Piet usd eee prd e e Pret eene 6 2 Establishing the o oTE oie 8 3 Preparing Configuration gi 10 3 T Contieuration EEN 10 3 1 General Configuration File sci SEELEN EES 10 3 12 MAC addressed leegent tee PR i a e Marne ERR RESP ISSN pe Eed 10 3 2 Common Configuration Parameters 8 nnn Per no aee e RR OH HERR UU 11 3 3 Bditing Configur
12. If the server address is in domain name format the DNS server needs to be configured 2 The redirection file name can be the name of any custom file It can be MA efg indicating the configuration file named after the MAC address of the device where MA must be in upper case 3 Fields tftp ftp http and https must be in lower case 4 This parameter applies to a general configuration file only 5 For details about the application scenarios of this parameter see Scenario 4 in Table 4 2 DHCP Configuration Parameters of Tftpd32 PROFILE PHONE n Phone number of extension set n The value of n ranges from 1 to the maximum number of extension sets supported by the device PASSWD n Password for extension set n REG n Registration flag for extension n on The registration function is enabled for the account of the extension set off The registration function is disabled for the account of the extension set PASSWORD WEB PASSEORD Administrator login password for the Web interface The length is 8 to 16 characters amp and cannot be used WEB OPER PASSWORD Operator login password for the Web interface The length is 8 to 16 characters amp and cannot be used SYSTEM RTP PORT MIN Minimum RTP port number Value range 3000 65535 RTP PORT MAX Maximum RTP port number Value range 3020 65535 New Rock Technologies Inc
13. address is obtained by using DHCP 1 Manually configuring a DNS address by using DHCP when an IP address is obtained by using DHCP Bridge_dhcp_pri_dns Manually configuring address of the primary DNS server when an IP address is acquired by using DHCP Bridge_dhcp_pri_dns Manually configuring address of the secondary DNS server when an IP address is acquired by using DHCP Bridge_pppoe_user PPPoE user name Bridge_pppoe_pass PPPoE password Bridge_pppoe_manual_dns DNS configuration mode when PPPoE mode is used 0 Obtaining a DNS address using PPPoE when an IP address is obtained using PPPoE 1 Manually configuring a DNS address using PPPoE when an IP address is obtained using PPPoE Bridge_pppoe_pri_dns Manually configuring address of the primary DNS server when an IP address is acquired using PPPoE Bridge_pppoe_sec_dns Manually configuring address of the secondary DNS server when an IP address is acquired using PPPoE TZ Time zone TDM These parameters are applicable to MX100G devices TDM_DS1_TYPE Set the interface to operate as an El or T1 interface El or T1 The default value is El TDM DSO TYPE PCM codec It can be aLaw or uLaw The default value is aLaw New Rock Technologies Inc 17 Auto provision Configuration Manual Node Name Parameter Meaning Value Range ISDN These parameters are
14. al VLAN priority Value range 0 7 DATA VLAN GETIP Global VLAN address 1 DHCP acquiring mode 0 STATIC Note When DATA VLAN GETIP 0 DA TA IPADDR DATA NETMASK and DATA DEVICE are mandatory DATA IPADDR Global IP address When DATA VLAN GETIP 0 this parameter is mandatory New Rock Technologies Inc DATA NETMASK DATA DEVICE Global subnet mask Global device address 14 Auto provision Configuration Manual Node Name Parameter Meaning Value Range VOICE VLAN Voice VLAN switch on enabled off disabled Note Voice VLAN must be disabled when the multi service VLAN Mode 2 is enabled VOICE VLAN TAG Voice VLAN tag Value range 14094 VOICE VLAN QOS Voice VLAN priority Value range 0 7 VOICE VLAN GETIP Voice VLAN address 1 DHCP acquiring mode 0 STATIC Note When VOICE VLAN GETIP 0 VOICE IPADDR VOICE NETMASK and VOICE DEVICE are mandatory VOICE IPADDR Voice VLAN IP address When VOICE_VLAN_GETIP 0 this parameter is mandatory VOICE NETMASK Voice VLAN subnet mask VOICE DEVICE Voice VLAN device address SIP FG VLAN Multi service VLAN Mode 2 switch on enabled off disabled Note Voice VLAN must be disabled when multi service VLAN Mode 2 is enabled SIP VLAN TAG SIP VLAN tag Value range 14094 SIP VLAN QOS SIP VLAN priority Value range 0 7 RTP VLAN TAG RTP VLAN tag Value range 1 4094 RTP VLAN QOS RIP VLAN priority Value rang
15. ation Files 3 ere pUUnPReecidiebieie iie nete eie e eMe OE Eae 19 3 4 Encrypting a Configuration File Opponalt netnet nenne trente treni tenter ennt tne trennen 22 4 Obtaining amA CS UJ USE 24 4 1 Manually Configuring the ACS URL 5 eee ete EE dean une EENS er eee re aee haee EE deu nea deua ende 24 4 2 Obtaining an ACS URL via DHCP option op 27 4 3 Obtaining an ACS URL via Redirection Mechanism eere nne e tnn enne ntt tee tinent nnt rnt tnnt nne nnne 31 Appendix 1 Operation Instance UP 33 Appendix 2 Configuration File Template cssssscssssscsssssssssscsscnscsssesssssssnscessnssessesssssessesessnssessesscssesesessnasossesscsseseesseseesossess 35 New Rock Technologies Inc 2 Auto provision Configuration Manual Contents of Figure Figure 1 1 Flowchart of the Updating Process take an MX device as an example sseeeeeeeneeen een 7 Figure 2 I Main Interface of Tftpd32 eR e RR EN GT I ERR e een s 8 Figure 2 2 TFTP Configuration Interface of Tftpd32 Figur 3 1 MAG E EE Figure 3 2 General Contiguration File diia rcr E reete epe eb p ed dn Det te eee e pega Figure 3 3 MAC addressed Configuration File esee enne trennen tnter tne e E E eeit 21 Figure 3 4 Starting the Encryption Tool on a Windows DC 23 Figure 4 1 Man alconfiguratiOni x o eee ee trt eet reete eei ene lette te e ee e
16. de package MX J1 1 1 3 327_7 E0 03 tar gz Operation steps Step 1 Establish a TFTP server and set the root directory of the server It is assumed that the address of the TFTP server is 192 168 250 221 Step 2 Establish a DHCP server enable option 66 on the DHCP server and set Option 66 to tftp 192 168 250 221 Step 3 Download the configuration file common cfg from Appendix 2 Configuration File Template in this document and then modify the configuration file Add to the beginning of each unnecessary parameter node row and parameter row and set the parameters SIP RGISTRATION FIRM UPGRADE and FIRM URL Modify the configuration file to the effect shown in the following figure J common cfg 110 1 dl A LA 310 1 SAT Haec elo PEN i ere E WC 1 1 0 0 1 110 1 config ini gt 2 DIGITMAP 1 3 DEFAULT_DIGIT_MAP 01 3 5 8 xxxxxxxxx OLOxxxxxxxx O2xxxxxxxxx 0 3 9 xxxxxxxxxx 120 11 0 2 9 111xx 123x 4 SIP 5 amp SIP REG EXPIRES 6001 6 SIP_PROXY 4 T SIP_REGISTRATION 192 168 2 1004 8 AUTOPROVISION 4 9 FIRM_UPGRADE Y 10 FIRM URL tftp 192 168 250 221 WX J1 1 1 3 327 T EO 03 tar gz4 11 amp UPGRADE TYPE 04 12 CFG_INTVL 36004 13 GEN_URL 4 14 H m H Step 4 Encrypt the configuration file common cfg as N0000J1 cfg using the encryption tool mxenc and place the encrypted configuration file along with MX J1 1 1 3 327 7 E0 03 tar gz
17. e 0 7 BOA VLAN Management VLAN yes enabled no disabled switch BOA VLAN TAG Management VLAN tag Value range 1 4094 BOA VLAN QOS Management VLAN Value range 0 7 priority BOA VLAN GETIP Management VLAN 1 DHCP address acquisition mode 0 STATIC Note When BOA VLAN GETIP 0 BOA IPADDR BOA NETMASK and BOA DEVICE are mandatory BOA IPADDR Management VLAN IP When BOA VLAN GETIP 0 this address parameter is mandatory BOA NETMASK Management VLAN subnet mask BOA GATEWAY Management VLAN device address TIME SERVER Time server New Rock Technologies Inc 15 Auto provision Configuration Manual Node Name Parameter Meaning Value Range NETWORK ETHO DHCP Management IP address on When a device IP address is Note These acquiring mode dynamically obtained the parameters are LOCAL IP ADDRESS applicable to ETHO NETMASK and DEVICE do HX4 MX8 MX60 M not need to be configured X100E MX100G MX off When a static device IP address is 120 0M12 0M80 O configured LOCAL IP ADDRESS M200 devices ETHO NETMASK and DEVICE are mandatory LOCAL IP ADDRESS Statically configure an IP address for a device ETHO NETMASK Statically configure a subnet mask for a device DEVICE Statically configure a device address for a device DNS RESOLVE Domain name resolution on enabled off disabled service switch DNS SERVER Primary DNS server DNS SERVER2 Secondar
18. e various devices are located on separate depository of the cfg files assuming TFTP server is used ACSs 2 Prepare configuration files that are named after the MAC addresses of the devices on ACS 2 Note MA cfg indicates the configuration file named after the MAC address of each device When reading this parameter a device converts it to the corresponding file name based on the MAC address of the device itself Ki Note e MA in MA cfg must be in upper case e The address of ACS 2 can be in IP address or domain name format If the address is in domain name format the DNS server needs to be configured e Ifthe ACS is FTP HTTP or HTTPS server the parameter GEN URL is written based on the defined rule in Table 3 2 Common Configuration Parameters Editing a General Configuration File New Rock Technologies Inc 19 Auto provision Configuration Manual Figure 3 2 General Configuration File lt config ini gt DIGI TMAP DEFAULT DIGIT MAP SIP SIP REG EXPIRES SIP PROXY SIP REGISTRATION 01 3 5 8 xxxxxxxxx 1 xxxxxxxx 2xxxxxxxxx 600 AUTOPROVISION FIRM UPGRADE FIRM URL UPGRADE TYPE CFG INTVL GEN URL l 3600 Table 3 4 Examples of Configuration Update Example lt config ini gt DIGITMAP Digit map describes the dialing plan used in your country DEFAULT_DIGIT_MAP x TI 1xxl 2 9 1111 2 9 xxxxxxxxxl 2 9 1 0 2 9 xxxxxxxl 2 9 0 2 9 xxxxxxxx SIP Enter the
19. ease contact your dealer or customer contact center Table 3 2 Common Configuration Parameters Node Name Parameter Meaning Value Range DIGITMAP DEFAULT DIGIT MAP Digit map The content of this parameter depends on the dialing plan Common default factory settings 01 3 5 8 xxxxxxxxxl0 10xxxxxxxxl 02xxxxxxxxxl0 3 9 xxxxxxxxxxl120l 11 0 2 9 1111xxl123xxl05xxxl100xxl 1 3 5 8 xxxxxxxxxl 2 3 5 7 xxxxxxxl 8 1 9 xxxxxxI80 1 9 xxxxxl800xxxx xxxl 4 1 9 xxxxxxl40 1 9 xxxxxl400xxxx xxxl XXXXXXXXXX TIx l xx xxl For details about configuration rules consult the corresponding User Manual based on the device model or contact technical support SIP SIP_REG_EXPIRES Registration duration 15 to 86400 seconds 600 seconds by default SIP_PROXY Proxy server address Example 168 33 134 51 5000 or www sipproxy com 5000 5060 by default if the port number is not configured SIP_REGISTRATION Registration server address Same as above AUTOPROVISION FIRM_UPGRADE Whether to enable the firmware upgrade function Y enabled N disabled Note The value takes effect immediately rather than next time when the device visits ACS New Rock Technologies Inc 11 Auto provision Configuration Manual Node Name Parameter Meaning Value Range FIRM URL URL for Firmware upgrade package Specific formats corresponding to the four types o
20. enario Instructions 1 Auto provision of one device Prepare a configuration file on the ACS which can be either a general configuration file or a MAC addressed configuration file 2 Auto provision of three devices A B 1 Prepare a generation configuration file on the ACS which and C where some parameters need to be contains the common parameter settings for the three devices updated for device C only 2 Prepare a configuration file named after the MAC address of device C on the ACS and configure the parameters to be updated for device C 3 Auto provision of three devices A B 1 Prepare a generation configuration file on the ACS which and C The parameter o needs to be contains the common parameter settings for the three devices and updated for all three devices but the set parameter a to the target new value for devices A and B value of parameter a for device C is 2 Prepare a configuration file named after the MAC address of different from that for devices A and B device C on the ACS and set parameter a to the target new value for device C Note If identical parameters exist in the general configuration file and the MAC addressed configuration file the device validates the parameters configured in the MAC addressed configuration file 4 The general configuration file and the 1 Prepare a general configuration file on ACS 1 and configure the MAC addressed configuration files of parameter GEN URL tftp Address of ACS 2 MA cfg for th
21. evice The redirection filename may also be a user defined file New Rock Technologies Inc 31 Auto provision Configuration Manual The device operates the auto provision with redirection mechanism as follows 1 2 3 4 x Note The device contacts ACS1 automatically upon powering up The device downloads general configuration file with ACS2 URL from ACS1 The device points to ACS2 to download the device configuration file Apply the configuration settings e When the same parameters are included in different configuration files the parameters are validated according to this priority Redirection file gt MAC addressed file gt General configuration file New Rock Technologies Inc 32 Auto provision Configuration Manual Appendix 1 Operation Instance Operation steps Step 1 Prepare configuration files based on the specific application scenario Prepare the configuration files based on the specific application scenario For details about configuration file naming see Section 3 1 Configuration Files Step 2 Prepare the server See Section 2 Establishing the ACS Step 3 Configure a device so that the device can obtain an ACS server address link See Section 4 Obtaining an ACS URL Step 4 Start the device Example of Carrying the ACS URL in DHCP e Change the registration server address of the HX4 device to 192 168 2 100 remotely through the ACS e The HX4 network automatically downloads the firmware upgra
22. f servers tftp Server address Firmware upgrade package ftp Username password Server address Firmware upgrade package http Username password Server address Firmware upgrade package https Username password Server address Firmware upgrade package Note 1 The server address can be in IP address or domain name format If the server address is in domain name format the DNS server needs to be configured on the device 2 When specifying the firmware upgrade package ensure that the name contains the suffix of the firmware upgrade package 3 Fields tftp ftp http and https must be in lower case UPGRADE_TYPE Update mode 0 Power on 1 Power on Periodical CFG_INTVL Update interval 5 to 86400 seconds 3600 seconds by default Note This parameter needs to be configured when the update mode is set to Power on Periodical New Rock Technologies Inc 12 Auto provision Configuration Manual Node Name Parameter Meaning Value Range GEN URL URL for Redirection file Specific formats corresponding to the four types of servers tftp Server address Redirection file name ftp Username password Server address Redirection file name http Username password Server address Redirection file name https Username password Server address Redirection file name Note 1 The server address can be in IP address or domain name format
23. ies Inc 4 1 1 Definition Auto provision Configuration Manual 1 Overview The VoIP gateway and IP PBX devices launched by New Rock Technologies Inc support auto provision which allows remote and central management of device configuration and firmware upgrades With this device management scheme the firmware upgrade packages and configuration files are stored and managed on an auto configuration server ACS and the devices visit the ACS when powered on or periodically and downloads the latest firmware package or configuration files Features Selectively configuring or upgrading some devices or all devices Selectively configuring part of parameters or all parameters TFTP FTP or HTTP mode Obtaining ACS URL via DHCP option 66 or redirection mechanism Advantages This guidance is applicable to the following devices New Rock Technologies Inc Drive down care cost for the carriers or any sizable deployment by supporting highly efficient and remote device management and maintenance Remove the potential risk of loss of data and data intrusion by providing configuration file backup and data encryption on transmission Easy to implement HX4 HX4E MXS8 MX8A MX60 MX120 MX100E MX100G WROC2000 WROC3000 OMI2 OM80 Auto provision Configuration Manual e OM200 e OM20 e OM50 1 2 How Auto Provision Works To deploy a device provisioning network based on auto provision a TFTP FTP HTTP or HTTPS ba
24. in descending order based on priorities Redirection file gt MAC addressed configuration file gt General configuration file When the same parameter exists in all of the general configuration file the MAC addressed configuration file and the redirection file rather than redirection to MA cfg the device validates the value of this parameter in the redirection file When the same parameter exists in the general configuration file and the MAC addressed configuration file the device validates the value of this parameter in the MAC addressed configuration file Most parameters take effect in real time except for those network or registration related parameters that do not take effect until the device is restarted the device will automatically restart as required New Rock Technologies Inc 18 3 3 Editing Configuration Files Auto provision Configuration Manual You can download the configuration file template for modification in Appendix 2 Configuration File Template Please note that the template contains the parameters that are commonly used If you need other parameters included please contact your dealer or customer contact center The configuration files need to be determined according to the application scenario by referring to the following table For details about the parameters see Table 3 2 Common Configuration Parameters Table 3 3 Application Scenarios of Configuration Files No Sc
25. into the root directory of the TFIP server New Rock Technologies Inc 33 Auto provision Configuration Manual Step 5 Start the HX4 The HX4 automatically downloads the configuration file and performs a firmware upgrade New Rock Technologies Inc 34 Auto provision Configuration Manual Appendix 2 Configuration File Template General Configuration File Template commonl cfg is applicable to HX4 MX8 MX60 MX100E MX100G MX120 OM 12 0M80 0M200 devices common2 cfg is applicable to HXA4E MX8A WROC2000 WROC3000 0M20 OM5O devices Commor2 cfg Commoril cfg MAC addressed Configuration File Template MAC oriented cfg New Rock Technologies Inc 35
26. ne eire ete ter eer ete sti dere 24 Figure 4 2 Manually Configuring the ACS URL Figure 4 3 Setting the Update Mode to Power on Figure 4 4 Setting the Update Mode to Power on Periodical ccceeescescsecssesscnesseeseeseeseeceeesessecsessesseseseesesseesesseeaeeseeeseees 26 Figure 4 5 Auto discovery via DHCP option op 27 Figure 4 6 GLOBAL Configuration Interface for Tftpd32 sese enne net ennt 27 Figure 4 7 DHCP Configuration Interface for Tftpd32 essent enne nennen teen nennt trennen 28 Figure 4 8 Network Configuration Interface eese teen enne nennen trennen enne EE ENEA AA SA EA EEEE teen 29 Figure 4 9 Auto provision Configuration Interface 29 Figure 4 10 Obtaining an ACS URL via redirection mechanism sseeseseseseeeeeeeteenee nete 31 New Rock Technologies Inc 3 Auto provision Configuration Manual Contents of Table Table 3 1 Mappings between Device Models and Names of General Configuration Files eee 10 Table 3 2 Common Configuration Parameter 11 Table 3 3 Application Scenarios of Configuration Files Table 3 4 Examples of Configuration Update 20 Tablet ACS URE format nes Eee Ur ere e dn pm b ap da pe ttg deb EER Eens 24 Table 4 2 DHCP Configuration Parameters of Tftpd32 sess enne ennt tn enne eee tnetnenen 28 T able 4 3 GEN DI E eben en e Dose t e e e ete ate ee e cl oie ettet d 31 New Rock Technolog
27. onfiguration file after obtaining an ACS URL The following uses MX series as an example 4 1 Manually Configuring the ACS URL The device will automatically obtain the configuration file and firmware from the manually configured ACS URL Figure 4 1 Manual configuration Manually configure the AC S address Internet Step 1 Log into the Web GUI of the device click Advanced System and select Auto Provision Table 4 1 ACS URL format Server type URL format TFTP server tftp ACS URL FTP server ftp ACS URL HTTP server http ACS URL HTTPS server https ACS URL Configure the ACS URL in the Server text box in one of the formats above When an FTP HTTP or HTTPS server is used it is also required to enter the preset User name and Password If preset User name and Password text boxes are not displayed on the ACS server enter them manually in the URL text box in this format http User name password Server address Then click Submit New Rock Technologies Inc 24 Auto provision Configuration Manual Figure 4 2 Manually Configuring the ACS URL NAT traversal Dynamic NAT Y 15 more than 14 s default 60 NAT IP address Local IP address Refresh perio SDP address a E S i 2 tftp 192 168 250 221 es Firmware upgrade Update mode agement system typ a o Als ia AR a HE V H Kl D Protocol TROGO v e g http
28. rompts e When the system displays the prompt infile enter the name of the unencrypted file such as common cfg and then press Enter e When the system displays the prompt outfile enter the name of the encrypted file such as N0000J1 cfg and then press Enter The encrypted file must be named in accordance with the formats described in Section 3 1 Configuration Files The name of the unencrypted file does not need to follow these formats e When the system displays the prompt key enter the MAC address of the device The input MAC address must not contain For example if the MAC address is 00 0E A9 20 15 05 the input MAC address should be 000EA9201505 New Rock Technologies Inc 22 Auto provision Configuration Manual Figure 3 4 Starting the Encryption Tool on a Windows PC e 8 DXenc windows exe SERD LED Ghom mxenc lt infile gt lt outfile gt lt key string infile gt common cfg outfile gt N8888J1 cfg key BBBER92015805 e The encrypted file must be named in accordance with the formats described in Section 3 1 Configuration Files The name of the unencrypted file does not need to follow these formats e The input MAC address must not contain For example if the MAC address is 00 0E A9 20 15 05 the input MAC address should be 000EA9201505 New Rock Technologies Inc 23 Auto provision Configuration Manual 4 Obtaining an ACS URL A device can download a c
29. s configuration and firmware using those on the ACS If this mode is used the update interval needs to be specified Figure 4 9 Auto provision Configuration Interface p gene ECL C Iones Feature codes Logout White list Media stream SIP Line Trunk RADIUS Encryption Greeting NAT traversal Refresh period SDP address Dynamic NAT more than 14 s default 60 NAT IP address Local IP address Auto Provision Management system Protocol SNMP TRO69 e g 192 168 2 99 162 Signaling port Trap port Notification interval Submit New Rock Technologies Inc 29 Auto provision Configuration Manual Ki Note e If the ACS URL carried in DHCP option 66 is in domain name format the DNS server needs to be configured Please click Basic Network to configure the DNS server e To detect the firmware upgrade package the FIRM URL parameter needs to be configured in the configuration file on the ACS For details see Table 3 2 e The configuration file upgrade takes effect immediately after the device restarts and takes about 40 seconds e Firmware updates involve a firmware update and device restart and takes about 3 minutes New Rock Technologies Inc 30 Auto provision Configuration Manual 4 3 Obtaining an ACS URL via Redirection Mechanism In general the device is configured to contact a default ACS upon powering up The default ACS may be establi
30. sed Auto Configuration Server ACS needs to be set up with the following conditions e Accessible to all devices through either Internet or private network e Store configuration files and firmware upgrade packages The device can contact the ACS with the URL preset in the device or automatically discovered via DHCP option 66 or redirection mechanism For details see Chapter 4 Obtaining an ACS URL With auto provision feature enabled the device will visit the ACS every time upon powering up reboot or periodically based on the pre set period The downloading of the latest firmware and configuration files will take effect immediately or after a delay period The Figure below displays the interaction between a device and an ACS New Rock Technologies Inc 6 Auto provision Configuration Manual Figure 1 1 Flowchart of the Updating Process take an MX device as an example MX gateway Start p DHCP Discover 3 4 DHCP Offer DHCP server ACS cluster DHCP Request J le DHCP ACK Option 66 protocol ACS address No Yes Obtain the manually configured ACS address amp I Download the general configuration file 4 Transfer the general configuration file Download the redirection file gt Transfer the redirection file
31. shed by manufacturer or included in manufacturer s provisioning system If the service provider establishes an ACS for their own management they can select one of the following methods 1 Manually configure the URL of service provider s own ACS on the device or 2 Use redirection mechanism i e embed the URL information into default ACS which will redirect the devices to visit the service provider s own ACS upon powering up For details 1 Use the default ACS ACS1 as the server for redirection and configure the URL of ACS1 on the device 2 The service provider places the configuration file on their own ACS ACS2 3 On ACSI place a general configuration file with the redirection parameter GEN URL pointing to ACS2 Figure 4 10 Obtaining an ACS URL via redirection mechanism Redirection server Target ACS Based on the type of the target server that is pointed to the value of a GEN URL can be one of the followings Table 4 3 GEN URL value Type of service provider s server Value 1 TFTP server tftp Server address Redirection filename 2 FTP server ftp Username password Server address Redirection filename 3 HTTP server http Username password Server address Redirection filename 4 HTTPS server https Username password Server address Redirection filename Note e It is recommended to name the redirection filename as SMA cfg which indicates the file corresponding to the MAC address of the d
32. tion Files The general configuration file is effectual for all the devices with the same model The following table shows mappings between device models and file names Table 3 1 Mappings between Device Models and Names of General Configuration Files Model Name of the General Configuration File HX4 N0000J1 cfg HX4E NOOOOP1 cfg MX8 OMI12 N0000B2 cfg MX8A N0000NI cfg MX60 N0000H1 cfg MX120 0M200 N0000F1 cfg MX100E MX100G NOOO0L1 cfg WROC2000 NO000K 1 cfg WROC3000 N0000MI cfg OMS80 N0000H3 cfg OM20 N0000PI cfg OM50 NOOOON 1 cfg 3 1 2 MAC addressed File The MAC addressed configuration file is only effectual for the specific device It uses 12 digit MAC address of the device as the file name For example if the MAC address of a device is 00 0E A9 20 15 05 its configuration file is named 000EA9201505 cfg There is an MAC address label on the shell of the device chassis Figure 3 1 MAC Address Label MAC 00 0E A9 20 15 05 Note e The suffix of the configuration file name must be cfg in lower case e To avoid configuration conflicts do not maintain the device shared with same general configuration file name for example the HX4E OM20 and MX8A OM50 listed on the table above New Rock Technologies Inc 10 3 2 Common Configuration Parameters Auto provision Configuration Manual The parameters listed below are commonly used For the details of other parameters pl
33. wnload install and start Tftpd32 Figure 2 1 Main Interface of Tftpd32 T Tftpda2 by Ph Jounin S Current Directory D sl Browse Server interface 1821 68 250 221 sl Show Dir Tftp Server DHCP server Log viewer peer file start time progress 4 About Settings Help Step3 Click Settings and click the TFTP tab Then select the root directory of the server for storing configuration files and firmware upgrade packages from the Base Directory select Bind TFTP to this address and specify the TFTP server address New Rock Technologies Inc 8 Auto provision Configuration Manual Figure 2 2 TFTP Configuration Interface of Tftpd32 aLoBAL FFTP puce systoc r Base Directory i os Browse m TFTP Security r TFTP configuration 3 C None Timeout seconds 3 C Standard Max Retransmit 6 Ze High Titp port 69 C Read Only local ports pool Advanced TFTP Options Iw Option negotiation PXE Compatibility Iw Show Progress bar I Bind TFTP to this address Allow As virtual root Use anticipation window of p Bytes Hide Window at startup Create dir txt files Create md5 files Beep for long transfer OK Default Help Cancel New Rock Technologies Inc 9 3 1 Configuration Files 3 1 1 General Configuration File Auto provision Configuration Manual 3 Preparing Configura
34. y DNS server TIMEZONE Time zone ATA Bridge ConnectionMode Device IP address STATIC When a static device IP These parameters are acquisition mode address is configured Bridge ipaddr applicable to Bridge netmask Bridge device HXAE MX8A WROC Bridge primary dns and 2000 WROC3000 0 Bridge secondary dns are mandatory M20 0M5S0 devices DHCP When a device IP address is obtained dynamically Bridge dhcp manual dns Bridge dhcp pri dns and Bridge dhcp sec dns are mandatory PPPOE When a device IP address is obtained by using PPPoE Bridge pppoe user Bridge pppoe pass Bridge pppoe manual dns Bridge pppoe pri dns and Bridge pppoe sec dns are mandatory Bridge ipaddr Statically configure an IP address for a device Bridge netmask Statically configure a subnet mask for a device Bridge device Statically configure a device address for a device Bridge primary dns Manually configure the IP address of the primary DNS server when the IP address of a device is statically configured New Rock Technologies Inc 16 Auto provision Configuration Manual Node Name Parameter Meaning Value Range Bridge secondary dns Manually configure the IP address of the secondary DNS server when the IP address of a device is statically configured Bridge dhcp manual dns DNS configuration mode when DHCP mode is used 0 Obtaining a DNS address by using DHCP when an IP
Download Pdf Manuals
Related Search