Provisioning allows system administrators to manage & configure large numbers of devices without the need to log into each individual web interface, which can save time and ensure consistent setups. This guide provides details on provisioning settings, parameters, and acceptable values used by Algo IP endpoint management devices.
This guide was developed based on Algo firmware 5.5. For configurations not available in this document, please contact Algo support for assistance.
For more details on central provisioning, please see the Central Provisioning Guide.
For further details on generating initial configuration files, please see the main Provisioning Parameters Guide.
Basic Settings
Features
Credentials for Accessing Managed Devices
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Remote Device Admin Password | dashbd.remote.pwd | String | N/A | |
Remote Device RESTful API Password | dashbd.rest.pwd | String | N/A | |
Remote Device SNMP Community String | snmp_community |
| N/A |
Provisioning Server Settings
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Enable Provisioning Server | dashbd.prov |
| N/A | |
Auth User Name | dashbd.prov.user | String | N/A | |
Auth Password | dashbd.prov.pwd | String | N/A | |
Partial Provisioning | dashbd.prov.i |
| N/A |
Monitor Settings
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Monitor Interval | dashbd.intvl |
| N/A |
Audio Alerts
Action when Device Offline
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Action | dashbd.alert.action |
| N/A |
Play Tone
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Tone | dashbd.alert.tone | |||
Tone Volume | dashbd.alert.vol |
| ||
Tone Duration | dashbd.alert.duration |
|
Multicast Settings
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Multicast Mode | mcast.mode |
| N/A | |
Number of Zones | mcast.zones.exp |
| mcast.mode=1 | |
Transmitter Zone | mcast.tx.fixed |
| mcast.mode=1 | |
Speaker Playback Zones | txzone1, txzone2, …, txzone9 |
| mcast.mode=1 | |
Expanded Speaker Playback Zones | txzone10, txzone11, … txzone50 |
| mcast.mode= 1 and mcast.zones.exp= 1 |
SIP
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
SIP Domain (Proxy Server) | sip.proxy |
| dashbd.alert.action = 0 | |
SIP Extension | sip.u1.user |
| dashbd.alert.action = 0 | |
Authentication ID | sip.u1.auth |
| dashbd.alert.action = 0 | |
Authentication Password | sip.u1.pwd |
| dashbd.alert.action = 0 | |
Display Name (Optional) | sip.u1.dname |
| dashbd.alert.action = 0 |
Outbound Settings
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Extension to Dial | dashbd.call.dest | Number | dashbd.alert.action = 0 | |
Tone | dashbd.call.tone | dashbd.alert.action = 0 | ||
Outbound Ring Limit | dashbd.call.maxring |
| dashbd.alert.action = 0 | |
Maximum Call Duration | dashbd.call.maxout |
| dashbd.alert.action = 0 |
Email Alerts
General
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Enable Email Notification | dashbd.email.use |
| N/A | |
Security | dashbd.email.security |
| dashbd.email.use = 1 |
Account
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Outgoing Mail Server | dashbd.email.server | String | dashbd.email.use = 1 | |
From | dashbd.email.from | String | dashbd.email.use = 1 | |
Email Account | dashbd.email.user | String | dashbd.email.use = 1 | |
Password | dashbd.email.pwd | String | dashbd.email.use = 1 |
Recipient
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Recipient Email | dashbd.email.to | String | dashbd.email.use = 1 |
Notification Settings
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Disconnected Device(s) Reminder | dashbd.email.offline |
| dashbd.email.use = 1 | |
Dashboard Heartbeat | dashbd.email.heartbeat |
| dashbd.email.use = 1 | |
Disconnected Device(s) Back Online | dashbd.email.online |
| dashbd.email.use = 1 |
Advanced Settings
Network
Common
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Internet Protocol | net.protocol |
| N/A | Choose to use Internet Proctocol version 4 or to use IPv4 + IPv6 dual stack. |
Supersede DNS provided by DHCP | net.dhcp.c.dns |
| N/A | Enable to provide a DNS server statically instead of using the DHCP provided name servers. |
DNS Servers | net.dns.servers |
| net.dhcp.c.dns = 1 or net.ipv4.method = static | Provide the addresses of DNS servers. |
IPv4
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
IPv4 Method | net.ipv4.method |
| N/A | Set the unit to use DHCP or static IP address |
IPv4 Address/Netmask | net.ipv4.address | IP address + netmask in CIDR notation E.g., 192.168.1.10/24 | net.ipv4.method = static | Enter the IP address and netmask (CIDR notation) |
IPv4 Gateway | net.ipv4.gateway | IP address | net.ipv4.method = static | Enter the gateway address |
IPv6
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
IPv6 Method | net.ipv6.method |
| net.protocol = ipv4+ipv6 | Set the unit to use DHCP or static IP address |
IPv6 Address/Netmask | net.ipv6.address | IP address + netmask in CIDR notation E.g., 192.168.1.10/24 | net.protocol = ipv4+ipv6 and net.ipv6.method = static | Enter the IP address and netmask (CIDR notation) |
IPv6 Gateway | net.ipv6.gateway | IP address | net.protocol = ipv4+ipv6 and net.ipv6.method = static | Enter the gateway address |
ICMPv6 Options
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Destination Unreachable Messages | net.icmpv6.destunreach |
| net.protocol = ipv4+ipv6 | Filters ICMPv6 Destination Unreachable Messages |
Neighbor Discovery Redirect Messages | net.icmpv6.redirect |
| net.protocol = ipv4+ipv6 | Filters ICMPv6 Neighbor Discovery Redirect Messages |
Anycast Echo Replies | net.icmpv6.echo |
| net.protocol = ipv4+ipv6 | Filters ICMPv6 Anycast Echo Replies |
Enable Rate Limiting Outbound Messages | net.icmpv6.enablelim |
| net.protocol = ipv4+ipv6 | Limits the rate of outgoing packets. |
Rate Limit (packets per second) | net.icmpv6.ratelim | Non-negative Integer | net.protocol = ipv4+ipv6 and net.icmpv6.enablelim = 1 | Limits the rate of outgoing packets. |
802.1Q Virtual LAN
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
VLAN Mode | net.vlan.use |
| N/A | Enables or Disables VLAN Tagging |
VLAN ID | net.vlan.id | Number from 0 to 4094 | net.vlan.use = manual | VLAN ID |
VLAN Priority | net.vlan.priority | Number from 0 to 7 | net.vlan.use = manual | VLAN Priority |
802.1X Port-based Network Access Control
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
802.1X Authentication | net.pnac.use |
| N/A | Use 802.1X authentication methods |
Authentication Mode | net.pnac.auth |
| net.pnac.use = 1 | Choose the 802.1X authentication mode. |
Anonymous ID | net.pnac.anon | String | net.pnac.use = 1 | The 802.1X anonymous ID |
ID | net.pnac.id | String | net.pnac.use = 1 | The 802.1X ID |
Password | net.pnac.pwd | String | net.pnac.use = 1 | The 802.1X password |
Validate Server Certificate | net.pnac.validate |
| net.pnac.use = 1 and net.pnac.auth ≠ EAP-MD5 | Validate the autentication server against trusted certificate authorities. |
Differentiated Services
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
SIP (6-bit DSCP value) | net.dscp.sip | Number from 0 to 63 | N/A | Provides quality of service if the DSCP protocol is supported on your network |
RTP (6-bit DSCP value) | net.dscp.rtp | Number from 0 to 63 | N/A | Provides quality of service if the DSCP protocol is supported on your network |
RTCP (6-bit DSCP value) | net.dscp.rtcp | Number from 0 to 63 | N/A | Provides quality of service if the DSCP protocol is supported on your network |
DNS
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
DNS Caching Mode | net.dns.cache |
| N/A | In "SIP" mode, only the results of DNS queries for SIP requests will be cached. In "All" mode, the results of all DNS queries will be cached |
TLS
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Allow Weak TLS Ciphers | net.weaktls.use |
| N/A | Not sure what TLS ciphers are considered weak. |
Admin
General
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Device Name (Hostname) | admin.devname | String | N/A | Name to identify the device in the Algo Network Device Locator Tool |
Introduction Section on Status Page | admin.welcome |
| N/A | Allows the introduction text to be hidden from the login screen |
Show Status Section on Status Page when Logged Out | admin.start.status |
| N/A | Block access to the status page when logged out |
Display Switch Port ID on Status Page | admin.status.portid |
| N/A | Show the switch port's ID on the Status page. |
Web Interface Session Timeout | admin.web.timeout |
| N/A | Set the maximum period of inactivity after which the web interface will log out automatically |
Play Tone at Startup | admin.startuptone |
| N/A | A tone can be played at startup to confirm that the device has booted |
Log Settings
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Log Level | log.level |
| N/A | Set logging level. Use on the advice of Algo technical support only |
Log Method | log.method |
| N/A | Allows the device to write to external Syslog server if the option for external (or both) is selected |
Network Log Protocol | log.protocol |
| log.method = “network" or "both" | Transport layer protocol used for syslog packets. |
Log Server 1 | log.server | IP address | log.method = “network" or "both" | Address for Syslog server on the network |
Log Server 2 | log.server2 | IP address | log.method = “network" or "both" | Address for Syslog server on the network |
Log Server 3 | log.server3 | IP address | log.method = “network" or "both" | Address for Syslog server on the network |
Log Server 4 | log.server4 | IP address | log.method = “network" or "both" | Address for Syslog server on the network |
Log Additional Events | log.add.use |
| N/A | Writes some additional logs at the notice level. Available logs are set in parameter log.add.events. |
Management
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Web Interface Protocol | net.http |
| N/A | HTTPS is always enabled on the device. Use this setting to disable HTTP |
Force Strong Password | admin.security.strongpw |
| N/A | When enabled, ensures that a secure password is provided for the device’s web interface for additional protection. |
Allow Secure SIP Passwords | admin.security.encsip |
| N/A | Allows SIP passwords to be stored in the configuration file in an encrypted format, to prevent viewing and recovery |
Simple Network Management Protocol
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
SNMP Support | net.srv.snmp |
| N/A | Device will respond to a simple status query for automated supervision |
SNMP Community String | net.srv.snmp.community |
| net.srv.snmp = 1 and net.srv.snmp.security = 0 | The community string used for SNMP. If left blank, the default string "public" will be used. |
SNMPv3 Security | net.srv.snmp.security |
| net.srv.snmp = 1 | Enable SNMPv3 security features. |
SNMPv3 Username | net.srv.snmp.user |
| net.srv.snmp = 1 and net.srv.snmp.security = 1 | The community string used for SNMP. If left blank, the default string "public" will be used. |
SNMPv3 Authentication Protocol | net.srv.snmp.auth |
| net.srv.snmp = 1 and net.srv.snmp.security = 1 | The community string used for SNMP. If left blank, the default string "public" will be used. |
API Support
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
RESTful API | admin.web.api |
| N/A | RestFul API |
Authentication Method | api.auth.basic |
| admin.web.api = 1 | Type of authentication |
RESTful API Password | api.admin.pwd |
| admin.web.api = 1 and (admin.auth.basic = 0 or admin.auth.basic = 1) | Password for authentication |
SCI Support
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
SCI | admin.web.sci |
| N/A | Simple Control Interface (SCI) is a separate control interface for certain applications. Its main purpose is to support phones that may have programmable keys that can only send out HTTP GET requests. |
SCI Password | sci.admin.pwd |
| admin.web.sci=1 | SCI password |
System Integrity
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
System Integrity Checking | admin.sic.use |
| N/A | This feature verifies installed system packages to ensure they have not been tampered with |
Microsoft
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Microsoft Teams Support | admin.teams.use |
| Teams SIP Gateway | Enable Teams support |
SIP Gateway Region | admin.teams.region |
| admin.teams.use=1 | Region your Microsoft account belong to |
Number of Accounts | admin.teams.num | 1 to 10 | admin.teams.use=1 | Choose the number of sip extensions to provision. A separate Teams account is need for each extension. |
Account #1-#10 | admin.teams.acct1 … admin.teams.acct10 |
| admin.teams.use=1 | Select the type of extension to provision with this account. Extensions can be page, ring/alert, emergency announcement, or call-to-cancel extensions. |
ADMP Cloud Monitoring
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Enable ADMP Cloud Monitoring | iot.use |
| ADMP licenses | Enable ADMP for remote monitoring |
Account ID | iot.tenant |
| iot.use=1 | Account ID from the ADMP portal |
Allow Configuration File Sync | iot.sync.conf |
| iot.use=1 | This feature allows ADMP to query and display settings stored on the device. |
Heartbeat Interval | iot.mqtt.ka |
| iot.use=1 | Interval on which device checks with ADMP server |
Time
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Timezone | admin.timezone | (Default) UTC Accepted values are spelled exactly like the options viewable in the dropdown box via the web interface. For more details please contact Algo Support. E.g, US/Eastern = "US/Eastern" | N/A | Select the timezone |
NTP Time Server 1 | net.time1 | IP address or domain name | N/A | Set the primary NTP server |
NTP Time Server 2 | net.time2 | IP address or domain name | N/A | Set a backup NTP server |
NTP Time Server 3 | net.time3 | IP address or domain name | N/A | Set a backup NTP server |
NTP Time Server 4 | net.time4 | IP address or domain name | N/A | Set a backup NTP server |
Supersede NTP provided by DHCP | net.dhcp.c.ntp |
| N/A | By default, if an NTP Server address is provided via DHCP Option 42, it will be used instead of the NTP servers listed above. Enable this option to ignore DHCP Option 42. |
Advanced SIP
General
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
SIP Transportation | sip.transp |
| N/A | Select the transport layer protocol to use for SIP messages |
SIPS Scheme | sip.sips |
| sip.transp = tls or sip.transp = auto | Enabling SIPS Scheme requires the SIP connection from endpoint to endpoint to be secure. Only supported with TLS transportation. |
Validate Server Certificate | sip.tls.validate |
| sip.transp = tls or sip.transp = auto | Validate the SIP server against common certificate authorities. To validate against additional certificates, use the "System > File Manager" tab to upload a Base64 encoded X.509 certificate file in .pem, .cer, or .crt format to the 'certs/trusted' folder.Only supported with TLS transportation. |
SIP Outbound Support (RFC 5626) | sip.outbound |
| N/A | Enable this option to support best networking practices according to RFC 5626 |
Outbound Proxy | sip.obproxy | IP address or domain name:port number e.g. my_proxy.com:5070 | N/A | IP address for outbound proxy |
Register Period | sip.regexp |
| N/A | Maximum requested period of time where the endpoint will re-register with the SIP server |
Rate Limit SIP Registration | sip.regrate |
| N/A | When registering multiple SIP extensions, this will stagger the registration requests for the different extensions. |
Wait for Successful Unregister | sip.unreg |
| N/A | The device will wait for a successful SIP deregistration before making changes or rebooting. This may slow down all device configuration changes and reboots. |
SRTP
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
SDP SRTP Offer | sip.srtp |
| N/A | Set SDP SRTP Offer |
SDP SRTP Offer Crypto Suite | sip.srtp.suite |
| sip.srtp = "savp" or sip.srtp = "avp" | Select the crypto suite(s) to be offered. |
NAT
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Media NAT | sip.nat.media |
| N/A | Select N/AT media type |
TURN Server | sip.turn.server | IP address | sip.nat.media = ice | IP address for TURN server |
TURN User | sip.turn.user | Username | sip.nat.media = ice | User for TURN server |
TURN Password | sip.turn.pwd | Password | sip.nat.media = ice | Password for TURN server |
STUN Server | sip.stun.server | IP address | sip.nat.media = stun | IP address for STUN server |
Server Redundancy
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Server Redundancy | sip.ssr.use |
| N/A | Two secondary SIP servers may be configured |
Backup Server #1 | sip.bkproxy1 | IP address or domain name | sip.ssr.use = 1 | Backup SIP server address #1 |
Backup Server #2 | sip.bkproxy2 | IP address or domain name | sip.ssr.use = 1 | Backup SIP server address #2 |
Polling Interval | sip.ssr.interval |
| sip.ssr.use = 1 | Time period between sending monitoring packets to each server |
Poll Active Server | sip.ssr.chkact | Enabled = "1" Disabled (default) = "0" | sip.ssr.use = 1 | Explicitly poll current server to monitor availability |
Automatic Failback | sip.ssr.nofb |
| sip.ssr.use = 1 | Reconnect with higher priority server once available, even if backup connection is still fine |
Polling Method | sip.ssr.method |
| sip.ssr.use = 1 | SIP message used to poll servers to monitor availability |
Interoperability
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Keep-Alive Method | sip.interop.ka.method |
| sip.outbound = 0 | Device will periodically send a CRLF message for both UDP and TCP connections to maintain connection with the SIP Server |
Keep-Alive Interval | sip.interop.ka.interval | Positive Integer (Seconds) | sip.interop.ka.method = crlf | Interval in seconds that the CRLF message should be sent |
Use Outgoing TLS port in SIP headers | sip.interop.cport |
| N/A | Use ephemeral port number from outgoing SIP TLS connection instead of listening port number in SIP Contact and Via headers |
Do Not Reuse Authorization Headers | sip.interop.rstauth |
| N/A | When enabled, all SIP authorization information from the last successful request will not be reused in the next request |
Allow Missing Subscription-State Headers | sip.interop.substate |
| N/A | When enabled, allow SIP NOTIFY messages that do not contain a "Subscription-State" header. |
Advanced Multicast (Transmitter)
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Transmitter Output Codec | rtpcodec |
| mcast.mode = 1 | Audio encoding format used by the Transmitter device when sending output to the Listeners |
Poly Output Codec | ppacodec |
| mcast.mode = 1 and mcast.polycom.mode = 1, 2, 3, or 4 | Audio encoding format used by the Transmitter device when sending output to the Listeners |
Output Packetization Time (milliseconds) | mcast.tx.ptime |
| mcast.mode = 1 | The size of the audio packets sent by the Transmitter to the Listeners |
Multicast TTL | mcast.tx.ttl | Positive integer | mcast.mode = 1 | Only change this setting if custom routing is configured on the network that specifically routes multicast packets between subnets, and a longer TTL count is required. Regular multicast routing does not require a change to this setting. |
RTCP Port Selection | mcast.rtcp.mode |
| mcast.mode = 1 and mcast.polycom.mode = 0, 3, or 4 | Select the port on which RTCP packets will be sent or received. If using the 'Next Higher Port' option, ensure that the default multicast zone definitions are modified such that zones are only assigned to even-numbered ports, leaving the next higher odd-numbered ports free for RTCP packets. |
Priority Call (DTMF: 9)
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
IP Address and Port | mcast.zone9 | IP address:port number | mcast.mode = 1 and mcast.polycom.mode = 0, 3, or 4 | Multicast address for this zone |
Page Tone | mcast.tone9 |
| mcast.mode = 1 and mcast.polycom.mode = 0, 3, or 4 | Other may be used if uploaded |
All Call (DTMF:0/8)
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
IP Address and Port | mcast.zone9 | IP address:port number | mcast.mode = 1 and mcast.polycom.mode = 0, 3, or 4 | Multicast address for this zone |
Page Tone | mcast.tone9 |
| mcast.mode = 1 and mcast.polycom.mode = 0, 3, or 4 | Other may be used if uploaded |
Zone 1 (DTMF:1)
Zone 2-6, Zone 10-50 increment the number on the parameter name.
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
IP Address and Port | mcast.zone1 | IP address:port number | mcast.mode = 1 and mcast.polycom.mode = 0, 3, or 4 | Multicast address for this zone |
Page Tone | mcast.tone1 |
| mcast.mode = 1 and mcast.polycom.mode = 0, 3, or 4 | Other may be used if uploaded |
Music (DTMF:7)
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
IP Address and Port | mcast.zone7 | IP address:port number | mcast.mode = 1 and mcast.polycom.mode = 0, 3, or 4 | Multicast address for this zone |
Page Tone | mcast.tone7 |
| mcast.mode = 1 and mcast.polycom.mode = 0, 3, or 4 | Other may be used if uploaded |
Polycom Groups
Name on Web Interface | Parameter | Permitted Values | Requirements | Description |
Group 1 Page Tone | mcast.polycom.tone1 |
| mcast.mode = 2 and mcast.polycom.mode = 1 or 2 | Other may be used if uploaded |
Group 1 Page Volume | mcast.polycom.vol1 |
| mcast.mode = 2 and mcast.polycom.mode = 1 or 2 | Allows specific volume configuration for each zone |