Differenze tra le versioni di "AdminGuide:Service:AutoProvisioning/en"

Da Kalliope Wiki.
Jump to navigation Jump to search
Riga 1: Riga 1:
<languages />
<languages />
<div class="mw-translate-fuzzy">
Return to [[AdminGuide:Service/en|AdminGuide:Service]]
Return to [[AdminGuide:Service/en|AdminGuide:Service]]
</div>


<div class="mw-translate-fuzzy">
===Description===
</div>
<div class="mw-translate-fuzzy">
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.
</div>
<div class="mw-translate-fuzzy">
== Configuration ==
This section collects all the configurations needed to perform auto-provisioning of a telephone device.
You can also consult the <u>[[AdminGuide:Service:AutoProvisioning:DeviceList/en|list built-in devices for auto-provisioning]]</u>
</div>
<div class="mw-translate-fuzzy">
==Device list==
</div>
<div class="mw-translate-fuzzy">
[[File:Provisioning.png|miniatura]]
This page contains the list of all devices for which provisioning file generation has been configured.
</div>
<div class="mw-translate-fuzzy">
The following table lists the configurable parameters for each device.
</div>


==Auto provisioning==
<div class="mw-translate-fuzzy">
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>/).
</div>


===Description===
<div class="mw-translate-fuzzy">
All generated files are also visible in the File Manager.
</div>
 
<div class="mw-translate-fuzzy">
It is necessary to select a template for each phone model for which you wish to generate a provisioning file.
</div>
 
<div class="mw-translate-fuzzy">
Return to [[AdminGuide:Service/en|AdminGuide:Service]]
</div>
 
===Lista dei modelli di dispositivo===
[[File:Lista modelli dispositivo.png|miniatura]]
Questo pannello contiene l’elenco di tutti i modelli di dispositivo definiti sul KPBX. Alcuni modelli di dispositivo sono distribuiti con il firmware del KPBX. Altri modelli possono essere aggiunti dall’utente per generare file di configurazione per modelli/produttori non esplicitamente supportati. <br>
 
E’ inoltre possibile definire delle regole che consentono di creare dei file di provisioning con nomi arbitrari. Il nome del file può essere composto da un prefisso, indirizzo MAC (in diversi formati) e un suffisso. <br>
 
The following table lists the configurable parameters for each model.
 
{| class="wikitable"
|-
! Parametro !! Descrizione !! Valore
|-
|colspan="3"| <div style = 'text-align: center; color: transparent> -
|-
| Nome || Nome del modello di dispositivo || Stringa
|-
!colspan="3"| <div style = 'text-align: left> '''''Marca del dispositivo'''''
|-
| Scegli Marca|| Consente di selezionare una marca esistente o crearne una nuova selezionando la voce Nuova Marca || Marca
|-
| Nome Marca|| Nel caso di Nuova Marca contiene il nome da associare || Stringa
|-
|colspan="3"| <div style = 'text-align: center; color: transparent> -
|-
| Nome || Nome del modello di dispositivo || Stringa
|-
!colspan="3"| <div style = 'text-align: left> '''''Marca del dispositivo'''''
|-
| Scegli Marca|| Consente di selezionare una marca esistente o crearne una nuova selezionando la voce Nuova Marca || Marca
|-
| Nome Marca|| Nel caso di Nuova Marca contiene il nome da associare || Stringa
|-
!colspan="3"| <div style = 'text-align: left> '''''Regola di generazione del nome del file di provisioning'''''
|-
| Scegli regola|| Consente di selezionare una regola esistente o crearne una nuova selezionando la voce Nuova Regola || Marca
|-
| Nome regola|| Nel caso di Nuova Regola contiene il nome da associare || Stringa
|-
| Prefisso|| Prefisso da aggiungere al nome file || Stringa
|-
| Formato indirizzo MAC|| Consente di selezionare il formato del MAC address da inserire nel nome file da una lista || Formato MAC Address
|-
| Suffisso|| Suffisso da aggiungere al nome file || Stringa
|-
|}
 
===Lista dei placeholder personalizzati===
[[File:Placeholder personalizzato.png|miniatura]]
Questo pannello contiene l’elenco di tutti i placeholder definiti dall’utente sul KPBX in aggiunti a quelli presenti di default. I placeholder custom hanno un formato del tipo %%_PLACEHOLDER%% e possono essere utilizzati all’interno dei template. <br>
 
