AdminGuide:Service:AutoProvisioning

Return to AdminGuide:Service

Auto provisioning

Description

The Auto Provisioning service generates the configuration file necessary for the correct operation of a device and transfers them to your phones. This file also contains information on the account and extension linked to the phone.

The configuration file for a specific device is generated from a template for the brand and model of the phone.

The template format depends on the brand and model of the phone as well as the version of its firmware.

When defining a template it is possible to use placeholders that Kalliope will automatically replace when generating the file.

These placeholders include:

• KalliopePBX attributes (e.g. SIP UDP/TCP port of the PBX);
• attributes of the extension/account linked to the phone (e.g. SIP credentials, first name, last name, etc.);
• phone attributes (e.g. network parameters, access credentials, etc.).

Once the template has been defined, you must specify the MAC address of the device and the account/extensions you wish to link it to.

Once a file has been generated, it must be transferred to the phone. KalliopePBX provides the following file transfer protocols:

• TFTP: files are available directly in the root of the TFTP server for single-tenant KalliopePBX. For multitenant KalliopePBX, you must add the Tenant UUID to the path (e.g. <tenant_uuid>/snom370-0004167898B1.htm).
• HTTP / HTTPS: the files are published on http(s)://<ip_address>/provisioning/ for single-tenant KalliopePBX. For multitenant KalliopePBX, you must add the Tenant UUID to the path (e.g. http(s)://<ip_address>/provisioning/<tenant_uuid>/).

All generated files are also visible in the File Manager.

There are several modes for telling the phone which protocol to use to download configuration files. Their configuration and order of execution depends on the model of the phone. The currently available modes are:

• SIP PnP: upon starting up the phone sends a SIP SUBSCRIBE message tp a multicast address. If SIP PnP is enabled on KalliopePBX, the PBX will reply with a SIP NOTIFY message containing the IP address of the TFTP server to use. This mode is not available for multitenant KalliopePBX.
• Redirection server: upon starting up the phone attempts to contact the redirection server of the manufacturer. If the MAC address of the phone has been inserted, the phone will be redirected to the specified server to download the configuration file. With this mode, you can use any of the available protocols (based on the parameter configured on the redirection server).
• DHCP OPTION 66: if when assigning the IP address the DHCP server sends the DHCP option 66 containing the URL to connect to (including the protocol to use), the phone will use this to download the configuration file.
• Manual: you can manually start the configuration from the phone or the web GUI by inserting the protocol and the IP address (as well as the path if necessary).