J179 Provisioning (Aura)
During the power up process, the phone will reach out to the following for its configuration options:
| 1 | 2 | 3 | ||||
| Phone | → | DHCP | → | HTTPS (AADS) | → | Session Manager |
| ↑ | ||||||
| Configuration/ Firmware Files |
| Server | Purpose |
|---|---|
| 1 DHCP server | Network IP address, gateway, and provisioning server address(es) (AADS) |
| 2 File Server (AADS) | Firmware, image(s), language files, and Session Manager IP (HTTPS) |
| 3 Aura Session Manager | SIP Registration, and Personal Profile Manager (PPM) exchange |
The DHCP server tells the phone where to get its configuration files (AADS), the configuration files tell it where to register (SM). Upon registration, the PPM provides the user profile configuration (DN, buttons, etc). Note: PPM is only available in an Avaya Aura environment.
DHCP Server:
The following DHCP options must be provisioned:
| DHCP Option | Description |
|---|---|
| [3] routers | Gateway address |
| [6] domain-name-servers | DNS server addresses (comma separated if more than 1) |
| [15] domain-name | Domain name |
| [242] avaya-web-server | Avaya server string, points to Avaya Aura Device Services (AADS) server |
The Avaya server string, Option 242, can configure several parameters, most importantly, the AADS file server address - from where the set will download additional configuration parameters.
eg:
| Parameter | Description |
|---|---|
| ADMIN_PASSWORD | The default is 27238. Replaces PROCPSWD as it provides a more secure password syntax. |
| HTTPDIR | Path to prepend to all configurations and data files the device might request when starting up, relative to the root of the HTTP file server. The command is SET HTTPDIR=<path> |
| HTTPPORT | Sets the TCP port used for HTTP file downloads from non-Avaya servers. The default is 80 |
| HTTPSRVR | IP addresses or DNS names of HTTP file servers used for downloading settings, language, and firmware files during startup. |
| ICMPDU | Controls the extent to which ICMP Destination Unreachable messages are sent in response to messages sent to closed ports so as not to reveal information to potential hackers. The default is 1, that is sends Destination Unreachable messages for closed ports used by traceroute. |
| ICMPRED | Controls whether ICMP Redirect messages are processed. The default is 0, that is, redirect messages are not processed. |
| L2Q | 802.1Q tagging mode. The default is 0 for automatic. |
| L2QVLAN | VLAN ID of the voice VLAN. The default is 0. |
| PHY1STAT | Specifies speed/duplex settings for the Ethernet line interface. The default value is 1 for auto-negotiate. |
| PHY2STAT | Specifies speed/duplex settings for the secondary (PC) Ethernet interface. The default value is 1. |
| PROCPSWD | Security string used to access local procedures. The default is 27238. ADMIN_PASSWORD replaces this parameter if ADMIN_PASSWORD is set in the 46xxsettings.txt file. |
| REUSETIME | Time in seconds for IP address reuse timeout, in seconds. The default is 60 seconds. |
| SIP_CONTROLLER_LIST | SIP proxy or registrar server IP or DNS addresses that can be 0 to 255 characters, IP address in the dotted decimal name format, separated by commas and without any intervening spaces. The default is null, that is, no controllers. |
| TLSDIR | Used as path name that is prepended to all file names used in HTTPS GET operations during initialization. The string length can be from 0 to 127. |
| TLSPORT | Destination TCP port used for requests to https server in the range of 0 to 65535. The default is 443, the standard HTTPS port. |
| TLSSRVR | IP addresses or DNS names of Avaya file servers used to download configuration files. Firmware files can also be downloaded using HTTPS. |
| VLANTEST | Number of seconds to wait for a DHCPOFFER on a non-zero VLAN. The default is 60 seconds. |
Parameters in the Option 242 string are comma-separated with no spaces.
File Server (AADS):
The provisioning file server is pointed to via DHCP Option 242, Aura uses AADS server(s):
AADS (Avaya Aura Device Services) provides centralized endpoint administration and also functions as an HTTP-based file server for delivering firmware, configuration, and settings files. AADS supports both traditional IP phones, such as the 96xx Series, and the more advanced configuration requirements of modern SIP endpoints. Note, the firmware files are digitally signed, so TLS is not required for security.
| File | Purpose |
|---|---|
| J100Supgrade.txt | Pointers to the firmware and upgrade files |
| 46xxsettings.txt | Configurable parameters that apply to all devices in a deployment |
| <MACaddress>.txt | Configurable parameters for a specific device (optional, overrides 46xxsettings.txt). <MACaddress> is uppercase, without punctuation. |
| Resource files | Language files, background/screensaver images, ringtones, trust certificates |
The phone checks J100Supgrade.txt first - if the firmware version differs from what's installed, it downloads and installs the indicated firmware file. The last line of J100Supgrade.txt then tells the phone to request 46xxsettings.txt, which may in turn request additional files such as language files (`Mlf_*`) or certificates (`.sig256`).
Testing the File Server:
You can use a web browser to perform a basic test of the file server. For example, entering http://<server_address>/46xxsettings.txt in the browser address bar should display the files contents.
- For Aura, modify the Settings file 46xxsettings.txt using a text editor to add customer specific settings for set provisioning.
- With IP Office, use the auto-generated 46xxsettings.txt file, and put customer specific settings into a 46xxspecials.txt file.
Settings file:
The 46xxsettings.txt settings file can include any of the six types of statements, one per line:
| Statement | Description |
|---|---|
| # <tag> | Lines that begin with # [space] and a text string (with no spaces) are 'tags'. |
| GOTO <tag> | Unconditional jump, interpretation continues from the next line after the # tag statement |
| IF... GOTO <tag> | Conditional jump. IF $parameter_name SEQ string GOTO tag. The Goto is executed if the parameter_name ($MODEL, $GROUP, or $MACADDR) value exactly matches the string |
| SET | eg: SET parameter_name value. All values must be strings, numbers must go in quotes |
| ## | Lines that begin with ## [space] and a text string are comments, they are not processed |
| GET <filename> | The phone will attempt to retrieve and process the file called 'filename' |
Full details of the configurable options and parameters can be gleamed by studying the 46xxsettings.txt file template, although it need not be anywhere near this long or complicated, often only minimal parameters are required!
SET SIP_CONTROLLER_LIST points to the the Aura Session Manager, for SIP Registration, and Personal Profile Manager (PPM) exchange.
For example:
SET SIG 2 SET SIPDOMAIN pbxbook.com SET DNSSRVR 10.18.15.22 SET SNTPSRVR 10.23.25.254 SET SIP_CONTROLLER_LIST 10.18.15.41:5061;transport=tls,10.18.15.42:5061;transport=tls SET TRUSTCERTS smgr.txt SET PROCPSWD 27238 SET GMTOFFSET "+1:00" SET DSTOFFSET 1 SET DSTSTART 4SunMar2L SET DSTSTOP 4SunOct2L SET TLSSRVRID 0 IF $GROUP SEQ 500 GOTO SBC GOTO END . # END
46xxsettings.txt is the global config file for all phones; <MACaddress>.txt overrides it per device.
To set a custom J179 background on Aura, see J179 Background (Aura).