E’ possibile definire due tipi di placeholder:
*Statico: viene utilizzato per non modificare tutti i template in cui viene utilizzato uno specifico valore.
*Dinamico: viene utilizzato per aggiornare dinamicamente alcuni valori associati al KPBX e non allo specifico utente. In questo momento gli unici placeholder dinamici disponibili sono quelli relativi agli IP address associati alle diverse interfacce di rete / VLAN.
 
{| class="wikitable"
|-
! Parametro !! Descrizione !! Valore
|-
|colspan="3"| <div style = 'text-align: center; color: transparent> -
|-
| Placeholder|| Identificativo del placeholder. Il placeholder da utilizzare è %%_PLACEHOLDER%% || Stringa
|-
| Tipo|| Consente di definire il tipo di placeholder  || Statico/dinamico
|-
| Valore|| Nel caso di placeholder statico viene inserito il valore da sostituire in generazione, nel caso di placeholder dinamico l’attributo del KPBX da utilizzare per la sostituzione. || Stringa / Attributo KPBX
|-
|}
 
===Lista dei  redirection server===
[[File:Lista Redirection Server.png|miniatura]]
Questo pannello contiene l’elenco di tutti i redirection server configurati dall’utente sul KPBX. Attualmente è supportata l’integrazione con i redirection server dei seguenti produttori:
*SNOM (https://sraps.snom.com/)
*Yealink (https://ymcs.yealink.com/)


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.
'''Nota''': In virtù di alcune limitazioni delle API messe a disposizione da Yealink / Escene la procedura di configurazione è differente nel caso di utilizzo del redirection server SNOM rispetto a quello degli altri due produttori. In particolare, nel caso di Yealink / Escene è necessario definire preventivamente un server accedendo alla WEB GUI di gestione del servizio RPS. Il nome di questo server verrà riferito in fase di configurazione del redirection server.


The provisioning devices can be configured in the [[AdminGuide:GUI:OperatingMenu:AutoProvisioning/en|AutoProvisioning]] page.
{| class="wikitable"
|-
! Parametro !! Descrizione !! Valore
|-
|colspan="3"| <div style = 'text-align: center; color: transparent> -
|-
| Marca del dispositivo || Marca del dispositivo per cui si sta definendo il redirection server || Snom / Yealink / Escene
|-
!colspan="3"| <div style = 'text-align: left> '''''Credenziali'''''
|-
| Username||Utente per l’autenticazione sul server RPS del produttore || Stringa
|-
| Password|| Password per l’autenticazione sul server RPS del produttore  || Stringa
|-
!colspan="3"| <div style = 'text-align: left> '''''Impostazioni'''''
|-
| Abilitato|| Consente di disabilitare il redirection server senza perderne la configurazione || Si / No
|-
| Nome|| Nome del redirection server da creare (se SNOM) o da utilizzare (nel caso Yealink / Escene) || Stringa
|-
| Indirizzo di provisioning|| Nel caso SNOM URL a cui viene effettuata la redirezione (ad es. https://192.168.0.100/provisioning/ ) || Stringa
|}


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.
==Template==
La generazione del file di configurazione per uno specifico dispositivo viene effettuata a partire da un template associato alla marca/modello di telefono che si intende utilizzare.<br>


When defining a template it is possible to use placeholders that Kalliope will automatically replace when generating the file.
Il formato del template dipende dalla marca/modello del telefono utilizzato ma anche eventualmente dalla versione del firmware installata sul dispositivo. <br>


These placeholders include:
Nella definizione del template è possibile utilizzare dei placeholder che il KalliopePBX sostituirà automaticamente in fase di generazione del file. <br>
* KalliopePBX attributes (e.g. SIP UDP/TCP port of the PBX);
Questi placeholder includono:
* attributes of the extension/account linked to the phone (e.g. SIP credentials, first name, last name, etc.);
*Attributi del KalliopePBX (ad es. porta SIP UDP/TCP del centralino)
* phone attributes (e.g. network parameters, access credentials, etc.).
*Attributi dell’account/interno associato al telefono (ad es. credenziali SIP, nome, cognome, etc.)  
*Attributi del telefono (ad es. parametri di rete, credenziali di accesso, etc.) <br>




Riga 26: Riga 164:


Once a file has been generated, it must be transferred to the phone. KalliopePBX provides the following file transfer protocols:
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).
*'''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>/).
*'''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.
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:
Per indicare al telefono quale protocollo deve essere utilizzato per scaricare il file di configurazione oltre all’indirizzo IP (ed eventuale path) del server di provisioning esistono diverse modalità la cui configurazione e ordine di esecuzione dipende dal modello di telefono utilizzato. Le modalità comunemente disponibili sono le seguenti:
 
*'''SIP PnP''': il telefono all’avvio invia un messaggio SIP SUBSCRIBE ad un indirizzo multicast. Se sul KalliopePBX il servizio SIP PnP è abilitato il PBX risponde con una SIP NOTIFY contenente l’IP address del TFTP server da utilizzare. Questa modalità non è utilizzabile nel caso di KalliopePBX multitenant.
*SIP PnP: upon starting up the phone sends a SIP SUBSCRIBE message to 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''': il telefono all’avvio prova a contattare il Redirection Server del produttore. Se il MAC Address del telefono è stato inserito il telefono viene rediretto al server indicato per il download del file di configurazione. In questa modalità è possibile utilizzare uno qualsiasi dei protocolli disponibili (in base al parametro configurato sul redirection server).
*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''': nel caso in cui in fase di assegnazione dell’indirizzo IP il DHCP Server comunichi al telefono anche la DHCP Option 66 contenente l’URL da contattare (incluso il protocollo da utilizzare), il telefono utilizzerà questa informazione per effettuare il download del file di configurazione.  
*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.
*'''Manuale''': è possibile avviare la configurazione anche manualmente dal telefono o dalla WEB GUI inserendo il protocollo da utilizzare e l’IP address (oltre eventualmente al path).
*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).

Versione delle 13:56, 20 set 2022

Altre lingue:

Return to AdminGuide:Service

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.

Configuration

This section collects all the configurations needed to perform auto-provisioning of a telephone device. You can also consult the list built-in devices for auto-provisioning

Device list

Provisioning.png

This page contains the list of all devices for which provisioning file generation has been configured.

The following table lists the configurable parameters for each device.

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.

It is necessary to select a template for each phone model for which you wish to generate a provisioning file.

Return to AdminGuide:Service

Lista dei modelli di dispositivo

Lista modelli dispositivo.png

Questo pannello contiene l’elenco di tutti i modelli di dispositivo definiti sul KPBX. Alcuni modelli di dispositivo sono distribuiti con il firmware del KPBX. Altri modelli possono essere aggiunti dall’utente per generare file di configurazione per modelli/produttori non esplicitamente supportati.

E’ inoltre possibile definire delle regole che consentono di creare dei file di provisioning con nomi arbitrari. Il nome del file può essere composto da un prefisso, indirizzo MAC (in diversi formati) e un suffisso.

The following table lists the configurable parameters for each model.

Parametro Descrizione Valore
-
Nome Nome del modello di dispositivo Stringa
Marca del dispositivo
Scegli Marca Consente di selezionare una marca esistente o crearne una nuova selezionando la voce Nuova Marca Marca
Nome Marca Nel caso di Nuova Marca contiene il nome da associare Stringa
-
Nome Nome del modello di dispositivo Stringa
Marca del dispositivo
Scegli Marca Consente di selezionare una marca esistente o crearne una nuova selezionando la voce Nuova Marca Marca
Nome Marca Nel caso di Nuova Marca contiene il nome da associare Stringa
Regola di generazione del nome del file di provisioning
Scegli regola Consente di selezionare una regola esistente o crearne una nuova selezionando la voce Nuova Regola Marca
Nome regola Nel caso di Nuova Regola contiene il nome da associare Stringa
Prefisso Prefisso da aggiungere al nome file Stringa
Formato indirizzo MAC Consente di selezionare il formato del MAC address da inserire nel nome file da una lista Formato MAC Address
Suffisso Suffisso da aggiungere al nome file Stringa

Lista dei placeholder personalizzati

Placeholder personalizzato.png

Questo pannello contiene l’elenco di tutti i placeholder definiti dall’utente sul KPBX in aggiunti a quelli presenti di default. I placeholder custom hanno un formato del tipo %%_PLACEHOLDER%% e possono essere utilizzati all’interno dei template.

E’ possibile definire due tipi di placeholder:

  • Statico: viene utilizzato per non modificare tutti i template in cui viene utilizzato uno specifico valore.
  • Dinamico: viene utilizzato per aggiornare dinamicamente alcuni valori associati al KPBX e non allo specifico utente. In questo momento gli unici placeholder dinamici disponibili sono quelli relativi agli IP address associati alle diverse interfacce di rete / VLAN.
Parametro Descrizione Valore
-
Placeholder Identificativo del placeholder. Il placeholder da utilizzare è %%_PLACEHOLDER%% Stringa
Tipo Consente di definire il tipo di placeholder Statico/dinamico
Valore Nel caso di placeholder statico viene inserito il valore da sostituire in generazione, nel caso di placeholder dinamico l’attributo del KPBX da utilizzare per la sostituzione. Stringa / Attributo KPBX

Lista dei redirection server

Lista Redirection Server.png

Questo pannello contiene l’elenco di tutti i redirection server configurati dall’utente sul KPBX. Attualmente è supportata l’integrazione con i redirection server dei seguenti produttori:

Nota: In virtù di alcune limitazioni delle API messe a disposizione da Yealink / Escene la procedura di configurazione è differente nel caso di utilizzo del redirection server SNOM rispetto a quello degli altri due produttori. In particolare, nel caso di Yealink / Escene è necessario definire preventivamente un server accedendo alla WEB GUI di gestione del servizio RPS. Il nome di questo server verrà riferito in fase di configurazione del redirection server.

Parametro Descrizione Valore
-
Marca del dispositivo Marca del dispositivo per cui si sta definendo il redirection server Snom / Yealink / Escene
Credenziali
Username Utente per l’autenticazione sul server RPS del produttore Stringa
Password Password per l’autenticazione sul server RPS del produttore Stringa
Impostazioni
Abilitato Consente di disabilitare il redirection server senza perderne la configurazione Si / No
Nome Nome del redirection server da creare (se SNOM) o da utilizzare (nel caso Yealink / Escene) Stringa
Indirizzo di provisioning Nel caso SNOM URL a cui viene effettuata la redirezione (ad es. https://192.168.0.100/provisioning/ ) Stringa


Template

La generazione del file di configurazione per uno specifico dispositivo viene effettuata a partire da un template associato alla marca/modello di telefono che si intende utilizzare.

Il formato del template dipende dalla marca/modello del telefono utilizzato ma anche eventualmente dalla versione del firmware installata sul dispositivo.

Nella definizione del template è possibile utilizzare dei placeholder che il KalliopePBX sostituirà automaticamente in fase di generazione del file.
Questi placeholder includono:

  • Attributi del KalliopePBX (ad es. porta SIP UDP/TCP del centralino)
  • Attributi dell’account/interno associato al telefono (ad es. credenziali SIP, nome, cognome, etc.)
  • Attributi del telefono (ad es. parametri di rete, credenziali di accesso, 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.

Per indicare al telefono quale protocollo deve essere utilizzato per scaricare il file di configurazione oltre all’indirizzo IP (ed eventuale path) del server di provisioning esistono diverse modalità la cui configurazione e ordine di esecuzione dipende dal modello di telefono utilizzato. Le modalità comunemente disponibili sono le seguenti:

  • SIP PnP: il telefono all’avvio invia un messaggio SIP SUBSCRIBE ad un indirizzo multicast. Se sul KalliopePBX il servizio SIP PnP è abilitato il PBX risponde con una SIP NOTIFY contenente l’IP address del TFTP server da utilizzare. Questa modalità non è utilizzabile nel caso di KalliopePBX multitenant.
  • Redirection Server: il telefono all’avvio prova a contattare il Redirection Server del produttore. Se il MAC Address del telefono è stato inserito il telefono viene rediretto al server indicato per il download del file di configurazione. In questa modalità è possibile utilizzare uno qualsiasi dei protocolli disponibili (in base al parametro configurato sul redirection server).
  • DHCP OPTION 66: nel caso in cui in fase di assegnazione dell’indirizzo IP il DHCP Server comunichi al telefono anche la DHCP Option 66 contenente l’URL da contattare (incluso il protocollo da utilizzare), il telefono utilizzerà questa informazione per effettuare il download del file di configurazione.
  • Manuale: è possibile avviare la configurazione anche manualmente dal telefono o dalla WEB GUI inserendo il protocollo da utilizzare e l’IP address (oltre eventualmente al path).
Estratto da "https://www.kalliope.com/wiki/index.php?title=AdminGuide:Service:AutoProvisioning/en&oldid=17744"