innovaphone wiki - User contributions [en]

ReleaseNotes16r1:Firmware

2026-09-24T07:56:04Z

Slu:

This is the Firmware 16r1 Release Notes Document.

{{GeneralReleaseNoteClarifications}}

* [[Howto16r1:Firmware_Upgrade_V15r1_V16r1]]

__NOEDITSECTION__
{{#invoke-url: http://wiki.innovaphone.com/extensions/InvokeUrlFunction/projectListWebsocket.php?project=Firmware%2016r1}}

[[Category:Release Notes|Firmware]]

Howto16r1:Configure OAuth2 E-Mail

2026-09-10T11:52:21Z

Slu: /* Related Articles */

The innovaphone PBX and apps can be configured to send E-Mails for various subjects and purposes. Major E-Mail providers intent to discontinue the username/password authentication schemes in favour of OAuth2. PBX and Apps version 16r1 does support OAuth2 authentication for SMTP. Here is a step by step guide how to set up OAuth2 support in Microsoft 365 through the Azure Portal and how to set it up on a Google Gmail account in the Google Cloud Console.

== General Information ==
Most of the large email providers offer the possibility to define an app that is allowed to gain access of a certain scope like SMTP. 
It assigns a Client ID / Client Secret. 
 
Authorization for sending from the mail account needs to be given one time either: 
* By providing resource owner username/password. Sending this to the token endpoint results in an access token and long term refresh token.
* By interactive authorization via a popup dialogue that is loaded from the authorization endpoint. After the credentials are verified, the dialogue redirects to the redirect URI with an authorization code that is traded to an access token and refresh token.
 
The access token is sent for authentication in SMTP. It needs regular refresh, which will be done automatically.

=== Modes ===

* '''Exchange''': Microsoft, with interactive authorization
* '''Microsoft 365''': Microsoft, without interactive authorization (Resource owner and password has to be filled)
* '''Gmail''': Google, with interactive authorization
* '''Google Service Account''': Google, without interactive authorization (Client e-mail, Private Key ID and Private Key of the service account must be provided)
* '''Client secret post''': Generic configuration where all parameters of the client secret post OAuth2 flow can be set.
* '''Private key jwt''': Generic configuration where all parameters of the private key jwt OAuth2 flow can be set.

=== Example Redirect URIs ===

* '''PBX''': <nowiki>https://example-pbx.domain.com/OAUTH2-CLIENT/auth.htm</nowiki>
* '''Reporting''': <nowiki>https://example-ap.domain.com/domain.com/reporting/auth.htm</nowiki>
* '''Fax''': <nowiki>https://example-ap.domain.com/domain.com/</nowiki>'''F'''ax/auth.htm
* '''Users''': <nowiki>https://example-ap.domain.com/domain.com/usersapp/auth.htm</nowiki>
* '''Connect''': <nowiki>https://example-ap.domain.com/domain.com/messages/auth.htm</nowiki>
* '''AP Manager''': <nowiki>https://example-ap.domain.com/manager/auth.htm</nowiki>

== Microsoft 365 ==
=== Azure Portal ===
Log in to Microsoft Azure Portal (https://portal.azure.com) and go to Microsoft Entra ID.
[[File:AzureMicrosoftEntraID.png|none|thumb|600x600px|/AzureMicrosoftEntraID.png|/AzureMicrosoftEntraID.png]]
Add a new app registration to create client credentials.
[[File:AzureAddAppRegistration.png|none|thumb|600x600px|/AzureAddAppRegistration.png|/AzureAddAppRegistration.png]]
Register the application and maybe already fill in the redirect URI for Web based application type to path OAUTH2-CLIENT/auth.htm at the PBX.
[[File:AzureRegisterAnApplication.png|none|thumb|600x600px|/AzureRegisterAnApplication.png|/AzureRegisterAnApplication.png]]
App registration is complete. Client ID and tenant needs to be configured at the PBX and every app that will be sending e-mails.
[[File:AzureApp.png|none|thumb|600x600px|/AzureApp.png|/AzureApp.png]]
Create a client secret. Note that expiry is limited to no longer than 2 years. The client secret must be renewed before expiry and the new secret configured and interactive authorisation carried out again to ensure continuous operation.
[[File:AzureAddClientSecret.png|none|thumb|600x600px|/AzureAddClientSecret.png|/AzureAddClientSecret.png]]
Copy the client secret. It also needs to be configured at the PBX and every app that will be sending e-mails.
[[File:AzureCopyClientSecret.png|none|thumb|600x600px|/AzureCopyClientSecret.png|/AzureCopyClientSecret.png]]
Add permissions located in APIs my organization uses.
[[File:AzureAddApiPermissionMyOrganization.png|none|thumb|600x600px|/AzureAddApiPermissionMyOrganization.png|/AzureAddApiPermissionMyOrganization.png]]
More precisely located in Office 365 Exchange Online.
[[File:AzureAddApiPermissionExchange.png|none|thumb|600x600px|/AzureAddApiPermissionExchange.png|/AzureAddApiPermissionExchange.png]]
And there in the application permissions.
[[File:AzureAddApiExchangeApplication.png|none|thumb|600x600px|/AzureAddApiExchangeApplication.png|/AzureAddApiExchangeApplication.png]]
Namely SMTP Mail.Send.
[[File:AzureAddApiSendMailAsUser.png|none|thumb|600x600px|/AzureAddApiSendMailAsUser.png|/AzureAddApiSendMailAsUser.png]]
Grant admin permission for Mail.Send.
[[File:AzureGrantApiPermissions.png|none|thumb|600x600px|/AzureGrantApiPermissions.png|/AzureGrantApiPermissions.png]]
API permissions are now granted.
[[File:AzureApiPermissionsGranted.png|none|thumb|600x600px|/AzureApiPermissionsGranted.png|/AzureApiPermissionsGranted.png]]
Tell all redirect URIs that the PBX and the apps will be using during interactive authorization.
[[File:AzureRedirectUris.png|none|thumb|600x600px|/AzureRedirectUris.png|/AzureRedirectUris.png]]
Allow public client flows of OAuth2. Resource Owner Password Credentials Flow has the advantage that it doesn't need interactive authorization.
[[File:AzureAllowPublicClientFlows.png|none|thumb|600x600px|/AzureAllowPublicClientFlows.png|/AzureAllowPublicClientFlows.png]]

=== Microsoft 365 admin center ===
Log in to the Microsoft 365 admin center (https://admin.cloud.microsoft).
[[File:MS365AdminCenter.png|none|thumb|600x600px|/MS365AdminCenter.png|/MS365AdminCenter.png]]
Make sure that Microsoft 365 licenses are assigned to your user.
[[File:MS365UserLicenses.png|none|thumb|600x600px|/MS365UserLicenses.png|/MS365UserLicenses.png]]
Set your user active.
[[File:MS365ActiveUsers.png|none|thumb|600x600px|/MS365ActiveUsers.png|/MS365ActiveUsers.png]]
Locate the Mail tab of your user.
[[File:MS365UserEMail.png|none|thumb|600x600px|/MS365UserEMail.png|/MS365UserEMail.png]]
Allow authenticated SMTP.
[[File:MS365AuthenticatedSMTP.png|none|thumb|600x600px|/MS365AuthenticatedSMTP.png|/MS365AuthenticatedSMTP.png]]

=== PBX Example configuration ===
With this Microsoft setup the OAuth2 configuration for the resource owner password credentials flow can be filled in as follows.
[[File:OAuth2ResourceOwnerPasswordCredentials.png|none|thumb|600x600px|/OAuth2ResourceOwnerPasswordCredentials.png|/OAuth2ResourceOwnerPasswordCredentials.png]]
For interactive authorization this is the OAuth2 configuration. Authorize e-mail access one time and send a test mail to verify everything went well.
[[File:OAuth2InteractiveAuthorization.png|none|thumb|600x600px|/OAuth2InteractiveAuthorization.png|/OAuth2InteractiveAuthorization.png]]

== Gmail ==
=== Preparations ===
Login to the Google Cloud Console (https://console.cloud.google.com), select a project, New project.
[[File:GoogleSelectProject.png|none|thumb|600x600px|/GoogleSelectProject.png|/GoogleSelectProject.png]]
Create the project.
[[File:GoogleCreateProject.png|none|thumb|600x600px|/GoogleCreateProject.png|/GoogleCreateProject.png]]
Client credentials will be created in this project.
[[File:GoogleProjectCreated.png|none|thumb|600x600px|/GoogleProjectCreated.png|/GoogleProjectCreated.png]]
From the library specify the APIs needed to access.
[[File:GoogleApisServicesFromLibrary.png|none|thumb|600x600px|/GoogleApisServicesFromLibrary.png|/GoogleApisServicesFromLibrary.png]]
These are in the Gmail API.
[[File:GoogleApisServicesApiLibrary.png|none|thumb|600x600px|/GoogleApisServicesApiLibrary.png|/GoogleApisServicesApiLibrary.png]]
Choose the Gmail API and enable it.
[[File:GoogleGmailApis.png|none|thumb|600x600px|/GoogleGmailApis.png|/GoogleGmailApis.png]]
Credentials need to be created.
[[File:GoogleGmailApiAdded.png|none|thumb|600x600px|/GoogleGmailApiAdded.png|/GoogleGmailApiAdded.png]]
Invoke the help me choose wizard.
[[File:GoogleCreateCredentialsHelpMeChoose.png|none|thumb|600x600px|/GoogleCreateCredentialsHelpMeChoose.png|/GoogleCreateCredentialsHelpMeChoose.png]]
User data access is needed.
[[File:GoogleCredentialsUserData.png|none|thumb|600x600px|/GoogleCredentialsUserData.png|/GoogleCredentialsUserData.png]]
Configure the consent screen of the interactive authorization.
[[File:GoogleOAuthConsentScreen.png|none|thumb|600x600px|/GoogleOAuthConsentScreen.png|/GoogleOAuthConsentScreen.png]]
Specify the permissions that need to be authorized by the user.
[[File:GoogleOAuthScopes.png|none|thumb|600x600px|/GoogleOAuthScopes.png|/GoogleOAuthScopes.png]]
Its mail.google.com in general.
[[File:GoogleScopeMailGoogleCom.png|none|thumb|600x600px|/GoogleScopeMailGoogleCom.png|/GoogleScopeMailGoogleCom.png]]
And its to send email on the users behalf.
[[File:GoogleScopeAuthGmailSend.png|none|thumb|600x600px|/GoogleScopeAuthGmailSend.png|/GoogleScopeAuthGmailSend.png]]
These are the scopes needed.
[[File:GoogleScopes.png|none|thumb|600x600px|/GoogleScopes.png|/GoogleScopes.png]]
Ask client credentials for Web type application.
[[File:GoogleOAuthClientID.png|none|thumb|600x600px|/GoogleOAuthClientID.png|/GoogleOAuthClientID.png]]
Tell all redirect URIs that the PBX and the apps will be using during interactive authorization.
[[File:GoogleRedirectURIs.png|none|thumb|600x600px|/GoogleRedirectURIs.png|/GoogleRedirectURIs.png]]
Download the credentials. This json file contains all information for OAuth2 configuration.
[[File:GoogleClientCredentialsDownload.png|none|thumb|600x600px|/GoogleClientCredentialsDownload.png|/GoogleClientCredentialsDownload.png]]
Customize the OAuth consent screen
[[File:GoogleOAuthConsentScreenSettings.png|none|thumb|600x600px|/GoogleOAuthConsentScreenSettings.png|/GoogleOAuthConsentScreenSettings.png]]
Start the customization wizard.
[[File:GoogleConsentScreenWizard.png|none|thumb|600x600px|/GoogleConsentScreenWizard.png|/GoogleConsentScreenWizard.png]]
Choose which users may authorize.
[[File:GoogleAudienceExternal.png|none|thumb|600x600px|/GoogleAudienceExternal.png|/GoogleAudienceExternal.png]]
Google workspace users may choose internal audience. Users not in Google workspace proceed with external.
[[File:GoogleContactInformation.png|none|thumb|600x600px|/GoogleContactInformation.png|/GoogleContactInformation.png]]
Add a test user.
[[File:GoogleTestUserAdded.png|none|thumb|600x600px|/GoogleTestUserAdded.png|/GoogleTestUserAdded.png]]

=== PBX Example configuration ===
The OAuth2 parameters can be filled in with the information from the json file downloaded above. Authorize e-mail access one time and send a test mail to verify everything went well.
[[File:OAuth2InteractiveGmail.png|none|thumb|600x600px|/OAuth2InteractiveGmail.png|/OAuth2InteractiveGmail.png]]

== Generic ==

For other e-mail providers the client secret post OAuth2 flow may be configured in a generic way. Details need to be supplied by the e-mail provider.

For the Microsoft 365 setup above it would be as follows with Token endpoint ''<nowiki>https://login.microsoftonline.com/af326a34-169c-469e-946b-1ef57925306b/oauth2/v2.0/token</nowiki>'' Authorization URL ''<nowiki>https://login.microsoftonline.com/af326a34-169c-469e-946b-1ef57925306b/oauth2/v2.0/authorize?scope=https://outlook.office.com/SMTP.Send</nowiki> offline_access'' The configuration appends ''&response_type=code&prompt=consent&login_hint=...&redirect_uri=...&client_id=...'' automatically.[[File:OAuth2ClientSecretPost.png|none|thumb|600x600px|/OAuth2ClientSecretPost.png|/OAuth2ClientSecretPost.png]]
For the Gmail example above the generic confguration would be like this with Token endpoint ''<nowiki>https://oauth2.googleapis.com/token</nowiki>'' Authorization URL ''<nowiki>https://accounts.google.com/o/oauth2/auth?access_type=offline&scope=https://mail.google.com/</nowiki>'' The configuration appends ''&response_type=code&prompt=consent&login_hint=...&redirect_uri=...&client_id=...'' automatically.
[[File:OAith2ClientSecretPostGmail.png|none|thumb|600x600px|/OAith2ClientSecretPostGmail.png|/OAith2ClientSecretPostGmail.png]]
The private key jwt OAuth2 flow can be configured generically as well.[[File:OAuth2PrivateKeyJWT.png|none|thumb|600x600px|/OAuth2PrivateKeyJWT.png|/OAuth2PrivateKeyJWT.png]]

== Related Articles ==
* [[Reference16r1:PBX/Config/Authentication]]
* [[Reference16r1:Apps/PbxManager/Email]]
* [[Reference16r1:Concept App Connect#E-Mail configuration]]
* [[Reference15r1:Concept App Service Fax#Mail Configuration (SMTP Server)|Reference16r1:Concept App Service Fax#Mail Configuration (SMTP_Server)]]
* [[Reference16r1:Concept App Service Reports#Configuration|Reference16r1:Concept App Service Reports#Configuration]]
* [[Reference16r1:Concept App Service Users#Users Admin App (innovaphone-usersadmin)]]
* [[Reference16r1:Concept App Platform#SMTP]]

Reference16r1:Concept App Service Reports

2026-09-10T11:51:36Z

Slu: Created page with "Apps The App Service Reporting is an App Service which can be installed on an innovaphone App Platform. It is used to provide call lists in myApps and to create call reports. == Applies To == * innovaphone PBX from version 13r1 == Technical Overview == concept_reporting.png/ == Apps == === Reports App (innovaphone-reporting) === This is the Reporting UI App. File:Reference14r1_Concept_App_Service_Reports_App...."

[[Category:Concept|Apps]]

The App Service Reporting is an App Service which can be installed on an innovaphone App Platform. It is used to provide call lists in myApps and to create call reports.

== Applies To ==

* innovaphone PBX from version 13r1

== Technical Overview ==
[[Image:Concept_reporting.png|concept_reporting.png/]]

== Apps ==

=== Reports App (innovaphone-reporting) ===
This is the Reporting UI App.

[[File:Reference14r1_Concept_App_Service_Reports_App.png|600px|reference14r1_concept_app_service_reports_app.png/]]

Legend of used symbols:

[[Image:Reporting_symbol_legend.png|reporting_symbol_legend.png/]]

You can display all or filtered calls and sort them by time, name, call and alert duration.
The amount of displayed entries in the UI is limited to 10000.

Parameters:

;Websocket:

=== Call List App (innovaphone-calllist) ===
This is the Call list App.

Parameters:

;Websocket:

=== Call List API (innovaphone-calllist-api) ===
This is an App, which provides the Call list API (com.innovaphone.calllist). This API can be used to find the recent calls of a user.

Parameters:

;Websocket:

== PBX Manager Plugins ==

=== Reporting ===

With the Reporting plugin App objects can be created, edited and deleted for the provided Apps.

====Configuration====

Following configuration options are offered:

* CDR handling
** automatic deletion of CDRs
** deletion interval - default is 90 days. If configured, deletion is performed at 3 a.m. UTC.

* Account for CDR authentication

* Account for authentication for external apps (When username and password are defined external app will be able to fetch PDF,XML or CSV report with HTTP GET requests using HTTP Authentication.)

* SMTP Configuration
When reports should be send by email the SMTP Server address and the login credentials must be specified. An example configuration can be seen on the screen shot.
 
 
[[File:Reference14r1_Concept_App_Service_PBX-Manager-Plugin.png|400px|SMTP Configuration|reference14r1_concept_app_service_pbx-manager-plugin.png/]]

Starting with 16r1 you also can configure OAuth2 Authentications. You can have a look into our HowTo Article for assistance: [[Howto16r1:Configure OAuth2 E-Mail]]

== Concepts ==
===Database Structure===

====cdrs====
The service receives CDRs in XML format at the URL http://AP-IP/DOMAIN/reporting/cdr . That URL must be configured at the PBX.

Each received cdr-xml is formed by a cdr tag and an undefined number of event and group tags.
(Refer to: [[Reference13r3:Concept Call Detail Record CDR PBX|CDR]])

This section is composed by four tables: cdrs, events, groups and cdr_properties.
The first three tables contain the corresponding fields to store the information contained in the cdr, event and group tags. 
Each CDR represents the call in the view of one PBX object. So there might be multiple CDRs for one call if multiple PBX objects are used within the call.

* '''cdr fields:'''
** id
** guid
** user_guid
** conf
** sys
** pbx
** node
** phys
** device
** h323
** e164
** cn
** dn
** email
** dir
** external
** licensed
** more_calls: set inside the CDR XML if there are multiple calls for the same call and user (e.g. multiple registrations)
** conn_duration
** alert_duration
** call_duration
** billing_duration
** utc_stamp: unix timestamp in '''milliseconds''' since 1970
** cause
** remote_e164
** remote_h323
** remote_dn
** call_list: CDR which is suitable for calllist or report queries (this flag is set depending on data received inside a CDR)
** missed_call
** status: the final state of the CDR (co: connected, al: alerting, er: error, bu: busy)
** further: flag is set if CDR has been cancelled with cause 26 (non selected user clearing) indicating that there will be another more suitable CDR for the same call
** user_id
** callback_e164
** callback_h323
** callback_dn
** callback_time
** remote_clir: this flag is set if the remote side suppresses the calling information (number, name etc.)

* '''event fields:'''
** id
** cdr_id
** msg
** ext
** e164
** h323
** dn
** conf
** cause
** time: the kernel uptime of the sending gateway in seconds. Substract time from a newer event (higher id) of a previous event to get the elapsed seconds inbetween.
** clir

* '''group fields:'''
** id
** name
** active
** type
** cdr_id

'''id''' field is assigned by postgresql for each entry and has nothing to do with the information present in the cdr. It is different for each entry inside the table.

The events table has two additional fields, called cdr_id, to associate these events to the corresponding cdr entry and order_index to keep their position inside the cdr.
Groups table has also the cdr_id field to associate the group entries to the corresponding cdr and events entries.

The table cdrp_properties from version 10 has been removed. Most columns can be now found directly in the table cdrs.
If you need the callflow in a similar way, you can JOIN the events table (GROUP BY cdr_id) and run a query which creates an array string from the events table:

array_agg(array[ev.msg, COALESCE(ev.e164,''), COALESCE(ev.h323,''), COALESCE(ev.dn,'')] ORDER BY ev.id) AS callflow

====cdr_users====

This table contains a timestamp '''missed_calls_time''' for the last call list access by a user '''sip'''. It is used to retrieve information about missed calls since the last use of mypbx/myApps. 
The timestamp '''clear_report_time''' indicates the last clearance time. 

===Database query samples===

====Calllist query====

SELECT cdr.id, cdr.cn, cdr.conf, dir, external, alert_duration, call_duration, conn_duration, billing_duration,
sys, pbx, node, phys, cdr.cause, utc_stamp, status, further,
CASE WHEN remote_clir THEN <nowiki>''</nowiki> ELSE remote_e164 END,
CASE WHEN remote_clir THEN <nowiki>''</nowiki> ELSE remote_h323 END,
CASE WHEN remote_clir THEN <nowiki>''</nowiki> ELSE remote_dn END,
callback_e164, callback_h323, callback_dn, callback_time, cdr.e164, cdr.h323
FROM cdrs cdr
JOIN cdr_users cu ON cdr.user_id = cu.id
WHERE cu.cn NOT IN ('_ADMIN_','_KADMIN_','_EXTERN_','_UNKNOWN_','_MASTER_','_STANDBY_','_ACTIVE_','_MOH_','_HTTP_','_CONF_') AND (cu.sip = 'sip' OR cu.guid = '00000000000000000000000000000000')
AND cdr.call_list = true
AND (cu.clear_report_time IS NULL OR utc_stamp > cu.clear_report_time)
ORDER BY utc_stamp DESC, cdr.id DESC LIMIT '5' OFFSET '0'

====Reporting query====

WITH inp AS (SELECT 1611187200000::BIGINT AS from, 1611211143042::BIGINT AS to, 'sip'::VARCHAR AS sip, 'cn'::VARCHAR AS cn, 'TRUE'::BOOLEAN AS check_objects)
SELECT cdr.id, cdr.cn, cdr.conf, dir, external, alert_duration, call_duration, conn_duration,
billing_duration, sys, pbx, node, phys, cdr.cause, utc_stamp, status, further, remote_e164,
remote_h323, remote_dn, callback_e164, callback_h323, callback_dn, callback_time, cdr.e164,
cdr.h323, cdr.dn,
array_agg(array[ev.msg, COALESCE(ev.e164,<nowiki>''</nowiki>), COALESCE(ev.h323,<nowiki>''</nowiki>), COALESCE(ev.dn,<nowiki>''</nowiki>), 'false'] ORDER BY ev.id)
FROM inp, cdrs cdr
JOIN cdr_users cu ON cdr.user_id = cu.id
JOIN events ev ON ev.cdr_id = cdr.id
WHERE cdr.call_list = true
AND cdr.licensed = true
AND utc_stamp >= inp.from
AND utc_stamp < inp.to
AND (inp.check_objects=false OR LOWER(cu.sip) LIKE LOWER(inp.sip) OR LOWER(cu.cn) LIKE LOWER(inp.cn))
GROUP BY cdr.id
ORDER BY utc_stamp ASC
LIMIT 10000

=== Database access ===

You have to grant [[Reference14r1:Concept App Platform#Database|database access]] in the AP-Platform.
 
The database user and password can be configured for every Reporting instance inside the AP Manager if you edit the instance. 
These database credentials are just used internally and not e.g. inside the PBX App Objects.

==== Write an own app ====

Currently there can be two ways for an own App:

* You receive the CDRs from the CDR interfaces yourself and store them into your own database with your own structure.
* You hand the Reporting database credentials to your own App and connect directly to the Reporting database within your own App. This saves you the parsing and storing of the data, but you must maintain your queries if something in the Reporting database is changed. It is important, that you should just access this data '''readonly''' and that you do '''not modify''' table data!

Example for automatic download of existing CSV files:

#establish a web socket connection for reporting using [[Reference13r2:Concept Talking to the v13 Application Platform using PHP| PHP]]
#request the session key with { "mt": "Start" }
#receive the session key which e.g. looks like {"mt": "StartResult", "session": "189", "key": "552ca6fe05a19"}
#while the web socket connection is established, a GET request using received data can be sent like this:
#*<nowiki>http://AP-IP/DOMAIN/reporting/reports/report-20200408-1015.csv?session=189&key=552ca6fe05a19&lang=de&tz=Europe/Berlin&type=csv&sip=&from=1586304000000&to=1586333749607</nowiki>

==== Remote Interface ====

You can retrieve the PDF/XML/CSV report with a remote interface. After the configuration in the PBX Manager Plugin (Set user name and password under '''[[Reference14r1:Apps/PbxManager/App Reports#Account for external applications| Account for external applications]]''') make a GET HTTP request to http://AP-IP/DOMAIN/reporting/ext/ with the following parameters:

from : the from date/time as a local timestamp
to: the to date/time as a local timestamp
type: the return format, allowed values:
xml
pdf
csv
[anonymous]: anonymizes names and numbers ("true" or "false"), default is true

[filterNames]: use a filter with its name. You can use multiple filters inside of a filter array filterNames=[{"name":"filter1"},{"name":"filter2"},...]
[lang]: the language, e.g. "en" or "de"
tz: the time zone corresponding to the time stamp
[sip]: the SIP or Cn (Long Name) of the object you want to filter for

Parameters in [] are optional.

Example:

http://ap.innovaphone.com/innovaphone.com/reporting/ext/report.xml?lang=en&tz=Europe/Berlin&type=xml&sip=&from=1692136800000&to=1698056896320&filterNames=&anonymous=true

Gets all records between 2023-08-16 and 2011-10-23 in time zone Europe/Berlin.

http://ap.innovaphone.com/innovaphone.com/reporting/ext/report.xml?lang=en&tz=Europe/Berlin&type=xml&sip=&from=1692136800000&to=1698056896320&filterNames=[{"name":"Only Incoming Calls"}]&anonymous=true

Gets all "Incoming calls" records between 2023-08-16 and 2011-10-23 in time zone Europe/Berlin. (The filter must be defined beforehand)

===CSV, XML or PDF export===

There is no limit of entries anymore concerning the export as XML,CSV or PDF (Previously there was a limit of 20000 entries). But keep in mind, that the creation of large reports will take a considerable amount of time and load. Depending on your hardware the download of very large reports may take several minutes and currently no feedback is given by the service when a "Download report" request is made. (This will be added in future versions).

The field description applies to the '''CSV''' columns!

* time: the node contains a formatted time string of the local time
* object: the PBX object name (also called cn)
* conference id: the conference id of the call
* call: '''int''' (internal) or '''ext''' (external) call
* Original Called,: In case of Call flow; The original called device
* Diverting,: In case of Call flow; The diverting device
* Transferring,: In case of Call flow; The transferring device
* node: the node of the PBX object
* pbx: the pbx of the PBX object
* phys: physical location name of the pbx
* cause: the decimal disconnect reason of the call (see [[Reference:ISDN_Cause_Codes]])
* remote:
** outgoing calls -> dialed endpoint
** incoming calls -> first ep2 above entry event or entry event if this is the first one
** incoming calls with incoming transfer after entry event -> transfer target
* status:
** outgoing calls -> best found status in call flow
** incoming calls -> status of entry event
** '''co''' (connected)
** '''al''' (alert)
** '''er''' (error)
** '''bu''' (busy)
* type: the type of the entry event or, if not set, the type of the next event, if given
** empty: direct call
** '''ct''': call transfer
** '''cf''': call forward
** '''cct''': call transfer with consultation
** '''pu''': call pickup
* direction: '''o''' (outgoing) if the first event is the entry event and the caller is ep1
* direction: '''i''' (incoming) if not o
* alert-duration: alert time
*Billing Duration: the duration, a user must be billed for
** outgoing call -> duration from the first event until the last event in the flow
** incoming call -> duration from the first transfer/forward event until the last event in the flow
* call-duration/Call Duration (Total): duration of the whole call, e.g. with the duration of a subsequent transfer
* conn-duration/Call Duration (User): just the time, the user was connected. Duration from the entry event until the event, where the local endpoint isn't connected any more
* Further Registration: If more than one devices is registered to the same object, each device creates a CDR. This field identifies the additional CDRs for the same call
* Object Info: combination of object names and number
* Date: extracted date only from the time_string
* Time_2: extracted time only from the time_string

Note that a CSV export doesn't contain the whole call flow!

===Filters===

==== General ====

Filters are set up to create reports based on certain conditions. ( Attention must be taken as the filters are AND combined to the date filters '''From''' and '''To''' and the quick filter '''Name or SIP'''). A filter can have multiple conditions (Name, Number, Group, PBX Name. Time... ) and multiple filters can be combined on report creation. Multiple filters are OR combined. So in the following picture you would see all incoming calls plus all transferred calls plus all calls made on the PBX Berlin.
A filter has a unique name.

[[Image:Reference14r1_Concept_App_Service_Reports_Filters.png|600px|reference14r1_concept_app_service_reports_filters.png/]]

There are five or seven condition sections depending on what is selected under States. Conditions inside same section are OR associated while different sections are AND associated.

''(Name == Terra OR Name == Uranus) AND (PBX == sifi) AND (Number == 0049%)''

==== SQL Wildcard ====

Like seen in the previous line you may use the SQL wildcard "%" which matches everything (so Inn% matches Innovaphone, Inno, Innovahone Gmbh ...) and corresponds to the better known "*" wildcard.

==== Base filter ====

If you select another filter as base filter, the conditions of the base filter are implicitly AND conjuncted, when the current filter is used.
So if the base filter defines two PBX values, e.g. "Berlin" and "Hamburg" and the current filter defines one PBX value, e.g. "Berlin", only objects of the PBX "Berlin" will be filtered:

''(pbx="Berlin") AND (pbx="Berlin" OR pbx="Hamburg")''

'''Anonymous'''

If you check this flag, a report created with this filter or with a filter, where this filter is a base filter, will by anonymized.

'''Local'''

Define one ore more conditions for the local party, defined by:

Name or SIP: the cn/PBX object name/sip
Number: the number
Groups: a group of the PBX object

'''Remote'''

Define one or more conditions for the remote party, defined by:

Name: cn or sip
Number: the number
Remote display name: the display name

'''PBX'''

Define one ore more conditions for the PBX, defined by:

PBX: the PBX name
Node: the node name

'''States'''

No Response
Connected
Busy
No Channel

'''Directions'''

Incoming
Outgoing
Transfer: calls, which have been transferred to the current local party (calls which were initiated by a transfer action)
Call Forward: calls, which have been forwarded to the current local party

[[Image:Reference14r1_Concept_App_Service_Reports_Filters_Second_Part.png|300px|thumb|left|Filter Definition lower part|reference14r1_concept_app_service_reports_filters_second_part.png/]]

'''Call domain'''

Internal calls
External calls

'''Call Duration'''

Time the call was connected.

This condition will be AND with the others if all States are selected.
If Busy, No Channel or No Response is unselected, then the filter will search for Connected calls with connected time greater or smaller than Call Duration.

'''Alert Duration'''

Time the call was ringing independent of the status of the call afterwards.

This condition will be AND with the others if all States are selected.
If Busy, No Channel or Connected is unselected, then the filter will search only for Not Connected Calls that were ringing more or less time than Alert Duration.

'''Report times'''

Define the time where calls should be counted.
You can optionally define the weekday(s) of calls.

'''Using Patterns'''

You can use these PostgreSQL Patterns for every condition.

== Report Mails ==

You can send daily, weekly or monthly emails with attached reports and apply filters on them. There is no limit concerning the size of the reports but keep in mind, that your email provider might not allow attachments exceeding a certain size e.g. 20 MB.
The automatic report generation can be configured here:

[[Image:Reference14r1_Concept_App_Service_Reports_Email.png|300px|thumb|left|Report Email Settings|reference14r1_concept_app_service_reports_email.png/]]

'''User reports'''

Creates for each matching user a separate report
Users are matched by Object (Long Name). A user report only contains calls for this user. The email address of the user is built by its H323 name and the System Name of its PBX (h323@systemname) or determined by the E-Mail field of the user

'''Name'''

Quick filter for the cn/sip

'''Filter'''

Applied filter to the report

'''Output Format'''

PDF,CSV,XML (CSV and XML can be gzip compressed)

'''Displayed Duration'''

used for PDF reports (call duration total/user, billing duration)

'''Interval'''

daily: Mail will be send daily with the automatic period "last day"
weekly: Mail will be send weekly with the automatic period "last week"
monthly: Mail will be send daily with the automatic period "last month"

'''Day'''

the day, at which the report is sent

'''E-mail adresse(s)'''

recipients of the report (semicolon separated)

'''Compress'''

compress the attachment or not

'''Language'''

language used for the report

'''Sorting'''

sort entries by time, name, call or alert duration

'''Send time'''

the time of a day, when the report is sent

'''Time zone'''

the time zone corresponding to the send time

== Simple Statistics ==

[[Image:Reference14r1_Concept_App_Service_Reports_Statistics.png|300px|thumb|left|Report Email Settings|reference14r1_concept_app_service_reports_statistics.png/]] The Reports App as well as PDF Reports offer simple statistics where the number of incoming and outgoing calls are displayed as well as their respective total and average call and alert duration. Be aware that a transferred call with multiple participants may be counted multiple times as in fact CDRs are displayed.

==Troubleshooting==
Trace flags for App instance on App Platform:

*App
*App Database
*Webserver traffic (shows the communication with the PBX)
*App Websocket (shows the communication with the client in browser)

Trace flags for myAPPS Client:

*Browser Console

== Known issues ==

=== Missed calls query takes long ===
In some scenerios, the missed calls query takes quite long. 13r3 addresses this issue by adding a new combined index.
You can add this index yourself in earlier version through SSH (as root user):

psql -d reporting_db_name
CREATE INDEX cdrs_user_id_utc_stamp_index ON cdrs (user_id,utc_stamp);

Do not change the index name, as updates to 13r3 will create a second index otherwise!

Main Page

2026-09-01T13:45:04Z

Slu: /* Latest News */

__NOTOC__

<div style="margin:0px; margin-right:10px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0em 1em;">
== Remote Support ==
[[Image:RemoteControl-click.png|left|60px|RemoteControl.png/|Download Remote Control|link=https://store.innovaphone.com/release/download/software/remotecontrolwindowsportable/16r1/remoteControl.exe]]
innovaphone only carries out scheduled remote maintenance via our ticket system by prior consultation. 
As Remote Support Tool, we use our own product Remote Control ([https://www.innovaphone.com/en/all-apps/apps-to-work-with/remote-control-app.html more info]).

You can '''[https://store.innovaphone.com/alpha/download/software/remotecontrolwindowsportable/16r1/remoteControl.exe download]''' the Remote Control client already or use the support link received from our support team. 
After installing and opening the client you can '''pass the shown ID''' or '''use the received link''' to request the support session.

== Searching ==
Searching in wiki works, but is sometimes cumbersome. However, you can have Google do the job for you. Try [https://www.google.de/search?q=site%3Ainnovaphone.com+xml+documentation <code>site:innovaphone.com your search terms</code>] to search the innovaphone sites for matches!

If you still don't find what you are looking for, [mailto:presales@innovaphone.com drop us a message]
</div>


<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em;">



== Latest News ==
[[User:Lmi|Lmi]] ([[User talk:Lmi|talk]]) 15:40, 27 August 2026 (CEST) [[Support:Firmware V16r1 product/16r1/firmware 1610979 (sr4) available | Version 16r1 Service Release 4]] is now available from the [http://store.innovaphone.com/release/download.htm download page].

[[User:Lmi|Lmi]] ([[User talk:Lmi|talk]]) 15:40, 27 August 2026 (CEST) [[Support:Firmware V15r1 product/15r1/firmware 1510781 (sr16) available | Version 15r1 Service Release 16]] is now available from the [http://store.innovaphone.com/release/download.htm download page].

[[User:Lmi|Lmi]] ([[User talk:Lmi|talk]]) 15:40, 27 August 2026 (CEST) [[Support:Firmware V14r2 product/14r2/firmware 1420601 (sr24) available | Version 14r2 Service Release 24]] is now available from the [http://store.innovaphone.com/release/download.htm download page].

[[User:Aer|Aer]] ([[User talk:Aer|talk]]) 17:16, 25 March 2026 (CET) [[Support:Firmware V13r3 product/13r3/firmware 138046 (sr 36) available | Version 13r3 Service Release 36]] is now available from the [http://store.innovaphone.com/release/download.htm download page].

[[User:Tfu|Tfu]] 10:48, 24 February 2026 (CET)
[[Support:WinPDM Software 3130114 (4.2.1) released| WinPDM Software 3130113 (4.2.1)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Tfu|Tfu]] ([[User talk:Tfu&action=edit&redlink=1|talk]]) 15:28, 13 March 2025 (CEST)
[[Support:Wireless Handset Firmware IP73 1012 (6.1.13) released| Wireless Handset Firmware IP73 1012 (6.1.13) released]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Msu|Msu]] ([[User talk:Msu&action=edit&redlink=1|talk]]) 15:54, 18 February 2025 (CEST)
[[Support:Wireless Handset Firmware IP64 10317 (4.3.2)/IP65 10122 (4.3.2) released| Wireless Handset Firmware IP64 10317 (4.3.2)/IP65 10122 (4.3.2)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Msu|Msu]] ([[User talk:Msu&action=edit&redlink=1|talk]]) 15:54, 18 February 2025 (CEST)
[[Support:Wireless Handset Firmware D83 10002 (2.0.5) released| Wireless Handset Firmware D83 10002 (2.0.5)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 15:38, 6 February 2023 (CET)
[[Support:Wireless Handset Firmware IP62 3040621 (6.2.7) released| Wireless Handset Firmware IP62 3040621 (6.2.7)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 12:46, 16 June 2021 (CEST))
[[Support:TAPI Service Provider 8188 (hotfix21) available|TAPI Service Provider 8188 (hotfix21)]] is now available from [https://store.innovaphone.com/release/download.htm the Software download area].

[[User:Afi|Afi]] 18:21, 12 October 2020 (CEST)
[[Support:Wireless Handset Firmware IP61 3022811 (4.7.8)/IP63 3022912 (4.7.8) released| Wireless Handset Firmware IP61 3022811 (4.7.8)/IP63 3022912 (4.7.8)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 21:30, 27 March 2020 (CET)
[[Support:Wireless Handset Firmware and Management Software product/9.00/wireless 100037 (hotfix19) available| Wireless Package hotfix 19]] is now available from the [http://download.innovaphone.com/ice/9.00#wireless V9 download area].

<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em;">

== New Articles ==

{{Special:Newestpages/all/20}}
</div>

<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em; font-size:1">
== More innovaphone Ressources ==
* [http://www.innovaphone.com Home Page]
* [http://download.innovaphone.com Download Site ]
* [http://my.innovaphone.com my.innovaphone ]
* [http://mantis.innovaphone.com/ Ticketing System ]
</div>

Reference16r1:Concept Innovaphone Virtual Appliance (IPVA)

2026-08-24T13:51:53Z

Slu: /* Applies To */

==Applies To==
This information applies to:
*V16r1
*innovaphone Virtual Appliance
*Intel/AMD CPUs
* Virtualization platforms
**VMware
*** Workstation
*** Player
*** vSphere 4 - 8
*** ESXi 6 - 8
**Microsoft Hyper-V ([[{{NAMESPACE}}:Concept IPVA On Hyper-V|Concept IPVA On Hyper-V]])
*** Windows 8.1
*** Windows 10
*** Windows Server 2012 R2
*** Windows Server 2016 CTP4
**Linux based Hypervisors with [https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine KVM] and [https://en.wikipedia.org/wiki/QEMU QEMU] support
*** Proxmox VE 8.0 / 8.1 / 9.1 / 9.2

''Disclaimer: Manufacturers/versions of VM platforms other than those specified here have not been tested, so use at your own risk.''

''Disclaimer 2: We occasionally encounter customers experiencing unusual issues related to OpenStack. OpenStack is not officially supported, and such issues are not analyzed.''

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.

The IPVA is a software-only solution. It appears and behaves like an innovaphone "hard-box" without physical resources such as hardware DSP or ISDN interface.

==Package Overview==
We supply an OVF ('''O'''pen '''V'''irtualization '''F'''ormat) import or - depending on the virtualization platform - a suitable variant.
OVF is an open standard that contains several files in one package. The .ovf file is therefore an archive that contains all the necessary files.

=== Sample VMware ===
;ipva-ovf.zip:
The compressed archive ''ipva-ovf.zip'' contains the file ipva.ova. A deployment of ipva.ova will result in a set of 5 files - the file names may differ from the following list:
*ipva.vmx: The virtual machine configuration file
*hd-boot.vmdk: The virtual boot disk on IDE 0:0
*hd-cf.vmdk: The disk for emulation of a Compact Flash card on IDE 0:1
*hd-flash.vmdk: The disk for emulation of flash memory on IDE 1:0
*hd-dump.vmdk: The disk serving as a store for a crash dump on IDE 1:1

;ipva.bin:
The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

== Virtualization platforms ==

===VMware Player / VMware Workstation===
==== Import new Machine ====
*Copy the file ipva.ova to e.g. your desktop and Double-click on ipva.ova.
*Edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

===VMware vSphere===
==== Import new Machine ====
*Import ipva.ova by means of '''File/Deploy OVF-Template...''' (de: '''Datei/OFV-Vorlage bereitstellen...''') and follow instructions.
*Edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

===Microsoft Hyper-V===
==== Import new Machine ====
* Use the UI Wizard to Import a new machine
* Browse to the directory where the downloaded package was extracted to. Browse to the subdirectory Virtual Machines and click Ok
* Select ''Copy the Virtual Machine'' as ''Import Type''

===Proxmox VE===
==== Settings ====
Here, we list the VM settings that allowed us to successfully test the system and that ensure VMs run stably in production. These settings should be considered best practices.

===== PVE Version =====
* Version: 9.2.4
* Repositories: Enterprise repositories

===== Hardware =====
* Processors: 1 socket, 1 core, Type "Host" preferred, fallback "x86-64-v2-AES"
* Bios: SeaBIOS
* Machine: i440fx
* SCSI Controller: VirtIO SCSI single
* Hard Disks
** Datastore: Ceph (19.2.3) or local LVM
** Cache: No Cache
** Discard: Enable
** SSD emulation: Yes
** Async IO: io_uring
* Network Devices
** Model: VirtIO (paravirtualized)

===== Options =====
* OS Type: Other
* Boot Order: ide0, ide1, ide2, ide3
* QEMU Gust Agent: Disabled

==== Import new Machine ====
Import the "ova" file to your storage which is enabled for the type "import". After that you can select the created template an create new machines from it with the button "Import"

* Before you start up the VM in the UI you have to adjust the following configuration options:
** Hardware -> Processors: Adjust "Extra Cpu Flags" -> "aes" if required
** Hardware -> SCSI Controller: Change Model to "VirtIO SCSI Single"
** Hardware -> Network Device (net0 / net1): Change Model to "VirtIO (paravirtualized)"

==Configuration==

===Network Configuration===
The IPVA is preconfigured a DHCP client. You will see the current IP-Address in the console-screen of the VM. If there's in no case a DHCP server available for the 1st-time configuration, you can set your IP-Configuration in the console.

config change IP0 ETH0 /addr 192.168.0.10 /mask 255.255.255.0
config change IP0 RT0 /gateway 192.168.0.1
config change DHCP0 /mode off
config write
reset

====MAC/serial number====
Take care that you use a MAC address which is supported by my.innovaphone, see [[Reference:My_Innovaphone#IPVA_MAC_exists]].

===AES Hardware Acceleration===
It may be beneficial to activate hardware acceleration for AES operations.
Whether hardware acceleration is activated can be checked with the command <code>!mod cmd CPU cpu-info</code>.

* The "flags" attribute must contain "aesni"
* The "act-features" attribute must contain "has_aesni"

Example:
<info>
<cpu
vendor="GenuineIntel"
signature="0x906e9"
brand="Intel(R) Core(TM) i5-7400 CPU @ 3.00GHz"
...
flags="sse3 pclmulqdq ssse3 sse4_1 sse4_2 aesni xsave xsaveopt osxsave avx f16c rdrand fpu mmx fxsr sse sse2 avx2"
act-features="has_aesni has_avx has_vaesni has_vpclmulqdq" srtp-mips="5"/>
</info>

==Large IPVA with 512 MiB Flash==
In some scenarios the standard 64 MiB flash memory is not enough to store all user data. It is possible to manually enlarge the flash memory of an IPVA up to 512 MiB.

You have to change the settings of the virtual machine and format the flash. You cannot do it with an already configured machine, because you will lose all your configuration!

# shutdown the IPVA
# increase the RAM to 3.072 MiB
# increase the size of '''IDE1:0''' to 512 MiB or recreate it
# power up the IPVA
# format the flash: <code>!mod cmd FLASHMAN0 reset all</code>
# reboot the IPVA: <code>!reset</code>

You can check the free space with the command <code>!mod cmd FLASHMAN0 info</code>. You will see a big amount of available segments

segments=675, segment-size=0x10000 (64k)
LDAP - used 1k avail 63k owned 64k (segments 1) maximum 517056k (segments 8079, configured 8079)
VARS - used 23k avail 16k owned 192k (segments 3) maximum 640k (segments 10, configured 10)

But please keep in mind, the more data is saved, the longer it takes to reboot and load the UI in the [[{{NAMESPACE}}:PBX/Objects|PBX/Objects]] area.

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Maintenance/Diagnostics/Tracing/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).

==Known Issues==

=== Maximal 3.072 MiB RAM ===
Because the IPVA has no [https://en.wikipedia.org/wiki/Virtual_memory virtual memory management], it will use only the first linear 3 GiB of RAM. But please keep in mind, that the flash content will be stored 3-times (Flashmanager, Flashdirectory, PBX) in RAM at startup.
=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How To Replace The Boot Disk On vSphere.3F| How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

Some Customer who are running Fw v12r1 (up to sr6) with ESXi 6.0 and VEEAM 9 reported that after a backup with VEEAM 9, the restored IPVA was not starting.
At this point, there is no possibility to solve this problem. The only workaround in that case is to delete the machine, reinstall a new one, and restore a configuration saved before.

If you did not run into the problem yet, for prevention, we recommend to replace the Boot disk of your working IPVA.vmx with one of the IPVA.ova. Please follow the steps below (be aware that this will upgrade the firmware on the IPVA to 12r2, due to the fact that actually, IPVA.ova is only available from version 12r2):

1. Remove the Boot disk of the virtual machine (vmx)(is normaly the first one). 
* Power off the VM
* Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Remove''.
* Click ''OK'' to save your changes.

2. Add the Boot disk of the ova virtual machine to the vmx one.
* Identify the size of the boot disk of the ova virtual machine (will be needed on the step when navigating to boot disk)
* On the powered off VM, Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Add''.
* Select Use “an existing virtual disk” then click ''Next''.
* Navigate to the boot disk of the ova Virtual machine then click ''next''.
* Click ''Finish''.
Now the vmx virtual machine should have the Fw version 12r2.

The .ova version will be available also in V12r1 sr7

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

=== IPVA on ESX 6.5 ===
We have reports that the IPVA does not run properly on ESX 6.5. The IPVA boots up properly but the clock does not run. Running the .ova based variation available in v12r2 fixed the issue or edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

=== Administration: Avoid 'reboot' Command. Use 'reset' Command ===
Alwas use the 'reset' command to restart an IPVA.
The 'reboot' command makes sense only on physical applicances, where its purpose is to deploy a new bootcode by means of a forced watchdog trap. The resulting post-reboot state will be as if an unsolicited trap/crash had occurred.

=== Voice Quality Issues ===
When dealing with media streams (e.g. for announcements), the IPVA needs to fulfil real-time processing requirements, for example to process RTP packets in a timely fashion. To do so, the IPVA relies on the capabilities of the virtualization platform it runs on.

It is therefore important to configure the platform so that it supports real-time applications best. If you experience voice quality or latency issues, consider
* to make sure that all of the IPVAs memory is ''reserved'' to the IPVA (''Latency Sensitivity'' set to ''High'')
* to guarantee exclusive PCPU access
This helps to reduce CPU halt/wake-up states.

===Additional vCPUs may cause problems===
The Multi-Core functionality of version 13r2 is a beta functionality. Additional virtual CPUs(vCPUs) should not be utilized in production environments.

==FAQ==
===Can The emulated compact-flash disk size be increased?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated compact-flash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given. Please note: The compact-flash disk is not the flash which store LDAP and VARS.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)
===What Is the minimum size of the emulated flash storage?===
The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is defaulted to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)

{{Limit_Virtual_IPVA_Flash}}

===How much RAM is required per IPVA instance?===
Since 12r2sr27/13r1sr5 the downloadable virtual appliance comes preconfigured with 256 MiB RAM. This amount is seen as a good trade-off for the majority of all installations. The IPVA need the amount of used flash 3-times at startup. The RAM-size can be administrated by VMware-means.

===What is the maximum amount of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why does ''General/Info/DRAM'' show less than the configured memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===What about Open VM Tools / VMware Tools?===
Tools like this are not supported / integrated because it is not needed. The Virtual Appliance provides his own operating system, and we don't need any of the VM-Tools features in our guest.

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|ipva-crc-wrong.jpg/|/Ipva-crc-wrong.jpg]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|ipva-nic-unavailable.jpg/|/Ipva-nic-unavailable.jpg]]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|screenshot-ipva-perfcounter-nok.jpg/|/Screenshot-ipva-perfcounter-nok.jpg]]

'''Solution''' 
This problem is likely caused by an OVA-import of the IPVA. The appliance's configuration file ''ipva.vmx'' requires a VMware proprietary configuration line that's not specifiable within an OVA-file.

The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

'''Remarks'''
*The vmx file should be edited after the installation of the IPVA.
*The vmx file should NOT be edited with Text editor (use vSphere as shown above)
*To our knowledge, a converter is always necessary for the installation with vmx.

===What Can I Do In Case Of Boot-Problem: ''Loading failed for image=IPVA BIN''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
Loading failed for image=IPVA BIN
</pre>
[[Image:Ipva-fw-load-failed.png|center|thumb|200px|ipva-fw-load-failed.png/|/Ipva-fw-load-failed.png]]

'''Solution''' 
This problem is likely caused by a calculation fault within the boot-code.
*The solution requires a replacement of the boot disk hd-boot.vmdk.
**Download an IPVA package from on 11r2 sr22.
**Replace the 1st disk with the one from the downloaded package

===Are Additional vCPUs useful?===
The Multi-Core functionality is an experimental functionality. Additional virtual CPUs(vCPUs) should not be utilized in production environments.

==Notes==
<references/>

==Related Articles==
* [[{{NAMESPACE}}:Licenses|Reference15r1:Licenses]]
* [[Howto15r1:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance]]
* [[Howto:A_rough_estimate_of_IPVA_Performance]]

[[Category:Concept15r1|{{PAGENAME}}]]

Reference16r1:Concept Innovaphone Virtual Appliance (IPVA)

2026-08-24T13:51:28Z

Slu: /* Settings */

==Applies To==
This information applies to:
*V16r1
*innovaphone Virtual Appliance
*Intel/AMD CPUs
* Virtualization platforms
**VMware
*** Workstation
*** Player
*** vSphere 4 - 8
*** ESXi 6 - 8
**Microsoft Hyper-V ([[{{NAMESPACE}}:Concept IPVA On Hyper-V|Concept IPVA On Hyper-V]])
*** Windows 8.1
*** Windows 10
*** Windows Server 2012 R2
*** Windows Server 2016 CTP4
**Linux based Hypervisors with [https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine KVM] and [https://en.wikipedia.org/wiki/QEMU QEMU] support
*** Proxmox VE 8.0 / 8.1 / 9.1

''Disclaimer: Manufacturers/versions of VM platforms other than those specified here have not been tested, so use at your own risk.''

''Disclaimer 2: We occasionally encounter customers experiencing unusual issues related to OpenStack. OpenStack is not officially supported, and such issues are not analyzed.''

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.

The IPVA is a software-only solution. It appears and behaves like an innovaphone "hard-box" without physical resources such as hardware DSP or ISDN interface.

==Package Overview==
We supply an OVF ('''O'''pen '''V'''irtualization '''F'''ormat) import or - depending on the virtualization platform - a suitable variant.
OVF is an open standard that contains several files in one package. The .ovf file is therefore an archive that contains all the necessary files.

=== Sample VMware ===
;ipva-ovf.zip:
The compressed archive ''ipva-ovf.zip'' contains the file ipva.ova. A deployment of ipva.ova will result in a set of 5 files - the file names may differ from the following list:
*ipva.vmx: The virtual machine configuration file
*hd-boot.vmdk: The virtual boot disk on IDE 0:0
*hd-cf.vmdk: The disk for emulation of a Compact Flash card on IDE 0:1
*hd-flash.vmdk: The disk for emulation of flash memory on IDE 1:0
*hd-dump.vmdk: The disk serving as a store for a crash dump on IDE 1:1

;ipva.bin:
The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

== Virtualization platforms ==

===VMware Player / VMware Workstation===
==== Import new Machine ====
*Copy the file ipva.ova to e.g. your desktop and Double-click on ipva.ova.
*Edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

===VMware vSphere===
==== Import new Machine ====
*Import ipva.ova by means of '''File/Deploy OVF-Template...''' (de: '''Datei/OFV-Vorlage bereitstellen...''') and follow instructions.
*Edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

===Microsoft Hyper-V===
==== Import new Machine ====
* Use the UI Wizard to Import a new machine
* Browse to the directory where the downloaded package was extracted to. Browse to the subdirectory Virtual Machines and click Ok
* Select ''Copy the Virtual Machine'' as ''Import Type''

===Proxmox VE===
==== Settings ====
Here, we list the VM settings that allowed us to successfully test the system and that ensure VMs run stably in production. These settings should be considered best practices.

===== PVE Version =====
* Version: 9.2.4
* Repositories: Enterprise repositories

===== Hardware =====
* Processors: 1 socket, 1 core, Type "Host" preferred, fallback "x86-64-v2-AES"
* Bios: SeaBIOS
* Machine: i440fx
* SCSI Controller: VirtIO SCSI single
* Hard Disks
** Datastore: Ceph (19.2.3) or local LVM
** Cache: No Cache
** Discard: Enable
** SSD emulation: Yes
** Async IO: io_uring
* Network Devices
** Model: VirtIO (paravirtualized)

===== Options =====
* OS Type: Other
* Boot Order: ide0, ide1, ide2, ide3
* QEMU Gust Agent: Disabled

==== Import new Machine ====
Import the "ova" file to your storage which is enabled for the type "import". After that you can select the created template an create new machines from it with the button "Import"

* Before you start up the VM in the UI you have to adjust the following configuration options:
** Hardware -> Processors: Adjust "Extra Cpu Flags" -> "aes" if required
** Hardware -> SCSI Controller: Change Model to "VirtIO SCSI Single"
** Hardware -> Network Device (net0 / net1): Change Model to "VirtIO (paravirtualized)"

==Configuration==

===Network Configuration===
The IPVA is preconfigured a DHCP client. You will see the current IP-Address in the console-screen of the VM. If there's in no case a DHCP server available for the 1st-time configuration, you can set your IP-Configuration in the console.

config change IP0 ETH0 /addr 192.168.0.10 /mask 255.255.255.0
config change IP0 RT0 /gateway 192.168.0.1
config change DHCP0 /mode off
config write
reset

====MAC/serial number====
Take care that you use a MAC address which is supported by my.innovaphone, see [[Reference:My_Innovaphone#IPVA_MAC_exists]].

===AES Hardware Acceleration===
It may be beneficial to activate hardware acceleration for AES operations.
Whether hardware acceleration is activated can be checked with the command <code>!mod cmd CPU cpu-info</code>.

* The "flags" attribute must contain "aesni"
* The "act-features" attribute must contain "has_aesni"

Example:
<info>
<cpu
vendor="GenuineIntel"
signature="0x906e9"
brand="Intel(R) Core(TM) i5-7400 CPU @ 3.00GHz"
...
flags="sse3 pclmulqdq ssse3 sse4_1 sse4_2 aesni xsave xsaveopt osxsave avx f16c rdrand fpu mmx fxsr sse sse2 avx2"
act-features="has_aesni has_avx has_vaesni has_vpclmulqdq" srtp-mips="5"/>
</info>

==Large IPVA with 512 MiB Flash==
In some scenarios the standard 64 MiB flash memory is not enough to store all user data. It is possible to manually enlarge the flash memory of an IPVA up to 512 MiB.

You have to change the settings of the virtual machine and format the flash. You cannot do it with an already configured machine, because you will lose all your configuration!

# shutdown the IPVA
# increase the RAM to 3.072 MiB
# increase the size of '''IDE1:0''' to 512 MiB or recreate it
# power up the IPVA
# format the flash: <code>!mod cmd FLASHMAN0 reset all</code>
# reboot the IPVA: <code>!reset</code>

You can check the free space with the command <code>!mod cmd FLASHMAN0 info</code>. You will see a big amount of available segments

segments=675, segment-size=0x10000 (64k)
LDAP - used 1k avail 63k owned 64k (segments 1) maximum 517056k (segments 8079, configured 8079)
VARS - used 23k avail 16k owned 192k (segments 3) maximum 640k (segments 10, configured 10)

But please keep in mind, the more data is saved, the longer it takes to reboot and load the UI in the [[{{NAMESPACE}}:PBX/Objects|PBX/Objects]] area.

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Maintenance/Diagnostics/Tracing/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).

==Known Issues==

=== Maximal 3.072 MiB RAM ===
Because the IPVA has no [https://en.wikipedia.org/wiki/Virtual_memory virtual memory management], it will use only the first linear 3 GiB of RAM. But please keep in mind, that the flash content will be stored 3-times (Flashmanager, Flashdirectory, PBX) in RAM at startup.
=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How To Replace The Boot Disk On vSphere.3F| How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

Some Customer who are running Fw v12r1 (up to sr6) with ESXi 6.0 and VEEAM 9 reported that after a backup with VEEAM 9, the restored IPVA was not starting.
At this point, there is no possibility to solve this problem. The only workaround in that case is to delete the machine, reinstall a new one, and restore a configuration saved before.

If you did not run into the problem yet, for prevention, we recommend to replace the Boot disk of your working IPVA.vmx with one of the IPVA.ova. Please follow the steps below (be aware that this will upgrade the firmware on the IPVA to 12r2, due to the fact that actually, IPVA.ova is only available from version 12r2):

1. Remove the Boot disk of the virtual machine (vmx)(is normaly the first one). 
* Power off the VM
* Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Remove''.
* Click ''OK'' to save your changes.

2. Add the Boot disk of the ova virtual machine to the vmx one.
* Identify the size of the boot disk of the ova virtual machine (will be needed on the step when navigating to boot disk)
* On the powered off VM, Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Add''.
* Select Use “an existing virtual disk” then click ''Next''.
* Navigate to the boot disk of the ova Virtual machine then click ''next''.
* Click ''Finish''.
Now the vmx virtual machine should have the Fw version 12r2.

The .ova version will be available also in V12r1 sr7

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

=== IPVA on ESX 6.5 ===
We have reports that the IPVA does not run properly on ESX 6.5. The IPVA boots up properly but the clock does not run. Running the .ova based variation available in v12r2 fixed the issue or edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

=== Administration: Avoid 'reboot' Command. Use 'reset' Command ===
Alwas use the 'reset' command to restart an IPVA.
The 'reboot' command makes sense only on physical applicances, where its purpose is to deploy a new bootcode by means of a forced watchdog trap. The resulting post-reboot state will be as if an unsolicited trap/crash had occurred.

=== Voice Quality Issues ===
When dealing with media streams (e.g. for announcements), the IPVA needs to fulfil real-time processing requirements, for example to process RTP packets in a timely fashion. To do so, the IPVA relies on the capabilities of the virtualization platform it runs on.

It is therefore important to configure the platform so that it supports real-time applications best. If you experience voice quality or latency issues, consider
* to make sure that all of the IPVAs memory is ''reserved'' to the IPVA (''Latency Sensitivity'' set to ''High'')
* to guarantee exclusive PCPU access
This helps to reduce CPU halt/wake-up states.

===Additional vCPUs may cause problems===
The Multi-Core functionality of version 13r2 is a beta functionality. Additional virtual CPUs(vCPUs) should not be utilized in production environments.

==FAQ==
===Can The emulated compact-flash disk size be increased?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated compact-flash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given. Please note: The compact-flash disk is not the flash which store LDAP and VARS.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)
===What Is the minimum size of the emulated flash storage?===
The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is defaulted to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)

{{Limit_Virtual_IPVA_Flash}}

===How much RAM is required per IPVA instance?===
Since 12r2sr27/13r1sr5 the downloadable virtual appliance comes preconfigured with 256 MiB RAM. This amount is seen as a good trade-off for the majority of all installations. The IPVA need the amount of used flash 3-times at startup. The RAM-size can be administrated by VMware-means.

===What is the maximum amount of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why does ''General/Info/DRAM'' show less than the configured memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===What about Open VM Tools / VMware Tools?===
Tools like this are not supported / integrated because it is not needed. The Virtual Appliance provides his own operating system, and we don't need any of the VM-Tools features in our guest.

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|ipva-crc-wrong.jpg/|/Ipva-crc-wrong.jpg]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|ipva-nic-unavailable.jpg/|/Ipva-nic-unavailable.jpg]]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|screenshot-ipva-perfcounter-nok.jpg/|/Screenshot-ipva-perfcounter-nok.jpg]]

'''Solution''' 
This problem is likely caused by an OVA-import of the IPVA. The appliance's configuration file ''ipva.vmx'' requires a VMware proprietary configuration line that's not specifiable within an OVA-file.

The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

'''Remarks'''
*The vmx file should be edited after the installation of the IPVA.
*The vmx file should NOT be edited with Text editor (use vSphere as shown above)
*To our knowledge, a converter is always necessary for the installation with vmx.

===What Can I Do In Case Of Boot-Problem: ''Loading failed for image=IPVA BIN''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
Loading failed for image=IPVA BIN
</pre>
[[Image:Ipva-fw-load-failed.png|center|thumb|200px|ipva-fw-load-failed.png/|/Ipva-fw-load-failed.png]]

'''Solution''' 
This problem is likely caused by a calculation fault within the boot-code.
*The solution requires a replacement of the boot disk hd-boot.vmdk.
**Download an IPVA package from on 11r2 sr22.
**Replace the 1st disk with the one from the downloaded package

===Are Additional vCPUs useful?===
The Multi-Core functionality is an experimental functionality. Additional virtual CPUs(vCPUs) should not be utilized in production environments.

==Notes==
<references/>

==Related Articles==
* [[{{NAMESPACE}}:Licenses|Reference15r1:Licenses]]
* [[Howto15r1:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance]]
* [[Howto:A_rough_estimate_of_IPVA_Performance]]

[[Category:Concept15r1|{{PAGENAME}}]]

Reference16r1:Concept Innovaphone Virtual Appliance (IPVA)

2026-08-24T13:47:34Z

Slu: /* Settings */

==Applies To==
This information applies to:
*V16r1
*innovaphone Virtual Appliance
*Intel/AMD CPUs
* Virtualization platforms
**VMware
*** Workstation
*** Player
*** vSphere 4 - 8
*** ESXi 6 - 8
**Microsoft Hyper-V ([[{{NAMESPACE}}:Concept IPVA On Hyper-V|Concept IPVA On Hyper-V]])
*** Windows 8.1
*** Windows 10
*** Windows Server 2012 R2
*** Windows Server 2016 CTP4
**Linux based Hypervisors with [https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine KVM] and [https://en.wikipedia.org/wiki/QEMU QEMU] support
*** Proxmox VE 8.0 / 8.1 / 9.1

''Disclaimer: Manufacturers/versions of VM platforms other than those specified here have not been tested, so use at your own risk.''

''Disclaimer 2: We occasionally encounter customers experiencing unusual issues related to OpenStack. OpenStack is not officially supported, and such issues are not analyzed.''

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.

The IPVA is a software-only solution. It appears and behaves like an innovaphone "hard-box" without physical resources such as hardware DSP or ISDN interface.

==Package Overview==
We supply an OVF ('''O'''pen '''V'''irtualization '''F'''ormat) import or - depending on the virtualization platform - a suitable variant.
OVF is an open standard that contains several files in one package. The .ovf file is therefore an archive that contains all the necessary files.

=== Sample VMware ===
;ipva-ovf.zip:
The compressed archive ''ipva-ovf.zip'' contains the file ipva.ova. A deployment of ipva.ova will result in a set of 5 files - the file names may differ from the following list:
*ipva.vmx: The virtual machine configuration file
*hd-boot.vmdk: The virtual boot disk on IDE 0:0
*hd-cf.vmdk: The disk for emulation of a Compact Flash card on IDE 0:1
*hd-flash.vmdk: The disk for emulation of flash memory on IDE 1:0
*hd-dump.vmdk: The disk serving as a store for a crash dump on IDE 1:1

;ipva.bin:
The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

== Virtualization platforms ==

===VMware Player / VMware Workstation===
==== Import new Machine ====
*Copy the file ipva.ova to e.g. your desktop and Double-click on ipva.ova.
*Edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

===VMware vSphere===
==== Import new Machine ====
*Import ipva.ova by means of '''File/Deploy OVF-Template...''' (de: '''Datei/OFV-Vorlage bereitstellen...''') and follow instructions.
*Edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

===Microsoft Hyper-V===
==== Import new Machine ====
* Use the UI Wizard to Import a new machine
* Browse to the directory where the downloaded package was extracted to. Browse to the subdirectory Virtual Machines and click Ok
* Select ''Copy the Virtual Machine'' as ''Import Type''

===Proxmox VE===
==== Settings ====
Here, we list the VM settings that allowed us to successfully test the system and that ensure VMs run stably in production. These settings should be considered best practices.

===== Hardware =====
* Processors: 1 socket, 1 core, Type "Host" preferred, fallback "x86-64-v2-AES"
* Bios: SeaBIOS
* Machine: i440fx
* SCSI Controller: VirtIO SCSI single
* Hard Disks
** Datastore: Ceph (19.2.3) or local LVM
** Cache: No Cache
** Discard: Enable
** SSD emulation: Yes
** Async IO: io_uring
* Network Devices
** Model: VirtIO (paravirtualized)

===== Options =====
* OS Type: Other
* Boot Order: ide0, ide1, ide2, ide3
* QEMU Gust Agent: Disabled

==== Import new Machine ====
Import the "ova" file to your storage which is enabled for the type "import". After that you can select the created template an create new machines from it with the button "Import"

* Before you start up the VM in the UI you have to adjust the following configuration options:
** Hardware -> Processors: Adjust "Extra Cpu Flags" -> "aes" if required
** Hardware -> SCSI Controller: Change Model to "VirtIO SCSI Single"
** Hardware -> Network Device (net0 / net1): Change Model to "VirtIO (paravirtualized)"

==Configuration==

===Network Configuration===
The IPVA is preconfigured a DHCP client. You will see the current IP-Address in the console-screen of the VM. If there's in no case a DHCP server available for the 1st-time configuration, you can set your IP-Configuration in the console.

config change IP0 ETH0 /addr 192.168.0.10 /mask 255.255.255.0
config change IP0 RT0 /gateway 192.168.0.1
config change DHCP0 /mode off
config write
reset

====MAC/serial number====
Take care that you use a MAC address which is supported by my.innovaphone, see [[Reference:My_Innovaphone#IPVA_MAC_exists]].

===AES Hardware Acceleration===
It may be beneficial to activate hardware acceleration for AES operations.
Whether hardware acceleration is activated can be checked with the command <code>!mod cmd CPU cpu-info</code>.

* The "flags" attribute must contain "aesni"
* The "act-features" attribute must contain "has_aesni"

Example:
<info>
<cpu
vendor="GenuineIntel"
signature="0x906e9"
brand="Intel(R) Core(TM) i5-7400 CPU @ 3.00GHz"
...
flags="sse3 pclmulqdq ssse3 sse4_1 sse4_2 aesni xsave xsaveopt osxsave avx f16c rdrand fpu mmx fxsr sse sse2 avx2"
act-features="has_aesni has_avx has_vaesni has_vpclmulqdq" srtp-mips="5"/>
</info>

==Large IPVA with 512 MiB Flash==
In some scenarios the standard 64 MiB flash memory is not enough to store all user data. It is possible to manually enlarge the flash memory of an IPVA up to 512 MiB.

You have to change the settings of the virtual machine and format the flash. You cannot do it with an already configured machine, because you will lose all your configuration!

# shutdown the IPVA
# increase the RAM to 3.072 MiB
# increase the size of '''IDE1:0''' to 512 MiB or recreate it
# power up the IPVA
# format the flash: <code>!mod cmd FLASHMAN0 reset all</code>
# reboot the IPVA: <code>!reset</code>

You can check the free space with the command <code>!mod cmd FLASHMAN0 info</code>. You will see a big amount of available segments

segments=675, segment-size=0x10000 (64k)
LDAP - used 1k avail 63k owned 64k (segments 1) maximum 517056k (segments 8079, configured 8079)
VARS - used 23k avail 16k owned 192k (segments 3) maximum 640k (segments 10, configured 10)

But please keep in mind, the more data is saved, the longer it takes to reboot and load the UI in the [[{{NAMESPACE}}:PBX/Objects|PBX/Objects]] area.

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Maintenance/Diagnostics/Tracing/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).

==Known Issues==

=== Maximal 3.072 MiB RAM ===
Because the IPVA has no [https://en.wikipedia.org/wiki/Virtual_memory virtual memory management], it will use only the first linear 3 GiB of RAM. But please keep in mind, that the flash content will be stored 3-times (Flashmanager, Flashdirectory, PBX) in RAM at startup.
=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How To Replace The Boot Disk On vSphere.3F| How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

Some Customer who are running Fw v12r1 (up to sr6) with ESXi 6.0 and VEEAM 9 reported that after a backup with VEEAM 9, the restored IPVA was not starting.
At this point, there is no possibility to solve this problem. The only workaround in that case is to delete the machine, reinstall a new one, and restore a configuration saved before.

If you did not run into the problem yet, for prevention, we recommend to replace the Boot disk of your working IPVA.vmx with one of the IPVA.ova. Please follow the steps below (be aware that this will upgrade the firmware on the IPVA to 12r2, due to the fact that actually, IPVA.ova is only available from version 12r2):

1. Remove the Boot disk of the virtual machine (vmx)(is normaly the first one). 
* Power off the VM
* Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Remove''.
* Click ''OK'' to save your changes.

2. Add the Boot disk of the ova virtual machine to the vmx one.
* Identify the size of the boot disk of the ova virtual machine (will be needed on the step when navigating to boot disk)
* On the powered off VM, Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Add''.
* Select Use “an existing virtual disk” then click ''Next''.
* Navigate to the boot disk of the ova Virtual machine then click ''next''.
* Click ''Finish''.
Now the vmx virtual machine should have the Fw version 12r2.

The .ova version will be available also in V12r1 sr7

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

=== IPVA on ESX 6.5 ===
We have reports that the IPVA does not run properly on ESX 6.5. The IPVA boots up properly but the clock does not run. Running the .ova based variation available in v12r2 fixed the issue or edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

=== Administration: Avoid 'reboot' Command. Use 'reset' Command ===
Alwas use the 'reset' command to restart an IPVA.
The 'reboot' command makes sense only on physical applicances, where its purpose is to deploy a new bootcode by means of a forced watchdog trap. The resulting post-reboot state will be as if an unsolicited trap/crash had occurred.

=== Voice Quality Issues ===
When dealing with media streams (e.g. for announcements), the IPVA needs to fulfil real-time processing requirements, for example to process RTP packets in a timely fashion. To do so, the IPVA relies on the capabilities of the virtualization platform it runs on.

It is therefore important to configure the platform so that it supports real-time applications best. If you experience voice quality or latency issues, consider
* to make sure that all of the IPVAs memory is ''reserved'' to the IPVA (''Latency Sensitivity'' set to ''High'')
* to guarantee exclusive PCPU access
This helps to reduce CPU halt/wake-up states.

===Additional vCPUs may cause problems===
The Multi-Core functionality of version 13r2 is a beta functionality. Additional virtual CPUs(vCPUs) should not be utilized in production environments.

==FAQ==
===Can The emulated compact-flash disk size be increased?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated compact-flash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given. Please note: The compact-flash disk is not the flash which store LDAP and VARS.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)
===What Is the minimum size of the emulated flash storage?===
The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is defaulted to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)

{{Limit_Virtual_IPVA_Flash}}

===How much RAM is required per IPVA instance?===
Since 12r2sr27/13r1sr5 the downloadable virtual appliance comes preconfigured with 256 MiB RAM. This amount is seen as a good trade-off for the majority of all installations. The IPVA need the amount of used flash 3-times at startup. The RAM-size can be administrated by VMware-means.

===What is the maximum amount of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why does ''General/Info/DRAM'' show less than the configured memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===What about Open VM Tools / VMware Tools?===
Tools like this are not supported / integrated because it is not needed. The Virtual Appliance provides his own operating system, and we don't need any of the VM-Tools features in our guest.

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|ipva-crc-wrong.jpg/|/Ipva-crc-wrong.jpg]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|ipva-nic-unavailable.jpg/|/Ipva-nic-unavailable.jpg]]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|screenshot-ipva-perfcounter-nok.jpg/|/Screenshot-ipva-perfcounter-nok.jpg]]

'''Solution''' 
This problem is likely caused by an OVA-import of the IPVA. The appliance's configuration file ''ipva.vmx'' requires a VMware proprietary configuration line that's not specifiable within an OVA-file.

The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

'''Remarks'''
*The vmx file should be edited after the installation of the IPVA.
*The vmx file should NOT be edited with Text editor (use vSphere as shown above)
*To our knowledge, a converter is always necessary for the installation with vmx.

===What Can I Do In Case Of Boot-Problem: ''Loading failed for image=IPVA BIN''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
Loading failed for image=IPVA BIN
</pre>
[[Image:Ipva-fw-load-failed.png|center|thumb|200px|ipva-fw-load-failed.png/|/Ipva-fw-load-failed.png]]

'''Solution''' 
This problem is likely caused by a calculation fault within the boot-code.
*The solution requires a replacement of the boot disk hd-boot.vmdk.
**Download an IPVA package from on 11r2 sr22.
**Replace the 1st disk with the one from the downloaded package

===Are Additional vCPUs useful?===
The Multi-Core functionality is an experimental functionality. Additional virtual CPUs(vCPUs) should not be utilized in production environments.

==Notes==
<references/>

==Related Articles==
* [[{{NAMESPACE}}:Licenses|Reference15r1:Licenses]]
* [[Howto15r1:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance]]
* [[Howto:A_rough_estimate_of_IPVA_Performance]]

[[Category:Concept15r1|{{PAGENAME}}]]

Reference16r1:Concept Innovaphone Virtual Appliance (IPVA)

2026-08-24T11:24:48Z

Slu: /* Hardware */

==Applies To==
This information applies to:
*V16r1
*innovaphone Virtual Appliance
*Intel/AMD CPUs
* Virtualization platforms
**VMware
*** Workstation
*** Player
*** vSphere 4 - 8
*** ESXi 6 - 8
**Microsoft Hyper-V ([[{{NAMESPACE}}:Concept IPVA On Hyper-V|Concept IPVA On Hyper-V]])
*** Windows 8.1
*** Windows 10
*** Windows Server 2012 R2
*** Windows Server 2016 CTP4
**Linux based Hypervisors with [https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine KVM] and [https://en.wikipedia.org/wiki/QEMU QEMU] support
*** Proxmox VE 8.0 / 8.1 / 9.1

''Disclaimer: Manufacturers/versions of VM platforms other than those specified here have not been tested, so use at your own risk.''

''Disclaimer 2: We occasionally encounter customers experiencing unusual issues related to OpenStack. OpenStack is not officially supported, and such issues are not analyzed.''

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.

The IPVA is a software-only solution. It appears and behaves like an innovaphone "hard-box" without physical resources such as hardware DSP or ISDN interface.

==Package Overview==
We supply an OVF ('''O'''pen '''V'''irtualization '''F'''ormat) import or - depending on the virtualization platform - a suitable variant.
OVF is an open standard that contains several files in one package. The .ovf file is therefore an archive that contains all the necessary files.

=== Sample VMware ===
;ipva-ovf.zip:
The compressed archive ''ipva-ovf.zip'' contains the file ipva.ova. A deployment of ipva.ova will result in a set of 5 files - the file names may differ from the following list:
*ipva.vmx: The virtual machine configuration file
*hd-boot.vmdk: The virtual boot disk on IDE 0:0
*hd-cf.vmdk: The disk for emulation of a Compact Flash card on IDE 0:1
*hd-flash.vmdk: The disk for emulation of flash memory on IDE 1:0
*hd-dump.vmdk: The disk serving as a store for a crash dump on IDE 1:1

;ipva.bin:
The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

== Virtualization platforms ==

===VMware Player / VMware Workstation===
==== Import new Machine ====
*Copy the file ipva.ova to e.g. your desktop and Double-click on ipva.ova.
*Edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

===VMware vSphere===
==== Import new Machine ====
*Import ipva.ova by means of '''File/Deploy OVF-Template...''' (de: '''Datei/OFV-Vorlage bereitstellen...''') and follow instructions.
*Edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

===Microsoft Hyper-V===
==== Import new Machine ====
* Use the UI Wizard to Import a new machine
* Browse to the directory where the downloaded package was extracted to. Browse to the subdirectory Virtual Machines and click Ok
* Select ''Copy the Virtual Machine'' as ''Import Type''

===Proxmox VE===
==== Settings ====
===== Hardware =====
* Processors: 1 socket, 1 core, Type "Host" preferred, fallback "x86-64-v2-AES"
* Bios: SeaBIOS
* Machine: i440fx
* SCSI Controller: VirtIO SCSI single
* Hard Disks
** Dadstore: Ceph (19.2.3) or local LVM
** Cache: No Cache
** Discard: Enable
** SSD emulation: Yes
** Async IO: io_uring
* Network Devices
** Model: VirtIO (paravirtualized)

===== Options =====
* OS Type: Other
* Boot Order: ide0, ide1, ide2, ide3
* QEMU Gust Agent: Disabled

==== Import new Machine ====
Import the "ova" file to your storage which is enabled for the type "import". After that you can select the created template an create new machines from it with the button "Import"

* Before you start up the VM in the UI you have to adjust the following configuration options:
** Hardware -> Processors: Adjust "Extra Cpu Flags" -> "aes" if required
** Hardware -> SCSI Controller: Change Model to "VirtIO SCSI Single"
** Hardware -> Network Device (net0 / net1): Change Model to "VirtIO (paravirtualized)"

==Configuration==

===Network Configuration===
The IPVA is preconfigured a DHCP client. You will see the current IP-Address in the console-screen of the VM. If there's in no case a DHCP server available for the 1st-time configuration, you can set your IP-Configuration in the console.

config change IP0 ETH0 /addr 192.168.0.10 /mask 255.255.255.0
config change IP0 RT0 /gateway 192.168.0.1
config change DHCP0 /mode off
config write
reset

====MAC/serial number====
Take care that you use a MAC address which is supported by my.innovaphone, see [[Reference:My_Innovaphone#IPVA_MAC_exists]].

===AES Hardware Acceleration===
It may be beneficial to activate hardware acceleration for AES operations.
Whether hardware acceleration is activated can be checked with the command <code>!mod cmd CPU cpu-info</code>.

* The "flags" attribute must contain "aesni"
* The "act-features" attribute must contain "has_aesni"

Example:
<info>
<cpu
vendor="GenuineIntel"
signature="0x906e9"
brand="Intel(R) Core(TM) i5-7400 CPU @ 3.00GHz"
...
flags="sse3 pclmulqdq ssse3 sse4_1 sse4_2 aesni xsave xsaveopt osxsave avx f16c rdrand fpu mmx fxsr sse sse2 avx2"
act-features="has_aesni has_avx has_vaesni has_vpclmulqdq" srtp-mips="5"/>
</info>

==Large IPVA with 512 MiB Flash==
In some scenarios the standard 64 MiB flash memory is not enough to store all user data. It is possible to manually enlarge the flash memory of an IPVA up to 512 MiB.

You have to change the settings of the virtual machine and format the flash. You cannot do it with an already configured machine, because you will lose all your configuration!

# shutdown the IPVA
# increase the RAM to 3.072 MiB
# increase the size of '''IDE1:0''' to 512 MiB or recreate it
# power up the IPVA
# format the flash: <code>!mod cmd FLASHMAN0 reset all</code>
# reboot the IPVA: <code>!reset</code>

You can check the free space with the command <code>!mod cmd FLASHMAN0 info</code>. You will see a big amount of available segments

segments=675, segment-size=0x10000 (64k)
LDAP - used 1k avail 63k owned 64k (segments 1) maximum 517056k (segments 8079, configured 8079)
VARS - used 23k avail 16k owned 192k (segments 3) maximum 640k (segments 10, configured 10)

But please keep in mind, the more data is saved, the longer it takes to reboot and load the UI in the [[{{NAMESPACE}}:PBX/Objects|PBX/Objects]] area.

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Maintenance/Diagnostics/Tracing/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).

==Known Issues==

=== Maximal 3.072 MiB RAM ===
Because the IPVA has no [https://en.wikipedia.org/wiki/Virtual_memory virtual memory management], it will use only the first linear 3 GiB of RAM. But please keep in mind, that the flash content will be stored 3-times (Flashmanager, Flashdirectory, PBX) in RAM at startup.
=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How To Replace The Boot Disk On vSphere.3F| How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

Some Customer who are running Fw v12r1 (up to sr6) with ESXi 6.0 and VEEAM 9 reported that after a backup with VEEAM 9, the restored IPVA was not starting.
At this point, there is no possibility to solve this problem. The only workaround in that case is to delete the machine, reinstall a new one, and restore a configuration saved before.

If you did not run into the problem yet, for prevention, we recommend to replace the Boot disk of your working IPVA.vmx with one of the IPVA.ova. Please follow the steps below (be aware that this will upgrade the firmware on the IPVA to 12r2, due to the fact that actually, IPVA.ova is only available from version 12r2):

1. Remove the Boot disk of the virtual machine (vmx)(is normaly the first one). 
* Power off the VM
* Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Remove''.
* Click ''OK'' to save your changes.

2. Add the Boot disk of the ova virtual machine to the vmx one.
* Identify the size of the boot disk of the ova virtual machine (will be needed on the step when navigating to boot disk)
* On the powered off VM, Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Add''.
* Select Use “an existing virtual disk” then click ''Next''.
* Navigate to the boot disk of the ova Virtual machine then click ''next''.
* Click ''Finish''.
Now the vmx virtual machine should have the Fw version 12r2.

The .ova version will be available also in V12r1 sr7

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

=== IPVA on ESX 6.5 ===
We have reports that the IPVA does not run properly on ESX 6.5. The IPVA boots up properly but the clock does not run. Running the .ova based variation available in v12r2 fixed the issue or edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

=== Administration: Avoid 'reboot' Command. Use 'reset' Command ===
Alwas use the 'reset' command to restart an IPVA.
The 'reboot' command makes sense only on physical applicances, where its purpose is to deploy a new bootcode by means of a forced watchdog trap. The resulting post-reboot state will be as if an unsolicited trap/crash had occurred.

=== Voice Quality Issues ===
When dealing with media streams (e.g. for announcements), the IPVA needs to fulfil real-time processing requirements, for example to process RTP packets in a timely fashion. To do so, the IPVA relies on the capabilities of the virtualization platform it runs on.

It is therefore important to configure the platform so that it supports real-time applications best. If you experience voice quality or latency issues, consider
* to make sure that all of the IPVAs memory is ''reserved'' to the IPVA (''Latency Sensitivity'' set to ''High'')
* to guarantee exclusive PCPU access
This helps to reduce CPU halt/wake-up states.

===Additional vCPUs may cause problems===
The Multi-Core functionality of version 13r2 is a beta functionality. Additional virtual CPUs(vCPUs) should not be utilized in production environments.

==FAQ==
===Can The emulated compact-flash disk size be increased?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated compact-flash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given. Please note: The compact-flash disk is not the flash which store LDAP and VARS.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)
===What Is the minimum size of the emulated flash storage?===
The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is defaulted to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)

{{Limit_Virtual_IPVA_Flash}}

===How much RAM is required per IPVA instance?===
Since 12r2sr27/13r1sr5 the downloadable virtual appliance comes preconfigured with 256 MiB RAM. This amount is seen as a good trade-off for the majority of all installations. The IPVA need the amount of used flash 3-times at startup. The RAM-size can be administrated by VMware-means.

===What is the maximum amount of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why does ''General/Info/DRAM'' show less than the configured memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===What about Open VM Tools / VMware Tools?===
Tools like this are not supported / integrated because it is not needed. The Virtual Appliance provides his own operating system, and we don't need any of the VM-Tools features in our guest.

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|ipva-crc-wrong.jpg/|ipva-crc-wrong.jpg/]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|ipva-nic-unavailable.jpg/|ipva-nic-unavailable.jpg/]]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|screenshot-ipva-perfcounter-nok.jpg/|screenshot-ipva-perfcounter-nok.jpg/]]

'''Solution''' 
This problem is likely caused by an OVA-import of the IPVA. The appliance's configuration file ''ipva.vmx'' requires a VMware proprietary configuration line that's not specifiable within an OVA-file.

The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

'''Remarks'''
*The vmx file should be edited after the installation of the IPVA.
*The vmx file should NOT be edited with Text editor (use vSphere as shown above)
*To our knowledge, a converter is always necessary for the installation with vmx.

===What Can I Do In Case Of Boot-Problem: ''Loading failed for image=IPVA BIN''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
Loading failed for image=IPVA BIN
</pre>
[[Image:Ipva-fw-load-failed.png|center|thumb|200px|ipva-fw-load-failed.png/|ipva-fw-load-failed.png/]]

'''Solution''' 
This problem is likely caused by a calculation fault within the boot-code.
*The solution requires a replacement of the boot disk hd-boot.vmdk.
**Download an IPVA package from on 11r2 sr22.
**Replace the 1st disk with the one from the downloaded package

===Are Additional vCPUs useful?===
The Multi-Core functionality is an experimental functionality. Additional virtual CPUs(vCPUs) should not be utilized in production environments.

==Notes==
<references/>

==Related Articles==
* [[{{NAMESPACE}}:Licenses|Reference15r1:Licenses]]
* [[Howto15r1:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance]]
* [[Howto:A_rough_estimate_of_IPVA_Performance]]

[[Category:Concept15r1|{{PAGENAME}}]]

Reference16r1:Concept Innovaphone Virtual Appliance (IPVA)

2026-08-24T11:14:39Z

Slu: /* Hardware */

==Applies To==
This information applies to:
*V16r1
*innovaphone Virtual Appliance
*Intel/AMD CPUs
* Virtualization platforms
**VMware
*** Workstation
*** Player
*** vSphere 4 - 8
*** ESXi 6 - 8
**Microsoft Hyper-V ([[{{NAMESPACE}}:Concept IPVA On Hyper-V|Concept IPVA On Hyper-V]])
*** Windows 8.1
*** Windows 10
*** Windows Server 2012 R2
*** Windows Server 2016 CTP4
**Linux based Hypervisors with [https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine KVM] and [https://en.wikipedia.org/wiki/QEMU QEMU] support
*** Proxmox VE 8.0 / 8.1 / 9.1

''Disclaimer: Manufacturers/versions of VM platforms other than those specified here have not been tested, so use at your own risk.''

''Disclaimer 2: We occasionally encounter customers experiencing unusual issues related to OpenStack. OpenStack is not officially supported, and such issues are not analyzed.''

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.

The IPVA is a software-only solution. It appears and behaves like an innovaphone "hard-box" without physical resources such as hardware DSP or ISDN interface.

==Package Overview==
We supply an OVF ('''O'''pen '''V'''irtualization '''F'''ormat) import or - depending on the virtualization platform - a suitable variant.
OVF is an open standard that contains several files in one package. The .ovf file is therefore an archive that contains all the necessary files.

=== Sample VMware ===
;ipva-ovf.zip:
The compressed archive ''ipva-ovf.zip'' contains the file ipva.ova. A deployment of ipva.ova will result in a set of 5 files - the file names may differ from the following list:
*ipva.vmx: The virtual machine configuration file
*hd-boot.vmdk: The virtual boot disk on IDE 0:0
*hd-cf.vmdk: The disk for emulation of a Compact Flash card on IDE 0:1
*hd-flash.vmdk: The disk for emulation of flash memory on IDE 1:0
*hd-dump.vmdk: The disk serving as a store for a crash dump on IDE 1:1

;ipva.bin:
The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

== Virtualization platforms ==

===VMware Player / VMware Workstation===
==== Import new Machine ====
*Copy the file ipva.ova to e.g. your desktop and Double-click on ipva.ova.
*Edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

===VMware vSphere===
==== Import new Machine ====
*Import ipva.ova by means of '''File/Deploy OVF-Template...''' (de: '''Datei/OFV-Vorlage bereitstellen...''') and follow instructions.
*Edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

===Microsoft Hyper-V===
==== Import new Machine ====
* Use the UI Wizard to Import a new machine
* Browse to the directory where the downloaded package was extracted to. Browse to the subdirectory Virtual Machines and click Ok
* Select ''Copy the Virtual Machine'' as ''Import Type''

===Proxmox VE===
==== Settings ====
===== Hardware =====
* Processors: 1 socket, 1 core, Type "Host" preferred, fallback "x86-64-v2-AES"
* Bios: SeaBIOS
* Machine: i440fx
* SCSI Controller: VirtIO SCSI single
* Hard Disks
** Cache: No Cache
** Discard: Enable
** SSD emulation: Yes
** Async IO: io_uring
* Network Devices
** Model: VirtIO (paravirtualized)
===== Options =====
* OS Type: Other
* Boot Order: ide0, ide1, ide2, ide3
* QEMU Gust Agent: Disabled

==== Import new Machine ====
Import the "ova" file to your storage which is enabled for the type "import". After that you can select the created template an create new machines from it with the button "Import"

* Before you start up the VM in the UI you have to adjust the following configuration options:
** Hardware -> Processors: Adjust "Extra Cpu Flags" -> "aes" if required
** Hardware -> SCSI Controller: Change Model to "VirtIO SCSI Single"
** Hardware -> Network Device (net0 / net1): Change Model to "VirtIO (paravirtualized)"

==Configuration==

===Network Configuration===
The IPVA is preconfigured a DHCP client. You will see the current IP-Address in the console-screen of the VM. If there's in no case a DHCP server available for the 1st-time configuration, you can set your IP-Configuration in the console.

config change IP0 ETH0 /addr 192.168.0.10 /mask 255.255.255.0
config change IP0 RT0 /gateway 192.168.0.1
config change DHCP0 /mode off
config write
reset

====MAC/serial number====
Take care that you use a MAC address which is supported by my.innovaphone, see [[Reference:My_Innovaphone#IPVA_MAC_exists]].

===AES Hardware Acceleration===
It may be beneficial to activate hardware acceleration for AES operations.
Whether hardware acceleration is activated can be checked with the command <code>!mod cmd CPU cpu-info</code>.

* The "flags" attribute must contain "aesni"
* The "act-features" attribute must contain "has_aesni"

Example:
<info>
<cpu
vendor="GenuineIntel"
signature="0x906e9"
brand="Intel(R) Core(TM) i5-7400 CPU @ 3.00GHz"
...
flags="sse3 pclmulqdq ssse3 sse4_1 sse4_2 aesni xsave xsaveopt osxsave avx f16c rdrand fpu mmx fxsr sse sse2 avx2"
act-features="has_aesni has_avx has_vaesni has_vpclmulqdq" srtp-mips="5"/>
</info>

==Large IPVA with 512 MiB Flash==
In some scenarios the standard 64 MiB flash memory is not enough to store all user data. It is possible to manually enlarge the flash memory of an IPVA up to 512 MiB.

You have to change the settings of the virtual machine and format the flash. You cannot do it with an already configured machine, because you will lose all your configuration!

# shutdown the IPVA
# increase the RAM to 3.072 MiB
# increase the size of '''IDE1:0''' to 512 MiB or recreate it
# power up the IPVA
# format the flash: <code>!mod cmd FLASHMAN0 reset all</code>
# reboot the IPVA: <code>!reset</code>

You can check the free space with the command <code>!mod cmd FLASHMAN0 info</code>. You will see a big amount of available segments

segments=675, segment-size=0x10000 (64k)
LDAP - used 1k avail 63k owned 64k (segments 1) maximum 517056k (segments 8079, configured 8079)
VARS - used 23k avail 16k owned 192k (segments 3) maximum 640k (segments 10, configured 10)

But please keep in mind, the more data is saved, the longer it takes to reboot and load the UI in the [[{{NAMESPACE}}:PBX/Objects|PBX/Objects]] area.

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Maintenance/Diagnostics/Tracing/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).

==Known Issues==

=== Maximal 3.072 MiB RAM ===
Because the IPVA has no [https://en.wikipedia.org/wiki/Virtual_memory virtual memory management], it will use only the first linear 3 GiB of RAM. But please keep in mind, that the flash content will be stored 3-times (Flashmanager, Flashdirectory, PBX) in RAM at startup.
=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How To Replace The Boot Disk On vSphere.3F| How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

Some Customer who are running Fw v12r1 (up to sr6) with ESXi 6.0 and VEEAM 9 reported that after a backup with VEEAM 9, the restored IPVA was not starting.
At this point, there is no possibility to solve this problem. The only workaround in that case is to delete the machine, reinstall a new one, and restore a configuration saved before.

If you did not run into the problem yet, for prevention, we recommend to replace the Boot disk of your working IPVA.vmx with one of the IPVA.ova. Please follow the steps below (be aware that this will upgrade the firmware on the IPVA to 12r2, due to the fact that actually, IPVA.ova is only available from version 12r2):

1. Remove the Boot disk of the virtual machine (vmx)(is normaly the first one). 
* Power off the VM
* Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Remove''.
* Click ''OK'' to save your changes.

2. Add the Boot disk of the ova virtual machine to the vmx one.
* Identify the size of the boot disk of the ova virtual machine (will be needed on the step when navigating to boot disk)
* On the powered off VM, Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Add''.
* Select Use “an existing virtual disk” then click ''Next''.
* Navigate to the boot disk of the ova Virtual machine then click ''next''.
* Click ''Finish''.
Now the vmx virtual machine should have the Fw version 12r2.

The .ova version will be available also in V12r1 sr7

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

=== IPVA on ESX 6.5 ===
We have reports that the IPVA does not run properly on ESX 6.5. The IPVA boots up properly but the clock does not run. Running the .ova based variation available in v12r2 fixed the issue or edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

=== Administration: Avoid 'reboot' Command. Use 'reset' Command ===
Alwas use the 'reset' command to restart an IPVA.
The 'reboot' command makes sense only on physical applicances, where its purpose is to deploy a new bootcode by means of a forced watchdog trap. The resulting post-reboot state will be as if an unsolicited trap/crash had occurred.

=== Voice Quality Issues ===
When dealing with media streams (e.g. for announcements), the IPVA needs to fulfil real-time processing requirements, for example to process RTP packets in a timely fashion. To do so, the IPVA relies on the capabilities of the virtualization platform it runs on.

It is therefore important to configure the platform so that it supports real-time applications best. If you experience voice quality or latency issues, consider
* to make sure that all of the IPVAs memory is ''reserved'' to the IPVA (''Latency Sensitivity'' set to ''High'')
* to guarantee exclusive PCPU access
This helps to reduce CPU halt/wake-up states.

===Additional vCPUs may cause problems===
The Multi-Core functionality of version 13r2 is a beta functionality. Additional virtual CPUs(vCPUs) should not be utilized in production environments.

==FAQ==
===Can The emulated compact-flash disk size be increased?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated compact-flash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given. Please note: The compact-flash disk is not the flash which store LDAP and VARS.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)
===What Is the minimum size of the emulated flash storage?===
The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is defaulted to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)

{{Limit_Virtual_IPVA_Flash}}

===How much RAM is required per IPVA instance?===
Since 12r2sr27/13r1sr5 the downloadable virtual appliance comes preconfigured with 256 MiB RAM. This amount is seen as a good trade-off for the majority of all installations. The IPVA need the amount of used flash 3-times at startup. The RAM-size can be administrated by VMware-means.

===What is the maximum amount of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why does ''General/Info/DRAM'' show less than the configured memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===What about Open VM Tools / VMware Tools?===
Tools like this are not supported / integrated because it is not needed. The Virtual Appliance provides his own operating system, and we don't need any of the VM-Tools features in our guest.

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|ipva-crc-wrong.jpg/|ipva-crc-wrong.jpg/]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|ipva-nic-unavailable.jpg/|ipva-nic-unavailable.jpg/]]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|screenshot-ipva-perfcounter-nok.jpg/|screenshot-ipva-perfcounter-nok.jpg/]]

'''Solution''' 
This problem is likely caused by an OVA-import of the IPVA. The appliance's configuration file ''ipva.vmx'' requires a VMware proprietary configuration line that's not specifiable within an OVA-file.

The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

'''Remarks'''
*The vmx file should be edited after the installation of the IPVA.
*The vmx file should NOT be edited with Text editor (use vSphere as shown above)
*To our knowledge, a converter is always necessary for the installation with vmx.

===What Can I Do In Case Of Boot-Problem: ''Loading failed for image=IPVA BIN''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
Loading failed for image=IPVA BIN
</pre>
[[Image:Ipva-fw-load-failed.png|center|thumb|200px|ipva-fw-load-failed.png/|ipva-fw-load-failed.png/]]

'''Solution''' 
This problem is likely caused by a calculation fault within the boot-code.
*The solution requires a replacement of the boot disk hd-boot.vmdk.
**Download an IPVA package from on 11r2 sr22.
**Replace the 1st disk with the one from the downloaded package

===Are Additional vCPUs useful?===
The Multi-Core functionality is an experimental functionality. Additional virtual CPUs(vCPUs) should not be utilized in production environments.

==Notes==
<references/>

==Related Articles==
* [[{{NAMESPACE}}:Licenses|Reference15r1:Licenses]]
* [[Howto15r1:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance]]
* [[Howto:A_rough_estimate_of_IPVA_Performance]]

[[Category:Concept15r1|{{PAGENAME}}]]

Reference16r1:Concept Innovaphone Virtual Appliance (IPVA)

2026-08-24T11:13:05Z

Slu: /* Settings */

==Applies To==
This information applies to:
*V16r1
*innovaphone Virtual Appliance
*Intel/AMD CPUs
* Virtualization platforms
**VMware
*** Workstation
*** Player
*** vSphere 4 - 8
*** ESXi 6 - 8
**Microsoft Hyper-V ([[{{NAMESPACE}}:Concept IPVA On Hyper-V|Concept IPVA On Hyper-V]])
*** Windows 8.1
*** Windows 10
*** Windows Server 2012 R2
*** Windows Server 2016 CTP4
**Linux based Hypervisors with [https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine KVM] and [https://en.wikipedia.org/wiki/QEMU QEMU] support
*** Proxmox VE 8.0 / 8.1 / 9.1

''Disclaimer: Manufacturers/versions of VM platforms other than those specified here have not been tested, so use at your own risk.''

''Disclaimer 2: We occasionally encounter customers experiencing unusual issues related to OpenStack. OpenStack is not officially supported, and such issues are not analyzed.''

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.

The IPVA is a software-only solution. It appears and behaves like an innovaphone "hard-box" without physical resources such as hardware DSP or ISDN interface.

==Package Overview==
We supply an OVF ('''O'''pen '''V'''irtualization '''F'''ormat) import or - depending on the virtualization platform - a suitable variant.
OVF is an open standard that contains several files in one package. The .ovf file is therefore an archive that contains all the necessary files.

=== Sample VMware ===
;ipva-ovf.zip:
The compressed archive ''ipva-ovf.zip'' contains the file ipva.ova. A deployment of ipva.ova will result in a set of 5 files - the file names may differ from the following list:
*ipva.vmx: The virtual machine configuration file
*hd-boot.vmdk: The virtual boot disk on IDE 0:0
*hd-cf.vmdk: The disk for emulation of a Compact Flash card on IDE 0:1
*hd-flash.vmdk: The disk for emulation of flash memory on IDE 1:0
*hd-dump.vmdk: The disk serving as a store for a crash dump on IDE 1:1

;ipva.bin:
The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

== Virtualization platforms ==

===VMware Player / VMware Workstation===
==== Import new Machine ====
*Copy the file ipva.ova to e.g. your desktop and Double-click on ipva.ova.
*Edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

===VMware vSphere===
==== Import new Machine ====
*Import ipva.ova by means of '''File/Deploy OVF-Template...''' (de: '''Datei/OFV-Vorlage bereitstellen...''') and follow instructions.
*Edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

===Microsoft Hyper-V===
==== Import new Machine ====
* Use the UI Wizard to Import a new machine
* Browse to the directory where the downloaded package was extracted to. Browse to the subdirectory Virtual Machines and click Ok
* Select ''Copy the Virtual Machine'' as ''Import Type''

===Proxmox VE===
==== Settings ====
===== Hardware =====
* Processors: 1 socket, 1 core, Type "Host" preferred, fallback "x86-64-v2-AES"
* Bios: SeaBIOS
* Machine: i440fx
* SCSI Controller: VirtIO SCSI single
* Hard Disks
** Cache: No Cache
** Discard: Enable
** SSD emulation: Yes
** Async IO: io_uring
* Network Devices
** Model: VirtIO (paravirtualized)

==== Import new Machine ====
Import the "ova" file to your storage which is enabled for the type "import". After that you can select the created template an create new machines from it with the button "Import"

* Before you start up the VM in the UI you have to adjust the following configuration options:
** Hardware -> Processors: Adjust "Extra Cpu Flags" -> "aes" if required
** Hardware -> SCSI Controller: Change Model to "VirtIO SCSI Single"
** Hardware -> Network Device (net0 / net1): Change Model to "VirtIO (paravirtualized)"

==Configuration==

===Network Configuration===
The IPVA is preconfigured a DHCP client. You will see the current IP-Address in the console-screen of the VM. If there's in no case a DHCP server available for the 1st-time configuration, you can set your IP-Configuration in the console.

config change IP0 ETH0 /addr 192.168.0.10 /mask 255.255.255.0
config change IP0 RT0 /gateway 192.168.0.1
config change DHCP0 /mode off
config write
reset

====MAC/serial number====
Take care that you use a MAC address which is supported by my.innovaphone, see [[Reference:My_Innovaphone#IPVA_MAC_exists]].

===AES Hardware Acceleration===
It may be beneficial to activate hardware acceleration for AES operations.
Whether hardware acceleration is activated can be checked with the command <code>!mod cmd CPU cpu-info</code>.

* The "flags" attribute must contain "aesni"
* The "act-features" attribute must contain "has_aesni"

Example:
<info>
<cpu
vendor="GenuineIntel"
signature="0x906e9"
brand="Intel(R) Core(TM) i5-7400 CPU @ 3.00GHz"
...
flags="sse3 pclmulqdq ssse3 sse4_1 sse4_2 aesni xsave xsaveopt osxsave avx f16c rdrand fpu mmx fxsr sse sse2 avx2"
act-features="has_aesni has_avx has_vaesni has_vpclmulqdq" srtp-mips="5"/>
</info>

==Large IPVA with 512 MiB Flash==
In some scenarios the standard 64 MiB flash memory is not enough to store all user data. It is possible to manually enlarge the flash memory of an IPVA up to 512 MiB.

You have to change the settings of the virtual machine and format the flash. You cannot do it with an already configured machine, because you will lose all your configuration!

# shutdown the IPVA
# increase the RAM to 3.072 MiB
# increase the size of '''IDE1:0''' to 512 MiB or recreate it
# power up the IPVA
# format the flash: <code>!mod cmd FLASHMAN0 reset all</code>
# reboot the IPVA: <code>!reset</code>

You can check the free space with the command <code>!mod cmd FLASHMAN0 info</code>. You will see a big amount of available segments

segments=675, segment-size=0x10000 (64k)
LDAP - used 1k avail 63k owned 64k (segments 1) maximum 517056k (segments 8079, configured 8079)
VARS - used 23k avail 16k owned 192k (segments 3) maximum 640k (segments 10, configured 10)

But please keep in mind, the more data is saved, the longer it takes to reboot and load the UI in the [[{{NAMESPACE}}:PBX/Objects|PBX/Objects]] area.

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Maintenance/Diagnostics/Tracing/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).

==Known Issues==

=== Maximal 3.072 MiB RAM ===
Because the IPVA has no [https://en.wikipedia.org/wiki/Virtual_memory virtual memory management], it will use only the first linear 3 GiB of RAM. But please keep in mind, that the flash content will be stored 3-times (Flashmanager, Flashdirectory, PBX) in RAM at startup.
=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How To Replace The Boot Disk On vSphere.3F| How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

Some Customer who are running Fw v12r1 (up to sr6) with ESXi 6.0 and VEEAM 9 reported that after a backup with VEEAM 9, the restored IPVA was not starting.
At this point, there is no possibility to solve this problem. The only workaround in that case is to delete the machine, reinstall a new one, and restore a configuration saved before.

If you did not run into the problem yet, for prevention, we recommend to replace the Boot disk of your working IPVA.vmx with one of the IPVA.ova. Please follow the steps below (be aware that this will upgrade the firmware on the IPVA to 12r2, due to the fact that actually, IPVA.ova is only available from version 12r2):

1. Remove the Boot disk of the virtual machine (vmx)(is normaly the first one). 
* Power off the VM
* Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Remove''.
* Click ''OK'' to save your changes.

2. Add the Boot disk of the ova virtual machine to the vmx one.
* Identify the size of the boot disk of the ova virtual machine (will be needed on the step when navigating to boot disk)
* On the powered off VM, Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Add''.
* Select Use “an existing virtual disk” then click ''Next''.
* Navigate to the boot disk of the ova Virtual machine then click ''next''.
* Click ''Finish''.
Now the vmx virtual machine should have the Fw version 12r2.

The .ova version will be available also in V12r1 sr7

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

=== IPVA on ESX 6.5 ===
We have reports that the IPVA does not run properly on ESX 6.5. The IPVA boots up properly but the clock does not run. Running the .ova based variation available in v12r2 fixed the issue or edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

=== Administration: Avoid 'reboot' Command. Use 'reset' Command ===
Alwas use the 'reset' command to restart an IPVA.
The 'reboot' command makes sense only on physical applicances, where its purpose is to deploy a new bootcode by means of a forced watchdog trap. The resulting post-reboot state will be as if an unsolicited trap/crash had occurred.

=== Voice Quality Issues ===
When dealing with media streams (e.g. for announcements), the IPVA needs to fulfil real-time processing requirements, for example to process RTP packets in a timely fashion. To do so, the IPVA relies on the capabilities of the virtualization platform it runs on.

It is therefore important to configure the platform so that it supports real-time applications best. If you experience voice quality or latency issues, consider
* to make sure that all of the IPVAs memory is ''reserved'' to the IPVA (''Latency Sensitivity'' set to ''High'')
* to guarantee exclusive PCPU access
This helps to reduce CPU halt/wake-up states.

===Additional vCPUs may cause problems===
The Multi-Core functionality of version 13r2 is a beta functionality. Additional virtual CPUs(vCPUs) should not be utilized in production environments.

==FAQ==
===Can The emulated compact-flash disk size be increased?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated compact-flash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given. Please note: The compact-flash disk is not the flash which store LDAP and VARS.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)
===What Is the minimum size of the emulated flash storage?===
The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is defaulted to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)

{{Limit_Virtual_IPVA_Flash}}

===How much RAM is required per IPVA instance?===
Since 12r2sr27/13r1sr5 the downloadable virtual appliance comes preconfigured with 256 MiB RAM. This amount is seen as a good trade-off for the majority of all installations. The IPVA need the amount of used flash 3-times at startup. The RAM-size can be administrated by VMware-means.

===What is the maximum amount of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why does ''General/Info/DRAM'' show less than the configured memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===What about Open VM Tools / VMware Tools?===
Tools like this are not supported / integrated because it is not needed. The Virtual Appliance provides his own operating system, and we don't need any of the VM-Tools features in our guest.

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|ipva-crc-wrong.jpg/|ipva-crc-wrong.jpg/]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|ipva-nic-unavailable.jpg/|ipva-nic-unavailable.jpg/]]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|screenshot-ipva-perfcounter-nok.jpg/|screenshot-ipva-perfcounter-nok.jpg/]]

'''Solution''' 
This problem is likely caused by an OVA-import of the IPVA. The appliance's configuration file ''ipva.vmx'' requires a VMware proprietary configuration line that's not specifiable within an OVA-file.

The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

'''Remarks'''
*The vmx file should be edited after the installation of the IPVA.
*The vmx file should NOT be edited with Text editor (use vSphere as shown above)
*To our knowledge, a converter is always necessary for the installation with vmx.

===What Can I Do In Case Of Boot-Problem: ''Loading failed for image=IPVA BIN''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
Loading failed for image=IPVA BIN
</pre>
[[Image:Ipva-fw-load-failed.png|center|thumb|200px|ipva-fw-load-failed.png/|ipva-fw-load-failed.png/]]

'''Solution''' 
This problem is likely caused by a calculation fault within the boot-code.
*The solution requires a replacement of the boot disk hd-boot.vmdk.
**Download an IPVA package from on 11r2 sr22.
**Replace the 1st disk with the one from the downloaded package

===Are Additional vCPUs useful?===
The Multi-Core functionality is an experimental functionality. Additional virtual CPUs(vCPUs) should not be utilized in production environments.

==Notes==
<references/>

==Related Articles==
* [[{{NAMESPACE}}:Licenses|Reference15r1:Licenses]]
* [[Howto15r1:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance]]
* [[Howto:A_rough_estimate_of_IPVA_Performance]]

[[Category:Concept15r1|{{PAGENAME}}]]

Reference16r1:Services/NTP

2026-08-14T12:03:37Z

Slu: /* Configuration */

The device can synchronize its internal date/time to an NTP server using the SNTP protocol. Without synchronization to an NTP server the internal date/time is reset to Januar 1st, 1970 0:00 after each restart.

== Configuration ==

{|
|valign=top nowrap=true|'''Server'''
| The IP-Address or DNS-Name of the time server
|-
|valign=top nowrap=true|'''Interval [min]:'''
|The time interval (in minutes) at which the device tries to synchronise with the time server
|-
|valign=top nowrap=true|'''Timezone'''
|Select the time zone in which the device is located.
|-
|valign=top nowrap=true|'''String'''
|If the timezone to be used is not one of the predefined timezones, it can be confugured with a string in accordance with the IEEE POSIX standard
|-
|valign=top nowrap=true|'''Current Server'''
|Displays the current used NTP Server.
|-
|valign=top nowrap=true|'''Last sync'''
|Displays the data and time of the last synchronisation.
|-
|valign=top nowrap=true|'''Default Time'''
|Default time in UTC on startup that shall be used if no NTP Server is available. The Format is ''dd.mm.yyyy-hh:mm''
|}

== Timezone Configuration String ==

Time services always provide the coordinated world time UTC (Universal Time Coordinated), which corresponds to GMT (Greenwich Mean Time), not however the correct time zone and summer time. It is therefore possible to specify the time difference between the time zone and the world time in the String field. The difference from the time zone GMT+1 (Central European time zone) is 60 minutes. A further 60 minutes has to be added with summer time, adding up to a total difference of 120 minutes. In this case, however, you must adjust the time difference manually when switching from winter to summer time and vice versa.

If a so-called timezone string was entered in the String field, the device can make the switch from summer to winter time automatically. The name of the time zone, the name of the summer time zone, their respective differences in time compared to the UTC and the time switch points are encoded in this field.

There are various formats for the specification of this string. These formats are defined by the IEEE POSIX standard.
POSIX timezone strings have the following format (optional parts in square brackets):

'''StdOffset[Dst[Offset], Date/Time, Date/Time]'''

'''Std''' stands for the time zone (for example, CET for Central European Time or MET for Middle European Time).

'''Offset''' specifies the time difference between the time zone and UTC, for example, -1 for Central European Time. The difference is negative if the time zone is ahead of UTC. If the time difference does not comprise full hours, the number of minutes can be added, for example, -1:30.
The TZ string ends here if you are not using a summer time.

'''Dst''' stands for the summer time zone (for example, CEST for Central European Summer Time or MES for Middle European Summer Time).

The optional, '''second Offset''' parameter gives the offset of the summer time in respect of UTC. An hour before normal time is assumed if no entry is made.

'''Date/Time''' define the start and end of summer time. The format for a time entry is Mm.n.d, signifying the d-th day of the n-th week of the m-th month. Day 0 is Sunday. If the fifth week is entered, the last day (with respect to d) of the month is meant. The format for a time entry is hh[:mm[:ss]], in the 24-hour format.

=== Example ===

The Central European time zone is specified '''CET-1CEST-2,M3.5.0/2,M10.5.0/3''':

CET (Central European Time) - offset -1

CEST (Central European Summer Time) - offset -2

Switch to Summer Time at 3(March), 5(last week of the month), 0(Sunday)/at 2:00

Switch to Standard Time at 10(October), 5(last week of the month), 0(Sunday)/at 3:00

= Related Articles =
* [[Howto:Setting time and date without using an NTP]]

Reference16r1:Services/NTP

2026-08-14T12:03:05Z

Slu: Created page with "The device can synchronize its internal date/time to an NTP server using the SNTP protocol. Without synchronization to an NTP server the internal date/time is reset to Januar 1st, 1970 0:00 after each restart. == Configuration == {| |valign=top nowrap=true|'''Server''' |The IP-Adresse of the time server |- |valign=top nowrap=true|'''Interval [min]:''' |The time interval (in minutes) at which the device tries to synchronise with the time server |- |valign=top nowrap=tru..."

The device can synchronize its internal date/time to an NTP server using the SNTP protocol. Without synchronization to an NTP server the internal date/time is reset to Januar 1st, 1970 0:00 after each restart.

== Configuration ==

{|
|valign=top nowrap=true|'''Server'''
|The IP-Adresse of the time server
|-
|valign=top nowrap=true|'''Interval [min]:'''
|The time interval (in minutes) at which the device tries to synchronise with the time server
|-
|valign=top nowrap=true|'''Timezone'''
|Select the time zone in which the device is located.
|-
|valign=top nowrap=true|'''String'''
|If the timezone to be used is not one of the predefined timezones, it can be confugured with a string in accordance with the IEEE POSIX standard
|-
|valign=top nowrap=true|'''Current Server'''
|Displays the current used NTP Server.
|-
|valign=top nowrap=true|'''Last sync'''
|Displays the data and time of the last synchronisation.
|-
|valign=top nowrap=true|'''Default Time'''
|Default time in UTC on startup that shall be used if no NTP Server is available. The Format is ''dd.mm.yyyy-hh:mm''
|}

== Timezone Configuration String ==

Time services always provide the coordinated world time UTC (Universal Time Coordinated), which corresponds to GMT (Greenwich Mean Time), not however the correct time zone and summer time. It is therefore possible to specify the time difference between the time zone and the world time in the String field. The difference from the time zone GMT+1 (Central European time zone) is 60 minutes. A further 60 minutes has to be added with summer time, adding up to a total difference of 120 minutes. In this case, however, you must adjust the time difference manually when switching from winter to summer time and vice versa.

If a so-called timezone string was entered in the String field, the device can make the switch from summer to winter time automatically. The name of the time zone, the name of the summer time zone, their respective differences in time compared to the UTC and the time switch points are encoded in this field.

There are various formats for the specification of this string. These formats are defined by the IEEE POSIX standard.
POSIX timezone strings have the following format (optional parts in square brackets):

'''StdOffset[Dst[Offset], Date/Time, Date/Time]'''

'''Std''' stands for the time zone (for example, CET for Central European Time or MET for Middle European Time).

'''Offset''' specifies the time difference between the time zone and UTC, for example, -1 for Central European Time. The difference is negative if the time zone is ahead of UTC. If the time difference does not comprise full hours, the number of minutes can be added, for example, -1:30.
The TZ string ends here if you are not using a summer time.

'''Dst''' stands for the summer time zone (for example, CEST for Central European Summer Time or MES for Middle European Summer Time).

The optional, '''second Offset''' parameter gives the offset of the summer time in respect of UTC. An hour before normal time is assumed if no entry is made.

'''Date/Time''' define the start and end of summer time. The format for a time entry is Mm.n.d, signifying the d-th day of the n-th week of the m-th month. Day 0 is Sunday. If the fifth week is entered, the last day (with respect to d) of the month is meant. The format for a time entry is hh[:mm[:ss]], in the 24-hour format.

=== Example ===

The Central European time zone is specified '''CET-1CEST-2,M3.5.0/2,M10.5.0/3''':

CET (Central European Time) - offset -1

CEST (Central European Summer Time) - offset -2

Switch to Summer Time at 3(March), 5(last week of the month), 0(Sunday)/at 2:00

Switch to Standard Time at 10(October), 5(last week of the month), 0(Sunday)/at 3:00

= Related Articles =
* [[Howto:Setting time and date without using an NTP]]

Howto17:Firmware Upgrade V16r1 V17

2026-08-14T08:33:12Z

Slu: /* Upgrade AP Image */

== Applies To ==
This information applies to:

* All 17 capable innovaphone devices
: For a general overview of the upgrade process and a list of supported devices with 17, see [[Howto:Firmware Upgrade]]
== Licenses ==
In case of cloud or rental model, don't worry about licenses.

If the system is licensed on premise, you'll need to regenerate the license file for v17 in https://portal.innovaphone.com/ and load into the system before upgrade (The system needs to have the SSC up to date).

== Migration Policy ==
Before you begin, be sure that your whole installation is running the latest 16r1 service release. Create backups before you start and store them on an external location

=== Upgrade AP Image ===
* First, upgrade your application platform to at least image version <code>140049</code>. After that you can go ahead.

=== Upgrade Sequence ===
In systems of multiple units, it is important to update the tree from top to bottom. In other words, update the master unit first, and then the machines at the lower levels. If you're using a DevicesApp update job that updates the entire system at once, you don't need to do anything here.

=== TechAssist Upgrade Helper ===
* Before you start, make sure that all TechAssist tests (you will receive the required tests in the last update in the previous major version) labelled <code>Pre Upgrade: xy</code> are positive, if available
* When you are finished, make sure that all TechAssist tests (you will receive new tests with the upgrade) are positive

== Changes visible to the end customers ==
Listed here are changes that should be communicated by resellers to end users prior to a upgrade, as the change will be visible/audible in the behaviour of the application/device.

* <code>tbd</code>

== Manual steps needed after upgrade ==
If the installer is not used for a new installation, some new default settings are not set. Please evaluate per app whether you want to configure the new default settings manually.

=== Connector for kuando - MacOS ===
With V17, the Kuando HTTP server is no longer required. From version 2.0.7 onwards, the HTTP server is already integrated into KuandoHub and works in exactly the same way as the Windows version.
The HTTP server must be uninstalled and KuandoHub installed; once the default setting has been defined in the Platform Priorities, no further configuration is required.

== New Apps ==
New Apps will not be installed automatically by the upgrade. The installation description of new apps is usually in the concept article. Please rate per app whether you want to install/use the new app and configure it manually.

<code>tbd</code>
;
:

== Removed ==
The following software is no longer included.

* <code>tbd</code>

== Deprecated ==
The following software is based on legacy technology, with no further development and limited maintenance and support.

* <code>tbd</code>

== Previously deprecated and now no longer supported ==
The following software is based on legacy technology, with no further development and no more maintenance and support.

* <code>tbd</code>

==Known Problems==
===Long Update-duration===
When you update, it can be up to 10 minutes before you have access to your app platform again.

== Related Articles ==
* [[Howto:Firmware_Upgrade]]
* [[Howto16r1:Firmware_Upgrade_V15r1_V16r1]]
[[Category:Howto|{{PAGENAME}}]]

Reference16r1:Concept App Service IP

2026-07-23T13:13:52Z

Slu: /* Create instance */

[[Category:Concept|Apps]]
[[Category:Concept|IP]]

The App IP is an app which offers the PBX functionality and further functionalities as App service on our innovaphone App Platform.

== Applies To ==

* innovaphone firmware and apps V16

==Requirements==
* innovaphone Application Platform (image version 140011 or higher)

==Concept==

The App IP offers modules known from innovaphone gateways, like the PBX, TURN server functionality etc.

==How it works==

=== Single instance mode ===
Unlike other App Services, the App IP is a single instance App Service, so you can create '''just''' a single instance and not multiple instances.

== Licensing ==
Standard licensing mechanisms apply to the App IP as they apply to innovaphone gateways.

In addition, every port license requires a dedicated IPAP license (similar to the IPVA license for virtual machines).

== Apps ==

There is no App provided by this App Service.

== PBX Manager Plugins ==

There is no PBX Manager Plugin provided by this App Service.

== Configuration ==

The configuration is done as an innovaphone gateway is configured too.

=== Create instance ===
You have to create one instance for the App IP Service.

[[Courseware:IT Advanced - 04 Setting up the Application Platform#Adding an App Service instance|Here]] are more informations how to do this.

We recommend the following settings: 
'''Name''' = ip 
'''Domain''' = customer domain (system name of the PBX) 
'''Password''' = The password '''must be set to "pwd"''' for Install and will be changed during the process. '''Note:''' if you want to login with the Adv.GUI to the PBX prior to the Install proces, this is also the admin password! 
'''Webserver Path''' - Used for access to the UI. Adjustable, will be filled automatically with the value "$domain/ip", eg. <code>domain.com/ip</code>

=== Install Process ===
Install can be started under the webserver path of the App IP instance and /''install.htm'', e.g.: http://app.domain.com/domain.com/ip/install.htm

⚠️ Use standard ports for installation. If necessary, install via a reverse proxy

⚠️ Do not use the localhost (127.0.0.1) address

=== Advanced UI ===
The advanced UI is reachable under the webserver path of the App IP instance and /admin.xml?xsl=admin.xsl, e.g.:
https://app.domain.com/domain.com/ip/admin.xml?xsl=admin.xsl

==== Password ====
The password for the Advanced UI is the password of the App IP instance. 
If the Devices App rolls out passwords, the domain password is also used for the App IP admin login.

=== IP configuration ===
As the App IP is just an App on an App Platform, there are no IP4/IP6, NTP etc. settings as on other innovaphone devices.

==== Devices App ====
If your App Platform which runs the App IP is connected to a Devices App, you can access the Advanced UI with the '''PBX''' tab of your App Platform device.

== Functional Distinction from a Gateway or an IPVA ==
Due to the system architecture, not all existing software functions of a gateway or an IPVA can be made available in an "IP App".

The following features are not available:
* PBX users with "additional user rights" and an associated login to the advanced UI
* SOAP (currently)

==Troubleshooting==
The App IP offers standard tracing mechanism for App Services and in addition mechanisms known from innovaphone gateways. 
You can enable module related trace flags with config change commands or by setting trace flags under Maintenance -> Tracing in the Advanced UI of the App IP.

Trace files are not found under Maintenance -> Tracing but on the App IP service on your App Platform Manager.

==Known issues==
The installation process must be performed using a DNS name rather than an IP address. 
The URL must include the parameter ''?apdns="DNS from App Platform"'' in the path, for example: http://app.domain.com/domain.com/ip/install.htm?apdns=pbx.domain.com 
Starting with version 16r1 sr1, installation using an IP address is supported. 

However, it is generally recommended to use DNS for the installation.

==Related Articles==
* [[Reference16r1:Concept_innovaphone_App_Platform_Container]]

Reference16r1:Concept App Service IP

2026-07-23T13:12:55Z

Slu: /* Create instance */

[[Category:Concept|Apps]]
[[Category:Concept|IP]]

The App IP is an app which offers the PBX functionality and further functionalities as App service on our innovaphone App Platform.

== Applies To ==

* innovaphone firmware and apps V16

==Requirements==
* innovaphone Application Platform (image version 140011 or higher)

==Concept==

The App IP offers modules known from innovaphone gateways, like the PBX, TURN server functionality etc.

==How it works==

=== Single instance mode ===
Unlike other App Services, the App IP is a single instance App Service, so you can create '''just''' a single instance and not multiple instances.

== Licensing ==
Standard licensing mechanisms apply to the App IP as they apply to innovaphone gateways.

In addition, every port license requires a dedicated IPAP license (similar to the IPVA license for virtual machines).

== Apps ==

There is no App provided by this App Service.

== PBX Manager Plugins ==

There is no PBX Manager Plugin provided by this App Service.

== Configuration ==

The configuration is done as an innovaphone gateway is configured too.

=== Create instance ===
You have to create one instance for the App IP Service.

[[Courseware:IT Advanced - 04 Setting up the Application Platform#Adding an App Service instance|Here]] are more informations how to do this.

We recommend the following settings: 
'''Name''' = ip 
'''Domain''' = customer domain (system name of the PBX) 
'''Password''' = The password '''must be set to "pwd"''' for Install and will be changed during the process. '''Note:''' if you want to login with the Adv.GUI to the PBX prior to the Install proces, this is also the admin password! 
'''Webserver Path''' - Adustable, will be filled automatically with the value "$domain/ip", eg. <code>domain.com/ip</code>

=== Install Process ===
Install can be started under the webserver path of the App IP instance and /''install.htm'', e.g.: http://app.domain.com/domain.com/ip/install.htm

⚠️ Use standard ports for installation. If necessary, install via a reverse proxy

⚠️ Do not use the localhost (127.0.0.1) address

=== Advanced UI ===
The advanced UI is reachable under the webserver path of the App IP instance and /admin.xml?xsl=admin.xsl, e.g.:
https://app.domain.com/domain.com/ip/admin.xml?xsl=admin.xsl

==== Password ====
The password for the Advanced UI is the password of the App IP instance. 
If the Devices App rolls out passwords, the domain password is also used for the App IP admin login.

=== IP configuration ===
As the App IP is just an App on an App Platform, there are no IP4/IP6, NTP etc. settings as on other innovaphone devices.

==== Devices App ====
If your App Platform which runs the App IP is connected to a Devices App, you can access the Advanced UI with the '''PBX''' tab of your App Platform device.

== Functional Distinction from a Gateway or an IPVA ==
Due to the system architecture, not all existing software functions of a gateway or an IPVA can be made available in an "IP App".

The following features are not available:
* PBX users with "additional user rights" and an associated login to the advanced UI
* SOAP (currently)

==Troubleshooting==
The App IP offers standard tracing mechanism for App Services and in addition mechanisms known from innovaphone gateways. 
You can enable module related trace flags with config change commands or by setting trace flags under Maintenance -> Tracing in the Advanced UI of the App IP.

Trace files are not found under Maintenance -> Tracing but on the App IP service on your App Platform Manager.

==Known issues==
The installation process must be performed using a DNS name rather than an IP address. 
The URL must include the parameter ''?apdns="DNS from App Platform"'' in the path, for example: http://app.domain.com/domain.com/ip/install.htm?apdns=pbx.domain.com 
Starting with version 16r1 sr1, installation using an IP address is supported. 

However, it is generally recommended to use DNS for the installation.

==Related Articles==
* [[Reference16r1:Concept_innovaphone_App_Platform_Container]]

Reference16r1:Concept App Service IP

2026-07-21T07:12:29Z

Slu: /* Troubleshooting */

[[Category:Concept|Apps]]
[[Category:Concept|IP]]

The App IP is an app which offers the PBX functionality and further functionalities as App service on our innovaphone App Platform.

== Applies To ==

* innovaphone firmware and apps V16

==Requirements==
* innovaphone Application Platform (image version 140011 or higher)

==Concept==

The App IP offers modules known from innovaphone gateways, like the PBX, TURN server functionality etc.

==How it works==

=== Single instance mode ===
Unlike other App Services, the App IP is a single instance App Service, so you can create '''just''' a single instance and not multiple instances.

== Licensing ==
Standard licensing mechanisms apply to the App IP as they apply to innovaphone gateways.

In addition, every port license requires a dedicated IPAP license (similar to the IPVA license for virtual machines).

== Apps ==

There is no App provided by this App Service.

== PBX Manager Plugins ==

There is no PBX Manager Plugin provided by this App Service.

== Configuration ==

The configuration is done as an innovaphone gateway is configured too.

=== Create instance ===
You have to create one instance for the App IP Service.

[[Courseware:IT Advanced - 04 Setting up the Application Platform#Adding an App Service instance|Here]] are more informations how to do this.

We recommend the following settings: 
'''Name''' = ip 
'''Domain''' = customer domain (system name of the PBX) 
'''Password''' = The password '''must be set to "pwd"''' for Install and will be changed during the process. '''Note:''' if you want to login with the Adv.GUI to the PBX prior to the Install proces, this is also the admin password!

=== Install Process ===
Install can be started under the webserver path of the App IP instance and /''install.htm'', e.g.: http://app.domain.com/domain.com/ip/install.htm

⚠️ Use standard ports for installation. If necessary, install via a reverse proxy

⚠️ Do not use the localhost (127.0.0.1) address

=== Advanced UI ===
The advanced UI is reachable under the webserver path of the App IP instance and /admin.xml?xsl=admin.xsl, e.g.:
https://app.domain.com/domain.com/ip/admin.xml?xsl=admin.xsl

==== Password ====
The password for the Advanced UI is the password of the App IP instance. 
If the Devices App rolls out passwords, the domain password is also used for the App IP admin login.

=== IP configuration ===
As the App IP is just an App on an App Platform, there are no IP4/IP6, NTP etc. settings as on other innovaphone devices.

==== Devices App ====
If your App Platform which runs the App IP is connected to a Devices App, you can access the Advanced UI with the '''PBX''' tab of your App Platform device.

== Functional Distinction from a Gateway or an IPVA ==
Due to the system architecture, not all existing software functions of a gateway or an IPVA can be made available in an "IP App".

The following features are not available:
* PBX users with "additional user rights" and an associated login to the advanced UI
* SOAP (currently)

==Troubleshooting==
The App IP offers standard tracing mechanism for App Services and in addition mechanisms known from innovaphone gateways. 
You can enable module related trace flags with config change commands or by setting trace flags under Maintenance -> Tracing in the Advanced UI of the App IP.

Trace files are not found under Maintenance -> Tracing but on the App IP service on your App Platform Manager.

==Known issues==
The installation process must be performed using a DNS name rather than an IP address. 
The URL must include the parameter ''?apdns="DNS from App Platform"'' in the path, for example: http://app.domain.com/domain.com/ip/install.htm?apdns=pbx.domain.com 
Starting with version 16r1 sr1, installation using an IP address is supported. 

However, it is generally recommended to use DNS for the installation.

==Related Articles==
* [[Reference16r1:Concept_innovaphone_App_Platform_Container]]

Howto16r1:Reverse Proxy with HAProxy

2026-07-14T12:50:21Z

Slu: /* Configuration Example */

This article explains how to configure HAProxy to work with the innovaphone Reverse Proxy, specifically when using WebSockets.

== Problem Description ==

When HAProxy is deployed in front of an innovaphone Reverse Proxy, WebSocket connections may not function correctly by default. This can cause issues such as:

* myApps browser sessions reloading or disconnecting periodically (e.g. every 60 seconds)
* WebSocket-based services failing to establish stable connections
* Unexpected behavior with real-time communication features

This happens because HAProxy requires specific configuration to handle WebSocket upgrades properly. The most common issue is that the WebSocket Upgrade/Connection headers are not passed through correctly, or the HTTP keep-alive behavior interferes with the persistent WebSocket connection.

== Solution ==

HAProxy needs to be configured to pass through the WebSocket upgrade headers correctly. The following configuration changes are required:

* Enable HTTP keep-alive
* Pass through the Upgrade and Connection headers
* Configure proper timeouts for WebSocket connections

The key is to add the correct headers to the backend configuration so that HAProxy does not interfere with the WebSocket upgrade process.

== Configuration Example ==

The following is a working HAProxy configuration example for connecting to an innovaphone Reverse Proxy:

frontend https-frontend
bind *:443
mode http
option http-keep-alive
timeout client 30000
http-request set-var(txn.txnhost) hdr(host)
use_backend innovaphone if { var(txn.txnhost) -m sub innovaphone }

backend innovaphone
mode http
timeout connect 30000
timeout server 30000
http-request set-header X-Forwarded-Proto https
http-request set-header Host 192.168.26.11
http-request set-header X-Forwarded-Host innovaphone.example.com
http-request set-header Upgrade %[hdr(upgrade)]
http-request set-header Connection %[hdr(connection),lower]
server innovaphone 192.168.26.11:80 check

=== Key Parameters Explained ===

* ''option http-keep-alive'' (frontend): Ensures that the frontend connection is kept alive and can be reused for multiple requests, including WebSocket upgrades.
* ''timeout client/server 30000'': Sufficiently long timeouts to prevent premature disconnection of persistent WebSocket connections.
* ''http-request set-header X-Forwarded-Proto https'': Preserves the original protocol (HTTPS) so that the innovaphone Reverse Proxy can correctly identify the scheme.
* ''http-request set-header Host'': Sets the correct Host header for the backend, which is important for virtual host routing on the innovaphone Reverse Proxy.
* ''http-request set-header Upgrade'': Passes the ''Upgrade'' header (e.g. "websocket") to the backend, which is required for the WebSocket handshake.
* ''http-request set-header Connection'': Passes the ''Connection'' header (e.g. "Upgrade") to the backend, which is required for the WebSocket handshake.

== Troubleshooting ==

If you are experiencing issues with WebSocket connections through HAProxy:

* Review the HAProxy configuration for proper WebSocket handling (see parameters above)
* Check the HAProxy logs for any connection errors
* Ensure that timeout values are set appropriately for long-lived connections
* Verify that the Upgrade and Connection headers are being passed through correctly
* Test the WebSocket connection without HAProxy in the path to isolate the problem

For detailed HAProxy WebSocket configuration, please refer to the official HAProxy documentation:

[https://www.haproxy.com/blog/websockets-load-balancing-with-haproxy HAProxy WebSocket Blog]

== When to Open a Support Ticket ==

If problems persist after reviewing and adjusting the HAProxy configuration, please open a support ticket with:

* A pcap capture from the innovaphone Reverse Proxy (reverse proxy / all IPv4 TCP/UDP traffic / all IPv4 TLS traffic / enable RPCAP)
* The relevant Client ID
* Your HAProxy configuration (if available)

[[Category:Reverse_Proxy]]
[[Category:Concept_Reverse_Proxy]]

Howto16r1:Reverse Proxy with HAProxy

2026-07-13T14:12:26Z

Slu: /* Configuration Example */

This article explains how to configure HAProxy to work with the innovaphone Reverse Proxy, specifically when using WebSockets.

== Problem Description ==

When HAProxy is deployed in front of an innovaphone Reverse Proxy, WebSocket connections may not function correctly by default. This can cause issues such as:

* myApps browser sessions reloading or disconnecting periodically (e.g. every 60 seconds)
* WebSocket-based services failing to establish stable connections
* Unexpected behavior with real-time communication features

This happens because HAProxy requires specific configuration to handle WebSocket upgrades properly. The most common issue is that the WebSocket Upgrade/Connection headers are not passed through correctly, or the HTTP keep-alive behavior interferes with the persistent WebSocket connection.

== Solution ==

HAProxy needs to be configured to pass through the WebSocket upgrade headers correctly. The following configuration changes are required:

* Enable HTTP keep-alive
* Pass through the Upgrade and Connection headers
* Configure proper timeouts for WebSocket connections

The key is to add the correct headers to the backend configuration so that HAProxy does not interfere with the WebSocket upgrade process.

== Configuration Example ==

The following is a working HAProxy configuration example for connecting to an innovaphone Reverse Proxy:

frontend https-frontend
bind *:443
mode http
option http-keep-alive
timeout client 30000
http-request set-var(txn.txnhost) hdr(host)
use_backend innovaphone if { var(txn.txnhost) -m sub inovaphone }

backend innovaphone
mode http
timeout connect 30000
timeout server 30000
http-request set-header X-Forwarded-Proto https
http-request set-header Host 192.168.26.11
http-request set-header X-Forwarded-Host inovaphone.example.com
http-request set-header Upgrade %[hdr(upgrade)]
http-request set-header Connection %[hdr(connection),lower]
server innovaphone 192.168.26.11:80 check

=== Key Parameters Explained ===

* ''option http-keep-alive'' (frontend): Ensures that the frontend connection is kept alive and can be reused for multiple requests, including WebSocket upgrades.
* ''timeout client/server 30000'': Sufficiently long timeouts to prevent premature disconnection of persistent WebSocket connections.
* ''http-request set-header X-Forwarded-Proto https'': Preserves the original protocol (HTTPS) so that the innovaphone Reverse Proxy can correctly identify the scheme.
* ''http-request set-header Host'': Sets the correct Host header for the backend, which is important for virtual host routing on the innovaphone Reverse Proxy.
* ''http-request set-header Upgrade'': Passes the ''Upgrade'' header (e.g. "websocket") to the backend, which is required for the WebSocket handshake.
* ''http-request set-header Connection'': Passes the ''Connection'' header (e.g. "Upgrade") to the backend, which is required for the WebSocket handshake.

== Troubleshooting ==

If you are experiencing issues with WebSocket connections through HAProxy:

* Review the HAProxy configuration for proper WebSocket handling (see parameters above)
* Check the HAProxy logs for any connection errors
* Ensure that timeout values are set appropriately for long-lived connections
* Verify that the Upgrade and Connection headers are being passed through correctly
* Test the WebSocket connection without HAProxy in the path to isolate the problem

For detailed HAProxy WebSocket configuration, please refer to the official HAProxy documentation:

[https://www.haproxy.com/blog/websockets-load-balancing-with-haproxy HAProxy WebSocket Blog]

== When to Open a Support Ticket ==

If problems persist after reviewing and adjusting the HAProxy configuration, please open a support ticket with:

* A pcap capture from the innovaphone Reverse Proxy (reverse proxy / all IPv4 TCP/UDP traffic / all IPv4 TLS traffic / enable RPCAP)
* The relevant Client ID
* Your HAProxy configuration (if available)

[[Category:Reverse_Proxy]]
[[Category:Concept_Reverse_Proxy]]

Howto16r1:Reverse Proxy with HAProxy

2026-07-13T14:12:07Z

Slu:

This article explains how to configure HAProxy to work with the innovaphone Reverse Proxy, specifically when using WebSockets.

== Problem Description ==

When HAProxy is deployed in front of an innovaphone Reverse Proxy, WebSocket connections may not function correctly by default. This can cause issues such as:

* myApps browser sessions reloading or disconnecting periodically (e.g. every 60 seconds)
* WebSocket-based services failing to establish stable connections
* Unexpected behavior with real-time communication features

This happens because HAProxy requires specific configuration to handle WebSocket upgrades properly. The most common issue is that the WebSocket Upgrade/Connection headers are not passed through correctly, or the HTTP keep-alive behavior interferes with the persistent WebSocket connection.

== Solution ==

HAProxy needs to be configured to pass through the WebSocket upgrade headers correctly. The following configuration changes are required:

* Enable HTTP keep-alive
* Pass through the Upgrade and Connection headers
* Configure proper timeouts for WebSocket connections

The key is to add the correct headers to the backend configuration so that HAProxy does not interfere with the WebSocket upgrade process.

== Configuration Example ==

The following is a working HAProxy configuration example for connecting to an innovaphone Reverse Proxy:

<code>
frontend https-frontend
bind *:443
mode http
option http-keep-alive
timeout client 30000
http-request set-var(txn.txnhost) hdr(host)
use_backend innovaphone if { var(txn.txnhost) -m sub inovaphone }

backend innovaphone
mode http
timeout connect 30000
timeout server 30000
http-request set-header X-Forwarded-Proto https
http-request set-header Host 192.168.26.11
http-request set-header X-Forwarded-Host inovaphone.example.com
http-request set-header Upgrade %[hdr(upgrade)]
http-request set-header Connection %[hdr(connection),lower]
server innovaphone 192.168.26.11:80 check
</code>

=== Key Parameters Explained ===

* ''option http-keep-alive'' (frontend): Ensures that the frontend connection is kept alive and can be reused for multiple requests, including WebSocket upgrades.
* ''timeout client/server 30000'': Sufficiently long timeouts to prevent premature disconnection of persistent WebSocket connections.
* ''http-request set-header X-Forwarded-Proto https'': Preserves the original protocol (HTTPS) so that the innovaphone Reverse Proxy can correctly identify the scheme.
* ''http-request set-header Host'': Sets the correct Host header for the backend, which is important for virtual host routing on the innovaphone Reverse Proxy.
* ''http-request set-header Upgrade'': Passes the ''Upgrade'' header (e.g. "websocket") to the backend, which is required for the WebSocket handshake.
* ''http-request set-header Connection'': Passes the ''Connection'' header (e.g. "Upgrade") to the backend, which is required for the WebSocket handshake.

== Troubleshooting ==

If you are experiencing issues with WebSocket connections through HAProxy:

* Review the HAProxy configuration for proper WebSocket handling (see parameters above)
* Check the HAProxy logs for any connection errors
* Ensure that timeout values are set appropriately for long-lived connections
* Verify that the Upgrade and Connection headers are being passed through correctly
* Test the WebSocket connection without HAProxy in the path to isolate the problem

For detailed HAProxy WebSocket configuration, please refer to the official HAProxy documentation:

[https://www.haproxy.com/blog/websockets-load-balancing-with-haproxy HAProxy WebSocket Blog]

== When to Open a Support Ticket ==

If problems persist after reviewing and adjusting the HAProxy configuration, please open a support ticket with:

* A pcap capture from the innovaphone Reverse Proxy (reverse proxy / all IPv4 TCP/UDP traffic / all IPv4 TLS traffic / enable RPCAP)
* The relevant Client ID
* Your HAProxy configuration (if available)

[[Category:Reverse_Proxy]]
[[Category:Concept_Reverse_Proxy]]

Howto16r1:Reverse Proxy with HAProxy

2026-07-13T14:09:58Z

Slu: Fix list formatting and add HAProxy WebSocket config details - Co-Authored-By: Claude claude-opus-4-5-20251101

This article explains how to configure HAProxy to work with the innovaphone Reverse Proxy, specifically when using WebSockets.

== Problem Description ==

When HAProxy is deployed in front of an innovaphone Reverse Proxy, WebSocket connections may not function correctly by default. This can cause issues such as:

* myApps browser sessions reloading or disconnecting periodically (e.g. every 60 seconds)
* WebSocket-based services failing to establish stable connections
* Unexpected behavior with real-time communication features

This happens because HAProxy requires specific configuration to handle WebSocket upgrades properly. The most common issue is that the WebSocket Upgrade/Connection headers are not passed through correctly, or the HTTP keep-alive behavior interferes with the persistent WebSocket connection.

== Solution ==

HAProxy needs to be configured to pass through the WebSocket upgrade headers correctly. The following configuration changes are required:

* Enable HTTP keep-alive
* Pass through the Upgrade and Connection headers
* Configure proper timeouts for WebSocket connections

The key is to add the correct headers to the backend configuration so that HAProxy does not interfere with the WebSocket upgrade process.

== Configuration Example ==

The following is a working HAProxy configuration example for connecting to an innovaphone Reverse Proxy:

<source lang="haproxy">
frontend https-frontend
bind *:443
mode http
option http-keep-alive
timeout client 30000
http-request set-var(txn.txnhost) hdr(host)
use_backend innovaphone if { var(txn.txnhost) -m sub inovaphone }

backend innovaphone
mode http
timeout connect 30000
timeout server 30000
http-request set-header X-Forwarded-Proto https
http-request set-header Host 192.168.26.11
http-request set-header X-Forwarded-Host inovaphone.example.com
http-request set-header Upgrade %[hdr(upgrade)]
http-request set-header Connection %[hdr(connection),lower]
server innovaphone 192.168.26.11:80 check
</source>

=== Key Parameters Explained ===

* ''option http-keep-alive'' (frontend): Ensures that the frontend connection is kept alive and can be reused for multiple requests, including WebSocket upgrades.
* ''timeout client/server 30000'': Sufficiently long timeouts to prevent premature disconnection of persistent WebSocket connections.
* ''http-request set-header X-Forwarded-Proto https'': Preserves the original protocol (HTTPS) so that the innovaphone Reverse Proxy can correctly identify the scheme.
* ''http-request set-header Host'': Sets the correct Host header for the backend, which is important for virtual host routing on the innovaphone Reverse Proxy.
* ''http-request set-header Upgrade'': Passes the ''Upgrade'' header (e.g. "websocket") to the backend, which is required for the WebSocket handshake.
* ''http-request set-header Connection'': Passes the ''Connection'' header (e.g. "Upgrade") to the backend, which is required for the WebSocket handshake.

== Troubleshooting ==

If you are experiencing issues with WebSocket connections through HAProxy:

* Review the HAProxy configuration for proper WebSocket handling (see parameters above)
* Check the HAProxy logs for any connection errors
* Ensure that timeout values are set appropriately for long-lived connections
* Verify that the Upgrade and Connection headers are being passed through correctly
* Test the WebSocket connection without HAProxy in the path to isolate the problem

For detailed HAProxy WebSocket configuration, please refer to the official HAProxy documentation:

[https://www.haproxy.com/blog/websockets-load-balancing-with-haproxy HAProxy WebSocket Blog]

== When to Open a Support Ticket ==

If problems persist after reviewing and adjusting the HAProxy configuration, please open a support ticket with:

* A pcap capture from the innovaphone Reverse Proxy (reverse proxy / all IPv4 TCP/UDP traffic / all IPv4 TLS traffic / enable RPCAP)
* The relevant Client ID
* Your HAProxy configuration (if available)

[[Category:Reverse_Proxy]]
[[Category:Concept_Reverse_Proxy]]

Howto16r1:Reverse Proxy with HAProxy

2026-07-13T14:05:54Z

Slu: Create HAProxy WebSocket configuration guide - Co-Authored-By: Claude claude-opus-4-5-20251101

Reference16r1:IP6/ETH/IP6

2026-06-25T11:41:16Z

Slu: /* Addresses */

== Configuration ==
{|
|valign=top nowrap=true|'''Address Configuration:'''
| Automatic or static IP6 address configuration
|}

== Addresses ==
{|
|valign=top nowrap=true|'''IP6 Address:'''
| The IP address used by the network adapter.
|-
|valign=top nowrap=true|'''Prefix:'''
| Prefix in CIDR notation without slash
|}

== Gateway ==
{|
|valign=top nowrap=true|'''Default Gateway:'''
| The standard router used by the device.
|}

== Options==
{|
|valign=top nowrap=true|'''Router Interface:'''
| Interface is router. Replies Router Solicitations with Router Advertisments, publishes routes and forwards packets.
|-
|valign=top nowrap=true|'''Proxy ND:'''
| Enable replies to Neighbour Discovery requests if for queried IP6 address an active route exists
|-
| '''Disabled:'''
| Disable the interface
|}

== Static IP6 Routes ==
In the '''Static IP6 Routes''' section, additional network routes can be defined if other network areas apart from the local network are required.
{|
|valign=top nowrap=true|'''Destination:'''
| The network address of the destination route.
|-
|valign=top nowrap=true|'''Gateway:'''
| The gateway of the network being routed.
|}

== IP6-Filter==
Definition of global IP6 address filters to protect the device from unauthorized access.
{|
|valign=top nowrap=true|'''Enable:'''
| Consider defined filters
|-
|valign=top nowrap=true|'''IP6-Filter-Address:'''
| The network address to be filtered.
|-
|valign=top nowrap=true|'''IP6-Filter-Port:'''
| The port to be filtered out of the defined network address.
|-
|valign=top nowrap=true|'''Protocol:'''
| Protocol to which the filter is applied. UDP or TCP.
|}

Reference16r1:IP6/ETH/IP6

2026-06-25T11:39:35Z

Slu: Created page with "== Configuration == {| |valign=top nowrap=true|'''Address Configuration:''' | Automatic or static IP6 address configuration |} == Addresses == {| |valign=top nowrap=true|'''IP6 Address:''' | The IP6 address used by the network adapter. |- |valign=top nowrap=true|'''Prefix:''' | tbd |} == Gateway == {| |valign=top nowrap=true|'''Default Gateway:''' | The standard router used by the device. |} == Options== {| |valign=top nowrap=true|'''Router Interface:''' | tbd |- |val..."

== Configuration ==
{|
|valign=top nowrap=true|'''Address Configuration:'''
| Automatic or static IP6 address configuration
|}

== Addresses ==
{|
|valign=top nowrap=true|'''IP6 Address:'''
| The IP6 address used by the network adapter.
|-
|valign=top nowrap=true|'''Prefix:'''
| tbd
|}

== Gateway ==
{|
|valign=top nowrap=true|'''Default Gateway:'''
| The standard router used by the device.
|}

== Options==
{|
|valign=top nowrap=true|'''Router Interface:'''
| tbd
|-
|valign=top nowrap=true|'''Proxy ND:'''
| Enable replies to Neighbour Discovery requests if for queried IP6 address an active route exists
|-
| '''Disabled:'''
| Disable the interface
|}

== Static IP6 Routes ==
In the '''Static IP6 Routes''' section, additional network routes can be defined, if other network areas apart from the local network are required.
{|
|valign=top nowrap=true|'''Destination:'''
| The network address of the destination route.
|-
|valign=top nowrap=true|'''Gateway:'''
| The standard gateway of the network being routed.
|}

== IP6-Filter==
Definition of global IP6 address filters to protect the device from unauthorised access.
{|
|valign=top nowrap=true|'''Enable:'''
| Consider defined filters
|-
|valign=top nowrap=true|'''IP6-Filter-Address:'''
| The network address to be filtered.
|-
|valign=top nowrap=true|'''IP6-Filter-Port:'''
| The port to be filtered out of the defined network address.
|-
|valign=top nowrap=true|'''Protocol:'''
| Protocol to which the filter is applied. UDP or TCP.
|}

Reference16r1:IP6/General/Routing

2026-06-25T11:39:11Z

Slu: Created page with "The '''routing''' table of the current IP configuration of the device is displayed here. The table is used for fault analysis by the network administrator. The table is structured as follows: {| |valign=top nowrap=true|'''Destination:''' | The destination network. |- |valign=top nowrap=true|'''Gateway:''' | The IP address of the router. |- |valign=top nowrap=true|'''Interface:''' | Displays the interface on which the route was created. Possible interfaces are: ''ETH0, '..."

The '''routing''' table of the current IP configuration of the device is displayed here. The table is used for fault analysis by the network administrator. The table is structured as follows:

{|
|valign=top nowrap=true|'''Destination:'''
| The destination network.
|-
|valign=top nowrap=true|'''Gateway:'''
| The IP address of the router.
|-
|valign=top nowrap=true|'''Interface:'''
| Displays the interface on which the route was created. Possible interfaces are: ''ETH0, ''ETH1, ''PPP0-31'', ''Local'' and ''ISDN''.
|-
|valign=top nowrap=true|'''Flag:'''
| Address flag.
|}

Reference16r1:IP4/General/Routing

2026-06-25T11:36:49Z

Slu: Created page with "The '''routing''' table of the current IP configuration of the device is displayed here. The table is used for fault analysis by the network administrator. The table is structured as follows: {| |valign=top nowrap=true|'''Destination Network:''' | The destination network address. |- |valign=top nowrap=true|'''Network Mask:''' | The associated network mask. |- |valign=top nowrap=true|'''Gateway:''' | The IP-Adresse of the router. |- |valign=top nowrap=true|'''Interface:'..."

The '''routing''' table of the current IP configuration of the device is displayed here. The table is used for fault analysis by the network administrator. The table is structured as follows:

{|
|valign=top nowrap=true|'''Destination Network:'''
| The destination network address.
|-
|valign=top nowrap=true|'''Network Mask:'''
| The associated network mask.
|-
|valign=top nowrap=true|'''Gateway:'''
| The IP-Adresse of the router.
|-
|valign=top nowrap=true|'''Interface:'''
| Displays the interface on which the route was created. Possible interfaces are: ''ETH0, ''ETH1, ''PPP0-31'', ''Local'' and ''ISDN''.
|-
|valign=top nowrap=true|'''State:'''
| Possible states are: ''Up'' or ''Down''.
|}

Reference16r1:Gateway/GK/GW

2026-06-24T06:17:57Z

Slu: /* Interface (VoIP Interfaces) */

Below is an overview of all the gateway's configurable VoIP interfaces:
* '''Interface:''' The name of the interface. Clicking this name opens a popup page, on which all settings can be made. The settings are described in more detail in the following chapter "[[#Interface .28VoIP Interfaces.29|Administration/Gateway/VOIP/Interface (VoIP interfaces)]]".
* '''CGPN In, CDPN In, CGPN Out, CDPN Out:''' Precise details on CGPN In, CDPN In, CGPN Out and CDPN Out mappings are contained in the chapter entitled "[[#CGPN.2FCDPN Mappings|Administration/Gateway/Interfaces/CGPN-CDPN Mappings]]" further up in the text.
* '''Registration:''' If a terminal has successfully registered with a gateway, then this is indicated in this column through specification of the IP address <Name of the VoIP interface:Call number:IP address>.

== Interface (VoIP Interfaces) ==
Clicking the relevant VoIP interface (GW1-12 <Name of the VoIP interface>) in the Interface column opens a popup page, on which the VoIP interfaces can be individually configured. Like the PBX objects, this popup page also contains standard entry fields that occur, more or less, in all VoIP interfaces.

These standard fields are:
* '''Name:''' The descriptive name of the VoIP interface.
* '''Disable:''' A checked check box disables the relevant VoIP interface.
* '''Protocol:''' The protocol to be used, that is, H.323 or SIP. Depending on which protocol is used, the set-up of the entry fields changes.
* '''Mode:''' Describes the mode of registration. Possible registration modes are:
# Gateway without Registration - Logs the VoIP interface (gateway) on to the configured gatekeeper without a registration.
# Register as Endpoint - Registers a VoIP terminal with the configured gatekeeper.
# Register as Gateway - Registers a VoIP gateway with the configured gatekeeper.
# Gatekeeper/Registrar - Is required for managing all gatekeeper registrations on a gateway. (is only visible when running in test-mode or if a gatekeeper license is available)
# ENUM - Is used to register an ENUM connection with the relevant interface.
* '''Gatekeeper Address (primary):''' The primary Gatekeeper IP address at which the terminal or gateway is to register via the relevant interface. Only necessary for modes 2 and 3. (IPv6 addresses must be enclosed in square brackets)
* '''Gatekeeper Address (secondary):''' The alternative gatekeeper IP address at which the terminal or gateway is to register via the relevant interface, if registration with the primary gatekeeper fails. Only necessary for modes 2 and 3. (IPv6 addresses must be enclosed in square brackets)
* '''Local Domain:''' Replaces the existing system/domain name (for H323 federation only).
* '''Mask:''' By specifying a network mask, incoming calls can be filtered. Specification of the network mask 255.255.0.0 therefore allows incoming calls on the relevant interface for terminals from the IP address range 192.168.0.0 - 192.168.255.255 .
* '''Gatekeeper Identifier:''' It is also sufficient to specify only the gatekeeper ID. Every gatekeeper in a network can be identified by means of its own gatekeeper ID, so that several gatekeepers can be operated in a network, with each terminal nevertheless identifying the correct gatekeeper by means of Gatekeeper Discovery (uses the multicast address 224.0.1.41).
* '''STUN SERVER:''' The STUN server name or IP address must be configured if this device has no public IP address while the SIP server is accessible under a public IP address. The value is given by the SIP provider or administrator (for example, stun.xten.com or 64.69.76.23). You can choose any STUN server; it does not necessarily have to correspond to the one of the SIP provider.
* '''Local Signalling Port:''' Signalling Port used by the Interface.
* '''SIP - Register as Gateway/Endpoint:'''
** '''Remote Domain (SIP Only):''' SIP Domain of the remote SIP Server to register (often equal to the SIP Proxy).
** '''Proxy (SIP Only):''' DNS name or IP address of the SIP proxy where SIP messages (REGISTER,INVITE,etc) are to be sent to. Proxy can be omitted if domain part of AOR can be used as remote signaling destination and it's set at Remote Domain.
* '''SIP - Gateway without Registration:'''
** '''Remote Domain (SIP Only):''' Check the Domain/IP Address on the SIP URI "FROM" field and removes it if match.
** '''Local Domain (SIP Only):''' Check the Domain/IP Address on the SIP URI "TO" field and removes it if match.
** '''Proxy (SIP Only):''' DNS name or IP address of the SIP proxy where SIP messages (INVITE,etc) are to be sent to, this field it's mandatory.
** '''Filter Incoming Calls (SIP Only):''' Accept Incoming Call on this interface only if the domain part of the "To:" field SIP URI matches the ''Local Domain'' configured. If not accepted, the call may still be accepted by another interface
* '''H323/TLS - Gateway without Registration
** '''Federation:''' Turns on open federation, which means the domain part of a destination name is used to look up the remote gateway in the DNS
** '''Veriyfy Cert:''' If set, the remote ceritficate on an incoming call is verified against the domain part of the source name

=== Authorization section ===
In the '''Authorization''' section, you can store a password for the VoIP interface.
* '''Password / Retype:''' The security of the registration can be raised by specifying a password (Password). The password must be confirmed (Retype).

=== Alias List section ===
In the '''Alias List''' section, you specify the call name (H.323) and the call number (E.164) of the relevant registration. For VoIP end points, you should define the assigned direct dialling number or MSN as the E.164 address, and the name as the H.323 name. For VoIP gateways it is sufficient to define the name.
* '''Name:''' The H.323 name.
* '''Number:''' The E.164 call number.

=== Coder Preferences section ===
The standard entry fields in the '''Coder Preferences''' section were already described in chapter "[[Reference:Administration/Gateway/Interfaces#Interface .28ISDN.2C SIP .26 virtual interfaces.29|Administration/Gateway/Interfaces/Interface (physical and virtual interfaces)]]".

=== Media Properties ===
The standard entry fields in the '''Media Properties''' section were already described [[{{NAMESPACE}}:Gateway/Interfaces/Media_Properties | Media Properties]].

=== H.323 Interop Tweaks section ===
In addition to the standard fields, several advanced settings are available in the '''H.323 Interop Tweaks''' section. They are normally not necessary and are merely used to solve compatibility problems with some PBXs:
* '''No Faststart:''' The H.245 faststart procedure is enabled as standard. Outgoing calls are made with faststart, incoming calls with faststart are answered with faststart. A checked check box disables the H.245 faststart procedure. Outgoing calls are made without faststart, incoming calls with and without faststart are answered without faststart.
* '''No H.245 Tunneling:''' The H.245 tunneling procedure is enabled as standard. The voice data connection is negotiated in the TCP signalling connection*) already available. This can be advantageous in connection with NAT and firewalls.
A checked check box disables the H.245 tunneling procedure, meaning that a separate TCP connection is set up for this negotiation. This applies to the signalling connection leading out of the gatekeeper.
* '''Suppress HLC:''' A checked check box disables the transmission of HLC (High Layer Compatibility) information elements.
* '''Suppress FTY:''' A checked check box disables the transmission of FTY (Facility) information elements.
* '''Suppress Subaddress:''' A checked check box disables the transmission of Subaddress information elements.
*) From a technical viewpoint, the H.245 protocol does not establish its own TCP connection,
but shares the H.225 TCP connection.

=== SIP Interop Tweaks section ===
Miscellaneous interoperability options for SIP.
{|
|valign=top nowrap=true|'''Proposed Registration Interval'''
|Set in seconds, default is 120 seconds
|-
|valign=top nowrap=true|'''Accept INVITE's from Anywhere'''
|If disabled, registered interfaces will reject INVITE's not coming from the SIP server with "305 Use Proxy".
|-
|valign=top nowrap=true|'''Enforce Sending Complete'''
|Affects handling of "484 Address Incomplete" responses. If enabled and "484 Address Incomplete" is received, the call is cleared. If not enabled and "484 Address Incomplete" is received, the call is retained and re-initiated in case of new dialing digits.
|-
|valign=top nowrap=true|'''No Video'''
|Removes Video Capabilities from outgoing media offer.
|-
|valign=top nowrap=true|'''No Early Media'''
|Ignore any SDP answer received before final connect response. (Affects only outgoing SIP calls)
|-
|valign=top nowrap=true|'''No Inband Information on Error'''
|Controls interworking of Q.931 DISC message. If this option is set, DISC message is always interworked into BYE request.
|-
|valign=top nowrap=true|'''No Inband Disconnect'''
|TBD.
|-
|valign=top nowrap=true|'''No Remote Hold Signaling'''
|Disables interworking of "inactive" into RemoteHold (affects connected SIP calls only).
|-
|valign=top nowrap=true|'''Take Refer-To URI as Remote Target URI'''
|If enabled: When REFER is received and transfer is executed by the Gateway application and a new INVITE is sent, the Request-URI of this INVITE matches the URI that has been received in Refer-To header in REFER. 
If not enabled: The Request-URI of the outgoing INVITE is created by usual means. Userpart of the Request-URI usually contains the CDPN as provided by Gateway application.
|-
|valign=top nowrap=true|'''To Header when Sending INVITE'''
|Affects only outgoing diverted calls . '''Called Party''': If set we write CDPN into To header of outgoing INVITE (and DGPN into History-Info header). '''Original Called Party''': If set we write the DGPN into To header of outgoing INVITE (and CDPN into Request-URI).
|-
|valign=top nowrap=true|'''From Header when Sending INVITE'''
|Controls the local URI (From header) of outgoing calls. Applys to registered interfaces only. '''Fixed AOR''': Fixed AOR is used as From-URI regardless of the actual calling party number. '''AOR with CGPN as Display''': Fixed AOR is used as From-URI and calling party number is added as display string. '''CGPN in user part of URI''': Variable From-URI with actual calling party number.
|-
|valign=top nowrap=true|'''Identity Header when Sending INVITE'''
|Controls the identity header (P-Preferred-Identity, P-Asserted-Identity and Remote-Party-Id). '''CGPN in user part of URI''': Variable From-URI with actual calling party number. '''Fixed AOR''': Fixed AOR is used as Identity-URI regardless of the actual calling party number.
|-
|valign=top nowrap=true|'''Reliability of Provisional Responses'''
|Controls the support of PRACK (RFC-3262). '''Supported''': Supported as optional extension. '''Required''': Required as mandatory extension. '''Disabled''': Hide support for PRACK extension.
|-
|valign=top nowrap=true|'''Microsoft Presence Format'''
|Enables special Microsoft Presence format/scheme, only used for SIP Federation with Lync 2013.
|}

== CGPN/CDPN Mappings ==
A detailed description may be found in the chapter entitled "[[Reference:Administration/Gateway/Interfaces#CGPN.2FCDPN Mappings|Administration/Gateway/Interface/CGPN-CDPN Mappings]]".

Reference16r1:Gateway/GK/GW

2026-06-24T06:16:12Z

Slu: Created page with "Below is an overview of all the gateway's configurable VoIP interfaces: * '''Interface:''' The name of the interface. Clicking this name opens a popup page, on which all settings can be made. The settings are described in more detail in the following chapter "Administration/Gateway/VOIP/Interface (VoIP interfaces)". * '''CGPN In, CDPN In, CGPN Out, CDPN Out:''' Precise details on CGPN In, CDPN In, CGPN Out and CDPN Out mappings are co..."

Below is an overview of all the gateway's configurable VoIP interfaces:
* '''Interface:''' The name of the interface. Clicking this name opens a popup page, on which all settings can be made. The settings are described in more detail in the following chapter "[[#Interface_.28VoIP_Interfaces.29|Administration/Gateway/VOIP/Interface (VoIP interfaces)]]".
* '''CGPN In, CDPN In, CGPN Out, CDPN Out:''' Precise details on CGPN In, CDPN In, CGPN Out and CDPN Out mappings are contained in the chapter entitled "[[#CGPN.2FCDPN_Mappings|Administration/Gateway/Interfaces/CGPN-CDPN Mappings]]" further up in the text.
* '''Registration:''' If a terminal has successfully registered with a gateway, then this is indicated in this column through specification of the IP address <Name of the VoIP interface:Call number:IP address>.

== Interface (VoIP Interfaces) ==
Clicking the relevant VoIP interface (GW1-12 <Name of the VoIP interface>) in the Interface column opens a popup page, on which the VoIP interfaces can be individually configured. Like the PBX objects, this popup page also contains standard entry fields that occur, more or less, in all VoIP interfaces.

These standard fields are:
* '''Name:''' The descriptive name of the VoIP interface.
* '''Disable:''' A checked check box disables the relevant VoIP interface.
* '''Protocol:''' The protocol to be used, that is, H.323 or SIP. Depending on which protocol is used, the set-up of the entry fields changes.
* '''Mode:''' Describes the mode of registration. Possible registration modes are:
# Gateway without Registration - Logs the VoIP interface (gateway) on to the configured gatekeeper without a registration.
# Register as Endpoint - Registers a VoIP terminal with the configured gatekeeper.
# Register as Gateway - Registers a VoIP gateway with the configured gatekeeper.
# Gatekeeper/Registrar - Is required for managing all gatekeeper registrations on a gateway. (is only visible when running in test-mode or if a gatekeeper license is available)
# ENUM - Is used to register an ENUM connection with the relevant interface.
* '''Gatekeeper Address (primary):''' The primary Gatekeeper IP address at which the terminal or gateway is to register via the relevant interface. Only necessary for modes 2 and 3.
* '''Gatekeeper Address (secondary):''' The alternative gatekeeper IP address at which the terminal or gateway is to register via the relevant interface, if registration with the primary gatekeeper fails. Only necessary for modes 2 and 3 .
* '''Local Domain:''' Replaces the existing system/domain name (for H323 federation only).
* '''Mask:''' By specifying a network mask, incoming calls can be filtered. Specification of the network mask 255.255.0.0 therefore allows incoming calls on the relevant interface for terminals from the IP address range 192.168.0.0 - 192.168.255.255 .
* '''Gatekeeper Identifier:''' It is also sufficient to specify only the gatekeeper ID. Every gatekeeper in a network can be identified by means of its own gatekeeper ID, so that several gatekeepers can be operated in a network, with each terminal nevertheless identifying the correct gatekeeper by means of Gatekeeper Discovery (uses the multicast address 224.0.1.41).
* '''STUN SERVER:''' The STUN server name or IP address must be configured if this device has no public IP address while the SIP server is accessible under a public IP address. The value is given by the SIP provider or administrator (for example, stun.xten.com or 64.69.76.23). You can choose any STUN server; it does not necessarily have to correspond to the one of the SIP provider.
* '''Local Signalling Port:''' Signalling Port used by the Interface.
* '''SIP - Register as Gateway/Endpoint:'''
** '''Remote Domain (SIP Only):''' SIP Domain of the remote SIP Server to register (often equal to the SIP Proxy).
** '''Proxy (SIP Only):''' DNS name or IP address of the SIP proxy where SIP messages (REGISTER,INVITE,etc) are to be sent to. Proxy can be omitted if domain part of AOR can be used as remote signaling destination and it's set at Remote Domain.
* '''SIP - Gateway without Registration:'''
** '''Remote Domain (SIP Only):''' Check the Domain/IP Address on the SIP URI "FROM" field and removes it if match.
** '''Local Domain (SIP Only):''' Check the Domain/IP Address on the SIP URI "TO" field and removes it if match.
** '''Proxy (SIP Only):''' DNS name or IP address of the SIP proxy where SIP messages (INVITE,etc) are to be sent to, this field it's mandatory.
** '''Filter Incoming Calls (SIP Only):''' Accept Incoming Call on this interface only if the domain part of the "To:" field SIP URI matches the ''Local Domain'' configured. If not accepted, the call may still be accepted by another interface
* '''H323/TLS - Gateway without Registration
** '''Federation:''' Turns on open federation, which means the domain part of a destination name is used to look up the remote gateway in the DNS
** '''Veriyfy Cert:''' If set, the remote ceritficate on an incoming call is verified against the domain part of the source name

=== Authorization section ===
In the '''Authorization''' section, you can store a password for the VoIP interface.
* '''Password / Retype:''' The security of the registration can be raised by specifying a password (Password). The password must be confirmed (Retype).

=== Alias List section ===
In the '''Alias List''' section, you specify the call name (H.323) and the call number (E.164) of the relevant registration. For VoIP end points, you should define the assigned direct dialling number or MSN as the E.164 address, and the name as the H.323 name. For VoIP gateways it is sufficient to define the name.
* '''Name:''' The H.323 name.
* '''Number:''' The E.164 call number.

=== Coder Preferences section ===
The standard entry fields in the '''Coder Preferences''' section were already described in chapter "[[Reference:Administration/Gateway/Interfaces#Interface_.28ISDN.2C_SIP_.26_virtual_interfaces.29|Administration/Gateway/Interfaces/Interface (physical and virtual interfaces)]]".

=== Media Properties ===
The standard entry fields in the '''Media Properties''' section were already described [[{{NAMESPACE}}:Gateway/Interfaces/Media_Properties | Media Properties]].

=== H.323 Interop Tweaks section ===
In addition to the standard fields, several advanced settings are available in the '''H.323 Interop Tweaks''' section. They are normally not necessary and are merely used to solve compatibility problems with some PBXs:
* '''No Faststart:''' The H.245 faststart procedure is enabled as standard. Outgoing calls are made with faststart, incoming calls with faststart are answered with faststart. A checked check box disables the H.245 faststart procedure. Outgoing calls are made without faststart, incoming calls with and without faststart are answered without faststart.
* '''No H.245 Tunneling:''' The H.245 tunneling procedure is enabled as standard. The voice data connection is negotiated in the TCP signalling connection*) already available. This can be advantageous in connection with NAT and firewalls.
A checked check box disables the H.245 tunneling procedure, meaning that a separate TCP connection is set up for this negotiation. This applies to the signalling connection leading out of the gatekeeper.
* '''Suppress HLC:''' A checked check box disables the transmission of HLC (High Layer Compatibility) information elements.
* '''Suppress FTY:''' A checked check box disables the transmission of FTY (Facility) information elements.
* '''Suppress Subaddress:''' A checked check box disables the transmission of Subaddress information elements.
*) From a technical viewpoint, the H.245 protocol does not establish its own TCP connection,
but shares the H.225 TCP connection.

=== SIP Interop Tweaks section ===
Miscellaneous interoperability options for SIP.
{|
|valign=top nowrap=true|'''Proposed Registration Interval'''
|Set in seconds, default is 120 seconds
|-
|valign=top nowrap=true|'''Accept INVITE's from Anywhere'''
|If disabled, registered interfaces will reject INVITE's not coming from the SIP server with "305 Use Proxy".
|-
|valign=top nowrap=true|'''Enforce Sending Complete'''
|Affects handling of "484 Address Incomplete" responses. If enabled and "484 Address Incomplete" is received, the call is cleared. If not enabled and "484 Address Incomplete" is received, the call is retained and re-initiated in case of new dialing digits.
|-
|valign=top nowrap=true|'''No Video'''
|Removes Video Capabilities from outgoing media offer.
|-
|valign=top nowrap=true|'''No Early Media'''
|Ignore any SDP answer received before final connect response. (Affects only outgoing SIP calls)
|-
|valign=top nowrap=true|'''No Inband Information on Error'''
|Controls interworking of Q.931 DISC message. If this option is set, DISC message is always interworked into BYE request.
|-
|valign=top nowrap=true|'''No Inband Disconnect'''
|TBD.
|-
|valign=top nowrap=true|'''No Remote Hold Signaling'''
|Disables interworking of "inactive" into RemoteHold (affects connected SIP calls only).
|-
|valign=top nowrap=true|'''Take Refer-To URI as Remote Target URI'''
|If enabled: When REFER is received and transfer is executed by the Gateway application and a new INVITE is sent, the Request-URI of this INVITE matches the URI that has been received in Refer-To header in REFER. 
If not enabled: The Request-URI of the outgoing INVITE is created by usual means. Userpart of the Request-URI usually contains the CDPN as provided by Gateway application.
|-
|valign=top nowrap=true|'''To Header when Sending INVITE'''
|Affects only outgoing diverted calls . '''Called Party''': If set we write CDPN into To header of outgoing INVITE (and DGPN into History-Info header). '''Original Called Party''': If set we write the DGPN into To header of outgoing INVITE (and CDPN into Request-URI).
|-
|valign=top nowrap=true|'''From Header when Sending INVITE'''
|Controls the local URI (From header) of outgoing calls. Applys to registered interfaces only. '''Fixed AOR''': Fixed AOR is used as From-URI regardless of the actual calling party number. '''AOR with CGPN as Display''': Fixed AOR is used as From-URI and calling party number is added as display string. '''CGPN in user part of URI''': Variable From-URI with actual calling party number.
|-
|valign=top nowrap=true|'''Identity Header when Sending INVITE'''
|Controls the identity header (P-Preferred-Identity, P-Asserted-Identity and Remote-Party-Id). '''CGPN in user part of URI''': Variable From-URI with actual calling party number. '''Fixed AOR''': Fixed AOR is used as Identity-URI regardless of the actual calling party number.
|-
|valign=top nowrap=true|'''Reliability of Provisional Responses'''
|Controls the support of PRACK (RFC-3262). '''Supported''': Supported as optional extension. '''Required''': Required as mandatory extension. '''Disabled''': Hide support for PRACK extension.
|-
|valign=top nowrap=true|'''Microsoft Presence Format'''
|Enables special Microsoft Presence format/scheme, only used for SIP Federation with Lync 2013.
|}

== CGPN/CDPN Mappings ==
A detailed description may be found in the chapter entitled "[[Reference:Administration/Gateway/Interfaces#CGPN.2FCDPN_Mappings|Administration/Gateway/Interface/CGPN-CDPN Mappings]]".

Howto:Innovaphones public services

2026-06-16T13:42:51Z

Slu: /* Services */

==Applies To==
This information applies to

* All versions

==Services==
Some services or products use a data connection to the vendor system. Innovaphone will provide his services from the following IP-networks:

46.232.228.0/26
213.144.10.192/29
141.95.57.16/28
185.145.188.12/32 # push NRW-RZ1
2a06:d840::12/128 # push NRW-RZ1

To configure your firewall accordingly, allow those entire networks as shown above. We suggest allowing traffic on the target DNS resolution eg. push.innovaphone.com.

=== STUN ===
[[Reference12r2:IP4/General/STUN|STUN Service]] for all customers
stun.innovaphone.com (udp/3478)

''Note: [http://wiki.innovaphone.com/index.php?title=Course13:IT_Advanced_2_-_07_Public_access_to_PBX_resources_%28practice%29#Media_data It is not a good idea to use innovaphone's STUN server. Although this server would yield the same results, there is no guarantee of availability. Your ISP or SIP provider's STUN should do better]''

=== TURN ===
[[Reference13r3:IP4/General/STUN#TURN Extern|TURN fallback service]] on port 443 for all customers
turn-fallback.innovaphone.com (tcp/443)

''Note: This TURN server shall only be used as 443 fallback server. It is not intended to be used as your [[Reference13r3:IP4/General/STUN#TURN Servers| regular TURN server]] as it is not designed as a primary TURN server. Do not use turn.innovaphone.com either.''

=== Provisioning ===
[[Reference13r1:Concept Provisioning|Provisioning System]] for all devices
config.innovaphone.com (tcp/http/https)

=== Push ===
[[Reference13r2:Concept Push Notifications for iOS and Android|Push]] for iOS, Android, Huawei and Browser Clients
push.innovaphone.com (tcp/https/wss)

=== Store ===
store.innovaphone.com (tcp/http/https)

=== Devices/Rental ===
my-app.innovaphone.com (tcp/https)

=== NTP ===
[[Reference13r1:Services/NTP|NTP Service]] for all customers
ntp.innovaphone.com (udp/123)

=== Remote Control Central ID service ===
[[Reference16r1:Concept App Remote Control#Central ID service server| Central ID service server]]
remotecontrol.innovaphone.com (tcp/https/wss)

=== Connector for Whatsapp ===
[[Reference16r1:Concept App Service Connector for Whatsapp| App Connector for Whatsapp]]
whatsapp.innovaphone.com (tcp/https/wss)

==Certificates==
innovaphone provides a public certificate download for used public keys.

* https://download.innovaphone.com/certificates/innovaphone.pem (the current innovaphone public key which will used for example for our push service)
* https://download.innovaphone.com/certificates/ca.pem (all innovaphone Device Certification Authority public keys)
* https://download.innovaphone.com/certificates/ca-unverified.pem (all innovaphone Unverified Device Certification Authority public keys)
** The Unverified CA is used for non hardware devices, e.g. IPVAs, which are not shipped with an official innovaphone Device Certification Authority certificate, as innovaphone has no control over the serial number here.

If needed, you can trust them manually or distribute them via [[Reference14r1:Concept App Service Devices#Certificates configuration|device's configuration]].

== Related Articles ==
* [[Reference13r2:Concept_Push_Notifications_for_iOS_and_Android]]
* [[Concept Status innovaphone Services]]
* [[Reference13r1:Concept_Provisioning]]
* [[Howto:Update_innovaphone.com_Wildcard-Certificate_in_a_Device_Trustlist]]

[[Category:Faq|{{PAGENAME}}]]

Howto:Innovaphones public services

2026-06-16T13:31:39Z

Slu: /* Services */

==Applies To==
This information applies to

* All versions

==Services==
Some services or products use a data connection to the vendor system. Innovaphone will provide his services from the following IP-networks:

46.232.228.0/26
213.144.10.192/29
141.95.57.16/28
45.133.189.205/32 # will be removed soon, push NRW-RZ1
2a0f:ff00:2001:366::21/128 # will be removed soon, push NRW-RZ1
185.145.188.12/32 # upcoming, push NRW-RZ1
2a06:d840::12/128 # upcoming, push NRW-RZ1

To configure your firewall accordingly, allow those entire networks as shown above. We suggest allowing traffic on the target DNS resolution eg. push.innovaphone.com.

=== STUN ===
[[Reference12r2:IP4/General/STUN|STUN Service]] for all customers
stun.innovaphone.com (udp/3478)

''Note: [http://wiki.innovaphone.com/index.php?title=Course13:IT_Advanced_2_-_07_Public_access_to_PBX_resources_%28practice%29#Media_data It is not a good idea to use innovaphone's STUN server. Although this server would yield the same results, there is no guarantee of availability. Your ISP or SIP provider's STUN should do better]''

=== TURN ===
[[Reference13r3:IP4/General/STUN#TURN Extern|TURN fallback service]] on port 443 for all customers
turn-fallback.innovaphone.com (tcp/443)

''Note: This TURN server shall only be used as 443 fallback server. It is not intended to be used as your [[Reference13r3:IP4/General/STUN#TURN Servers| regular TURN server]] as it is not designed as a primary TURN server. Do not use turn.innovaphone.com either.''

=== Provisioning ===
[[Reference13r1:Concept Provisioning|Provisioning System]] for all devices
config.innovaphone.com (tcp/http/https)

=== Push ===
[[Reference13r2:Concept Push Notifications for iOS and Android|Push]] for iOS, Android, Huawei and Browser Clients
push.innovaphone.com (tcp/https/wss)

=== Store ===
store.innovaphone.com (tcp/http/https)

=== Devices/Rental ===
my-app.innovaphone.com (tcp/https)

=== NTP ===
[[Reference13r1:Services/NTP|NTP Service]] for all customers
ntp.innovaphone.com (udp/123)

=== Remote Control Central ID service ===
[[Reference16r1:Concept App Remote Control#Central ID service server| Central ID service server]]
remotecontrol.innovaphone.com (tcp/https/wss)

=== Connector for Whatsapp ===
[[Reference16r1:Concept App Service Connector for Whatsapp| App Connector for Whatsapp]]
whatsapp.innovaphone.com (tcp/https/wss)

==Certificates==
innovaphone provides a public certificate download for used public keys.

* https://download.innovaphone.com/certificates/innovaphone.pem (the current innovaphone public key which will used for example for our push service)
* https://download.innovaphone.com/certificates/ca.pem (all innovaphone Device Certification Authority public keys)
* https://download.innovaphone.com/certificates/ca-unverified.pem (all innovaphone Unverified Device Certification Authority public keys)
** The Unverified CA is used for non hardware devices, e.g. IPVAs, which are not shipped with an official innovaphone Device Certification Authority certificate, as innovaphone has no control over the serial number here.

If needed, you can trust them manually or distribute them via [[Reference14r1:Concept App Service Devices#Certificates configuration|device's configuration]].

== Related Articles ==
* [[Reference13r2:Concept_Push_Notifications_for_iOS_and_Android]]
* [[Concept Status innovaphone Services]]
* [[Reference13r1:Concept_Provisioning]]
* [[Howto:Update_innovaphone.com_Wildcard-Certificate_in_a_Device_Trustlist]]

[[Category:Faq|{{PAGENAME}}]]

Howto:Innovaphones public services

2026-06-16T12:36:19Z

Slu: /* Services */

==Applies To==
This information applies to

* All versions

==Services==
Some services or products use a data connection to the vendor system. Innovaphone will provide his services from the following IP-networks:

46.232.228.0/26
213.144.10.192/29
141.95.57.16/28
45.133.189.205/32 # will be removed soon, push NRW-RZ1
2a0f:ff00:2001:366::21/128 # will be removed soon, push NRW-RZ1
185.145.188.12/32 # upcoming, push NRW-RZ1
2a06:d840::12/128 # upcoming, push NRW-RZ1

To configure your firewall accordingly, allow those entire networks as shown above.

=== STUN ===
[[Reference12r2:IP4/General/STUN|STUN Service]] for all customers
stun.innovaphone.com (udp/3478)

''Note: [http://wiki.innovaphone.com/index.php?title=Course13:IT_Advanced_2_-_07_Public_access_to_PBX_resources_%28practice%29#Media_data It is not a good idea to use innovaphone's STUN server. Although this server would yield the same results, there is no guarantee of availability. Your ISP or SIP provider's STUN should do better]''

=== TURN ===
[[Reference13r3:IP4/General/STUN#TURN_Extern |TURN fallback service ]] on port 443 for all customers
turn-fallback.innovaphone.com (tcp/443)

''Note: This TURN server shall only be used as 443 fallback server. It is not intended to be used as your [[Reference13r3:IP4/General/STUN#TURN_Servers | regular TURN server ]] as it is not designed as a primary TURN server. Do not use turn.innovaphone.com either.''

=== Provisioning ===
[[Reference13r1:Concept Provisioning|Provisioning System]] for all devices
config.innovaphone.com (tcp/http/https)

=== Push ===
[[Reference13r2:Concept_Push_Notifications_for_iOS_and_Android|Push]] for iOS, Android, Huawei and Browser Clients
push.innovaphone.com (tcp/https/wss)

=== Store ===
store.innovaphone.com (tcp/http/https)

=== Devices/Rental ===
my-app.innovaphone.com (tcp/https)

=== NTP ===
[[Reference13r1:Services/NTP|NTP Service]] for all customers
ntp.innovaphone.com (udp/123)

=== Remote Control Central ID service ===
[[Reference16r1:Concept_App_Remote_Control#Central_ID_service_server| Central ID service server]]
remotecontrol.innovaphone.com (tcp/https/wss)

=== Connector for Whatsapp ===
[[Reference16r1:Concept_App_Service_Connector_for_Whatsapp| App Connector for Whatsapp]]
whatsapp.innovaphone.com (tcp/https/wss)

==Certificates==
innovaphone provides a public certificate download for used public keys.

* https://download.innovaphone.com/certificates/innovaphone.pem (the current innovaphone public key which will used for example for our push service)
* https://download.innovaphone.com/certificates/ca.pem (all innovaphone Device Certification Authority public keys)
* https://download.innovaphone.com/certificates/ca-unverified.pem (all innovaphone Unverified Device Certification Authority public keys)
** The Unverified CA is used for non hardware devices, e.g. IPVAs, which are not shipped with an official innovaphone Device Certification Authority certificate, as innovaphone has no control over the serial number here.

If needed, you can trust them manually or distribute them via [[Reference14r1:Concept_App_Service_Devices#Certificates_configuration|device's configuration]].

== Related Articles ==
* [[Reference13r2:Concept_Push_Notifications_for_iOS_and_Android]]
* [[Concept Status innovaphone Services]]
* [[Reference13r1:Concept_Provisioning]]
* [[Howto:Update_innovaphone.com_Wildcard-Certificate_in_a_Device_Trustlist]]

[[Category:Faq|{{PAGENAME}}]]

Reference16r1:Apps/PbxManager/App Translations

2026-06-15T12:24:28Z

Slu:

With the translations PBX-Manager plugin, the needed app object can be created and configured.
In addition, the app object can be assigned to specific config templates, if any exist.

== Add an app object ==

;Name
:The ''name'' displayed for the app object which must be unique.

;SIP
:The ''sip'' from the app object which must be unique.

;Config Templates
:Enabled config templates where the App should be available.
:If config templates exist, they will be listed with a checkbox.
:The app object will be assigned to the config templates if a checkbox is checked. 
:'''Be Aware:''' Every user who should be able to use the translation service needs to have it assigned (by using a config template, for example).

=== Translations Service ===
Select the active translation backend.

=== DeepL ===
Specific https://www.deepl.com configuration

;URL
:The URL API Endpoint for the translation backend.
: If the field is empty, which is the default, the API endpoint will be selected automatically depending on the type of the key. If key ends with ":fx" the URL <code>https://api-free.deepl.com</code> is used, otherwise <code>https://api.deepl.com</code>

;API-Key
:The secret ''api-key''

=== eTranslation ===
Specific https://translation.ec.europa.eu/tools-and-resources/ai-translation-and-language-tools_en configuration

;Application Name
:The secret ''Application Name''

;Password
:The secret ''Password''

=== Custom LLM ===
Connects to any OpenAI API-compatible server, such as [https://ollama.com Ollama], vLLM, LM Studio, or a self-hosted model and interact with the endpoint <code>POST /v1/chat/completions</code>.

;Hostname
:The base URL of the server. The protocol prefix <code>https://</code> is assumed if omitted.
:Example: <code>https://ollama.example.com</code> or <code>ollama.example.com</code>
:Once a hostname is entered, the plugin automatically queries <code>{hostname}/v1/models</code> and populates the ''Model'' dropdown.

;Token
:Optional Bearer token sent as <code>Authorization: Bearer {token}</code> with every request to the inference server, including the model list query. Leave empty if the server does not require authentication.

;System Prompt
:The system prompt sent to the model with every translation request. Use <code>{LANG}</code> as a placeholder - it is replaced at runtime with the ISO target language code (e.g. <code>DE</code>, <code>EN-GB</code>).
:If left empty, the following default prompt is used:
You are a translation engine. Translate the user input into {LANG}.
Strictly follow all output rules:
- Return ONLY the translated content. No preamble, no explanations, no surrounding text of any kind.
- If the input contains HTML: preserve all tags, attributes, and structure unchanged; translate text nodes only.
- Never translate attribute values (href, src, class, id, style, data-*, etc.).
- Preserve proper nouns, brand names, and technical identifiers exactly as-is.
- Preserve whitespace, line breaks, and formatting exactly.
- Maintain the original tone and register (formal/informal).
- If the input is already in {LANG}, return it unchanged.

;Model
:Dropdown populated automatically from the models available on the configured host. Select the model to be used for translation requests.

;Temperature
:Define the parameter "temperature" in the LLM request. (Default 0.3)

;Max. Tokens
:Define the parameter "max_tokens" in the LLM request. (Default 65536)

;Enable Thinking
:Define the parameter "chat_template_kwargs.enable_thinking" in the LLM request. (Default false)

==Related Articles==
* [[{{NAMESPACE}}:Concept App Service Translations]]

[[Category:Concept App Service Translations]]

Reference16r1:Concept App Service Translations

2026-06-15T12:23:47Z

Slu:

[[Category:Concept|Apps]]
[[Category:Concept App Service Translations]]
== Overview ==
The idea of the translations app is to provide an interface for other apps to translate user content on-the-fly. So other apps can integrate the translation service via the [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm local JavaScript API] in the client and thus offer the user translated texts.

The service serves as a proxy and integrates a corresponding backend. For cloud services (DeepL, eTranslation) you need your own account and credentials. For Custom LLM, a self-hosted OpenAI API-compatible inference server is used instead.

== Supported translation services ==
You can configure multiple translation backends and switch between them.

=== DeepL ===
This interface uses the https:///www.deepl.com translation API.

This interface is used as the default interface. you dont must provide an ''API-URL'' in the [[Reference16r1:Apps/PbxManager/App Translations|Settings]]. A custom API-URL is only for a local version with the same API interface.

;Privacy
:API Free: https://www.deepl.com/de/privacy#section_12
:API Pro: https://www.deepl.com/de/privacy#section_5
;Cost model and Pricing
:Pay per character (To save costs, the app service offers a cache to avoid multiple translations)
:https://www.deepl.com/de/pro#developer

==== Technical Concept ====

* The DeepL API is a synchronous HTTP flow. This means that we request a translation and get an instant response with the translation.
* Outgoing HTTP(S) request to the DeepL API
* If you not override the URL, it is used HTTPS only

=== EU - eTranslation ===
This interface uses the EU service eTranslation.

European Commission’s free and secure AI language tools: https://translation.ec.europa.eu/tools-and-resources/ai-translation-and-language-tools_en

Technical Documentation: https://language-tools.ec.europa.eu/dev-corner/etranslation/rest-v2/text

==== Technical Concept ====
* The EU-eTranslation uses an asynchronous HTTP flow with webhooks to deliver processed translations
* Translation flow
*# On every app startup
*## a dynamic user / password combination is created, which will be used for later secure incoming webhooks
*### Example: <code>23bcf2fd / 19ccf70b-028c-e7a8-94eb-1ad7db91d4c8</code>
*## the own app url is generated from the current environment
*### Example: <code><nowiki>https://23bcf2fd:19ccf70b-028c-e7a8-94eb-1ad7db91d4c8@apps.slu.de/slu.de/translations/webhook-basicauth</nowiki></code>
*# Outgoing HTTPS request to the eTranslation Service. The translation job will be queued. As additional information in the job, a callback webhook URL with a username and password will be placed.
*# If the processing is finished, a webhook to the app is delivered via HTTPS
*# The job result will be processed and delivered back to the user that has requested the translation
==== Limitations ====
* 50 concurrent translation requests
* 5.000 characters per translation

=== Custom LLM ===
This interface connects to any OpenAI API-compatible server, such as [https://ollama.com Ollama], vLLM, or LM Studio.

;Privacy
:Depends on the operator of the server. No data is sent to third parties.
;Cost model
:Depends on the operator of the inference server.

==== Technical Concept ====
* Synchronous HTTP flow - a translation request is sent and the response is returned immediately
* Outgoing HTTPS request to the configured server
* The available models are queried via <code>GET /v1/models</code> in the [[Reference17:Apps/PbxManager/App Translations|settings plugin]]
* Optional performance options, authentication options, and the system prompt can be configured in the [[Reference17:Apps/PbxManager/App Translations|settings plugin]]
* Translation requests are sent as <code>POST /v1/chat/completions</code>
* The system prompt uses <code>{LANG}</code> as a placeholder for the ISO target language code

== Licensing ==
No license needed

== Installation ==
Go to the PBX manager and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown.
* In the search field located on the top right corner of the store, search for '''"Translations"''' and click on it
* Select the proper firmware version and click on install
* Close and open the PBX manager to refresh the list of the available colored AP plugin
* Click on the '''"AP Translations"''' and click on '''" + Add an App"'''
* Enter a '''"Name"''' that is used as the display name ''(all characters allowed)'' for it and the '''"SIP"''' name that is the administrative field ''(no space, no capital letters)''. ''e.g : Name: Translations, SIP: translations''
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the translation API)
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

== Translation - Client ==
There is no view/app that the user can explicitly open. The service runs in the background and has no UI and can be integrated by other apps. In order for the user to have access to the translation service, their user object must have access to the app object of the translations app.

The client side of the app service receives requests from all other apps via the local JavaScript API and sends them to the service. The result of the request is returned to the original app via the local JavaScript API

== Translation - App Service ==
The App Service performs tasks in the following areas:
* Language recognition
* Caching
* Translations against the backend (deepl.com)

=== Language recognition ===
An offline API is offered to recognize the language used in a string. This recognition is also used for translations to avoid unnecessary translations (e.g. EN to EN translations are prevented). This payload will not be sent to any backend service, thus avoiding unnecessary costs. A few features exist which should make sure, a recognized language is only considered, if there is enough confidence:
* Strings shorter than 6 words are skipped, since the chance for false positives are relatively high
* Strings in which there are not enough word matches to be confident for any language will be skipped, also because of high chances for false positives
* Strings that are more than one language with a nearly similar amount of word matches will be skipped

Supported languages: cs, de, en-gb, es, fr, it, nl, pl, pt-pt, ro, ru, sl, tr

=== Caching ===
To save costs, all translations are cached in the App Services database. If a string is translated multiple times, only the first translation is carried out by the backend, and the translated version is saved in the cache. A second translation is therefore free of charge and performs better.

=== Translations against the backend ===
Translation requests that cannot be handled by the local cache are forwarded to the configured translation backend. After successful translation, the translated version is kept in the cache for future requests.

The list of supported languages depends on the supported languages of the used [https://developers.deepl.com/docs/resources/supported-languages#target-languages service provider]. It will be read from the service provider each time the Translations App Service starts.

=== Charts Statistics ===
The app service will provide telemetry data to the integrated Charts app service.

;requestTranslate
:Translation requests (default) to the App Service
;requestTranslateAll
:TranslationAll requests to the App Service
;requestWebhookBasic
:Webhooks from external translations backend with legacy BasicAuth to the App Service
;requestWebhook
:Webhooks from external translations backend to the App Service
;DetectLanguagePreventTranslation
:Amount of translation requests that are not processed because language detection detected same languages
;CacheAdd
:New translation payload is stored in the cache
;CacheHit
:Translation request is solved by existing cache entry
;DeepL
:External backend request
;eTranslation
:External backend request

== Troubleshooting ==

To troubleshoot this App Service, you need the traceflags ''App'', ''Database'', ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm SDK Documentation - Translation API]
* [[{{NAMESPACE}}:Apps/PbxManager/App_Translations]]

Reference17:Apps/PbxManager/App Translations

2026-06-09T08:08:52Z

Slu: /* Custom LLM */

Reference17:Concept App Service Translations

2026-06-09T07:57:45Z

Slu: /* Technical Concept */

Reference17:Apps/PbxManager/App Translations

2026-06-02T11:48:47Z

Slu: /* Custom LLM */

With the translations PBX-Manager plugin, the needed app object can be created and configured.
In addition, the app object can be assigned to specific config templates, if any exist.

== Add an app object ==

;Name
:The ''name'' displayed for the app object which must be unique.

;SIP
:The ''sip'' from the app object which must be unique.

;Config Templates
:Enabled config templates where the App should be available.
:If config templates exist, they will be listed with a checkbox.
:The app object will be assigned to the config templates if a checkbox is checked. 
:'''Be Aware:''' Every user who should be able to use the translation service needs to have it assigned (by using a config template, for example).

=== Translations Service ===
Select the active translation backend.

=== DeepL ===
Specific https://www.deepl.com configuration

;URL
:The URL API Endpoint for the translation backend.
: If the field is empty, which is the default, the API endpoint will be selected automatically depending on the type of the key. If key ends with ":fx" the URL <code>https://api-free.deepl.com</code> is used, otherwise <code>https://api.deepl.com</code>

;API-Key
:The secret ''api-key''

=== eTranslation ===
Specific https://translation.ec.europa.eu/tools-and-resources/ai-translation-and-language-tools_en configuration

;Application Name
:The secret ''Application Name''

;Password
:The secret ''Password''

=== Custom LLM ===
Connects to any OpenAI API-compatible server, such as [https://ollama.com Ollama], vLLM, LM Studio, or a self-hosted model and interact with the endpoint <code>POST /v1/chat/completions</code>.

;Hostname
:The base URL of the server. The protocol prefix <code>https://</code> is assumed if omitted.
:Example: <code>https://ollama.example.com</code> or <code>ollama.example.com</code>
:Once a hostname is entered, the plugin automatically queries <code>{hostname}/v1/models</code> and populates the ''Model'' dropdown.

;Token
:Optional Bearer token sent as <code>Authorization: Bearer {token}</code> with every request to the inference server, including the model list query. Leave empty if the server does not require authentication.

;System Prompt
:The system prompt sent to the model with every translation request. Use <code>{LANG}</code> as a placeholder - it is replaced at runtime with the ISO target language code (e.g. <code>DE</code>, <code>EN-GB</code>).
:If left empty, the following default prompt is used:
You are a translation engine. Translate the user input into {LANG}.
Strictly follow all output rules:
- Return ONLY the translated content. No preamble, no explanations, no surrounding text of any kind.
- If the input contains HTML: preserve all tags, attributes, and structure unchanged; translate text nodes only.
- Never translate attribute values (href, src, class, id, style, data-*, etc.).
- Preserve proper nouns, brand names, and technical identifiers exactly as-is.
- Preserve whitespace, line breaks, and formatting exactly.
- Maintain the original tone and register (formal/informal).
- If the input is already in {LANG}, return it unchanged.

;Model
:Dropdown populated automatically from the models available on the configured host. Select the model to be used for translation requests.

==Related Articles==
* [[{{NAMESPACE}}:Concept App Service Translations]]

[[Category:Concept App Service Translations]]

Reference17:Concept App Service Translations

2026-06-02T10:23:12Z

Slu: /* EU - eTranslation */

[[Category:Concept|Apps]]
[[Category:Concept App Service Translations]]
== Overview ==
The idea of the translations app is to provide an interface for other apps to translate user content on-the-fly. So other apps can integrate the translation service via the [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm local JavaScript API] in the client and thus offer the user translated texts.

The service serves as a proxy and integrates a corresponding backend. For cloud services (DeepL, eTranslation) you need your own account and credentials. For Custom LLM, a self-hosted OpenAI API-compatible inference server is used instead.

== Supported translation services ==
You can configure multiple translation backends and switch between them.

=== DeepL ===
This interface uses the https:///www.deepl.com translation API.

This interface is used as the default interface. you dont must provide an ''API-URL'' in the [[Reference16r1:Apps/PbxManager/App Translations|Settings]]. A custom API-URL is only for a local version with the same API interface.

;Privacy
:API Free: https://www.deepl.com/de/privacy#section_12
:API Pro: https://www.deepl.com/de/privacy#section_5
;Cost model and Pricing
:Pay per character (To save costs, the app service offers a cache to avoid multiple translations)
:https://www.deepl.com/de/pro#developer

==== Technical Concept ====

* The DeepL API is a synchronous HTTP flow. This means that we request a translation and get an instant response with the translation.
* Outgoing HTTP(S) request to the DeepL API
* If you not override the URL, it is used HTTPS only

=== EU - eTranslation ===
This interface uses the EU service eTranslation.

European Commission’s free and secure AI language tools: https://translation.ec.europa.eu/tools-and-resources/ai-translation-and-language-tools_en

Technical Documentation: https://language-tools.ec.europa.eu/dev-corner/etranslation/rest-v2/text

==== Technical Concept ====
* The EU-eTranslation uses an asynchronous HTTP flow with webhooks to deliver processed translations
* Translation flow
*# On every app startup
*## a dynamic user / password combination is created, which will be used for later secure incoming webhooks
*### Example: <code>23bcf2fd / 19ccf70b-028c-e7a8-94eb-1ad7db91d4c8</code>
*## the own app url is generated from the current environment
*### Example: <code><nowiki>https://23bcf2fd:19ccf70b-028c-e7a8-94eb-1ad7db91d4c8@apps.slu.de/slu.de/translations/webhook-basicauth</nowiki></code>
*# Outgoing HTTPS request to the eTranslation Service. The translation job will be queued. As additional information in the job, a callback webhook URL with a username and password will be placed.
*# If the processing is finished, a webhook to the app is delivered via HTTPS
*# The job result will be processed and delivered back to the user that has requested the translation
==== Limitations ====
* 50 concurrent translation requests
* 5.000 characters per translation

=== Custom LLM ===
This interface connects to any OpenAI API-compatible server, such as [https://ollama.com Ollama], vLLM, or LM Studio.

;Privacy
:Depends on the operator of the server. No data is sent to third parties.
;Cost model
:Depends on the operator of the inference server.

==== Technical Concept ====
* Synchronous HTTP flow - a translation request is sent and the response is returned immediately
* Outgoing HTTPS request to the configured server
* The available models are queried via <code>GET /v1/models</code> in the settings plugin
* Translation requests are sent as <code>POST /v1/chat/completions</code> with an editable system prompt
* The system prompt uses <code>{LANG}</code> as a placeholder for the ISO target language code
* An optional Bearer token can be configured for servers that require authentication

== Licensing ==
No license needed

== Installation ==
Go to the PBX manager and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown.
* In the search field located on the top right corner of the store, search for '''"Translations"''' and click on it
* Select the proper firmware version and click on install
* Close and open the PBX manager to refresh the list of the available colored AP plugin
* Click on the '''"AP Translations"''' and click on '''" + Add an App"'''
* Enter a '''"Name"''' that is used as the display name ''(all characters allowed)'' for it and the '''"SIP"''' name that is the administrative field ''(no space, no capital letters)''. ''e.g : Name: Translations, SIP: translations''
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the translation API)
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

== Translation - Client ==
There is no view/app that the user can explicitly open. The service runs in the background and has no UI and can be integrated by other apps. In order for the user to have access to the translation service, their user object must have access to the app object of the translations app.

The client side of the app service receives requests from all other apps via the local JavaScript API and sends them to the service. The result of the request is returned to the original app via the local JavaScript API

== Translation - App Service ==
The App Service performs tasks in the following areas:
* Language recognition
* Caching
* Translations against the backend (deepl.com)

=== Language recognition ===
An offline API is offered to recognize the language used in a string. This recognition is also used for translations to avoid unnecessary translations (e.g. EN to EN translations are prevented). This payload will not be sent to any backend service, thus avoiding unnecessary costs. A few features exist which should make sure, a recognized language is only considered, if there is enough confidence:
* Strings shorter than 6 words are skipped, since the chance for false positives are relatively high
* Strings in which there are not enough word matches to be confident for any language will be skipped, also because of high chances for false positives
* Strings that are more than one language with a nearly similar amount of word matches will be skipped

Supported languages: cs, de, en-gb, es, fr, it, nl, pl, pt-pt, ro, ru, sl, tr

=== Caching ===
To save costs, all translations are cached in the App Services database. If a string is translated multiple times, only the first translation is carried out by the backend, and the translated version is saved in the cache. A second translation is therefore free of charge and performs better.

=== Translations against the backend ===
Translation requests that cannot be handled by the local cache are forwarded to the configured translation backend. After successful translation, the translated version is kept in the cache for future requests.

The list of supported languages depends on the supported languages of the used [https://developers.deepl.com/docs/resources/supported-languages#target-languages service provider]. It will be read from the service provider each time the Translations App Service starts.

=== Charts Statistics ===
The app service will provide telemetry data to the integrated Charts app service.

;requestTranslate
:Translation requests (default) to the App Service
;requestTranslateAll
:TranslationAll requests to the App Service
;requestWebhookBasic
:Webhooks from external translations backend with legacy BasicAuth to the App Service
;requestWebhook
:Webhooks from external translations backend to the App Service
;DetectLanguagePreventTranslation
:Amount of translation requests that are not processed because language detection detected same languages
;CacheAdd
:New translation payload is stored in the cache
;CacheHit
:Translation request is solved by existing cache entry
;DeepL
:External backend request
;eTranslation
:External backend request

== Troubleshooting ==

To troubleshoot this App Service, you need the traceflags ''App'', ''Database'', ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm SDK Documentation - Translation API]
* [[{{NAMESPACE}}:Apps/PbxManager/App_Translations]]

Reference17:Concept App Service Translations

2026-06-02T10:11:41Z

Slu: /* Overview */

[[Category:Concept|Apps]]
[[Category:Concept App Service Translations]]
== Overview ==
The idea of the translations app is to provide an interface for other apps to translate user content on-the-fly. So other apps can integrate the translation service via the [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm local JavaScript API] in the client and thus offer the user translated texts.

The service serves as a proxy and integrates a corresponding backend. For cloud services (DeepL, eTranslation) you need your own account and credentials. For Custom LLM, a self-hosted OpenAI API-compatible inference server is used instead.

== Supported translation services ==
You can configure multiple translation backends and switch between them.

=== DeepL ===
This interface uses the https:///www.deepl.com translation API.

This interface is used as the default interface. you dont must provide an ''API-URL'' in the [[Reference16r1:Apps/PbxManager/App Translations|Settings]]. A custom API-URL is only for a local version with the same API interface.

;Privacy
:API Free: https://www.deepl.com/de/privacy#section_12
:API Pro: https://www.deepl.com/de/privacy#section_5
;Cost model and Pricing
:Pay per character (To save costs, the app service offers a cache to avoid multiple translations)
:https://www.deepl.com/de/pro#developer

==== Technical Concept ====

* The DeepL API is a synchronous HTTP flow. This means that we request a translation and get an instant response with the translation.
* Outgoing HTTP(S) request to the DeepL API
* If you not override the URL, it is used HTTPS only

=== EU - eTranslation ===
This interface uses the EU service eTranslation.

European Commission’s free and secure AI language tools: https://translation.ec.europa.eu/tools-and-resources/ai-translation-and-language-tools_en

Technical Documentation: https://language-tools.ec.europa.eu/dev-corner/etranslation/rest-v2/text

==== Technical Concept ====
* The EU-eTranslation uses an asynchronous HTTP flow with webhooks to deliver processed translations
* Translation flow
*# On every app startup
*## a dynamic user / password combination is created, which will be used for later secure incoming webhooks
*### Example: <code>23bcf2fd / 19ccf70b-028c-e7a8-94eb-1ad7db91d4c8</code>
*## the own app url is generated from the current environment
*### Example: <code><nowiki>https://23bcf2fd:19ccf70b-028c-e7a8-94eb-1ad7db91d4c8@apps.slu.de/slu.de/translations/webhook-basicauth</nowiki></code>
*# Outgoing HTTPS request to the eTranslation Service. The translation job will be queued. As additional information in the job, a callback webhook URL with a username and password will be placed.
*# If the processing is finished, a webhook to the app is delivered via HTTPS
*# The job result will be processed and delivered back to the user that has requested the translation
==== Limitations ====
* 50 concurrent translation requests
* 5.000 characters per translation

== Licensing ==
No license needed

== Installation ==
Go to the PBX manager and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown.
* In the search field located on the top right corner of the store, search for '''"Translations"''' and click on it
* Select the proper firmware version and click on install
* Close and open the PBX manager to refresh the list of the available colored AP plugin
* Click on the '''"AP Translations"''' and click on '''" + Add an App"'''
* Enter a '''"Name"''' that is used as the display name ''(all characters allowed)'' for it and the '''"SIP"''' name that is the administrative field ''(no space, no capital letters)''. ''e.g : Name: Translations, SIP: translations''
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the translation API)
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

== Translation - Client ==
There is no view/app that the user can explicitly open. The service runs in the background and has no UI and can be integrated by other apps. In order for the user to have access to the translation service, their user object must have access to the app object of the translations app.

The client side of the app service receives requests from all other apps via the local JavaScript API and sends them to the service. The result of the request is returned to the original app via the local JavaScript API

== Translation - App Service ==
The App Service performs tasks in the following areas:
* Language recognition
* Caching
* Translations against the backend (deepl.com)

=== Language recognition ===
An offline API is offered to recognize the language used in a string. This recognition is also used for translations to avoid unnecessary translations (e.g. EN to EN translations are prevented). This payload will not be sent to any backend service, thus avoiding unnecessary costs. A few features exist which should make sure, a recognized language is only considered, if there is enough confidence:
* Strings shorter than 6 words are skipped, since the chance for false positives are relatively high
* Strings in which there are not enough word matches to be confident for any language will be skipped, also because of high chances for false positives
* Strings that are more than one language with a nearly similar amount of word matches will be skipped

Supported languages: cs, de, en-gb, es, fr, it, nl, pl, pt-pt, ro, ru, sl, tr

=== Caching ===
To save costs, all translations are cached in the App Services database. If a string is translated multiple times, only the first translation is carried out by the backend, and the translated version is saved in the cache. A second translation is therefore free of charge and performs better.

=== Translations against the backend ===
Translation requests that cannot be handled by the local cache are forwarded to the configured translation backend. After successful translation, the translated version is kept in the cache for future requests.

The list of supported languages depends on the supported languages of the used [https://developers.deepl.com/docs/resources/supported-languages#target-languages service provider]. It will be read from the service provider each time the Translations App Service starts.

=== Charts Statistics ===
The app service will provide telemetry data to the integrated Charts app service.

;requestTranslate
:Translation requests (default) to the App Service
;requestTranslateAll
:TranslationAll requests to the App Service
;requestWebhookBasic
:Webhooks from external translations backend with legacy BasicAuth to the App Service
;requestWebhook
:Webhooks from external translations backend to the App Service
;DetectLanguagePreventTranslation
:Amount of translation requests that are not processed because language detection detected same languages
;CacheAdd
:New translation payload is stored in the cache
;CacheHit
:Translation request is solved by existing cache entry
;DeepL
:External backend request
;eTranslation
:External backend request

== Troubleshooting ==

To troubleshoot this App Service, you need the traceflags ''App'', ''Database'', ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm SDK Documentation - Translation API]
* [[{{NAMESPACE}}:Apps/PbxManager/App_Translations]]

Reference17:Apps/PbxManager/App Translations

2026-06-02T10:09:05Z

Slu: /* DeepL */

With the translations PBX-Manager plugin, the needed app object can be created and configured.
In addition, the app object can be assigned to specific config templates, if any exist.

== Add an app object ==

;Name
:The ''name'' displayed for the app object which must be unique.

;SIP
:The ''sip'' from the app object which must be unique.

;Config Templates
:Enabled config templates where the App should be available.
:If config templates exist, they will be listed with a checkbox.
:The app object will be assigned to the config templates if a checkbox is checked. 
:'''Be Aware:''' Every user who should be able to use the translation service needs to have it assigned (by using a config template, for example).

=== Translations Service ===
Select the active translation backend.

=== DeepL ===
Specific https://www.deepl.com configuration

;URL
:The URL API Endpoint for the translation backend.
: If the field is empty, which is the default, the API endpoint will be selected automatically depending on the type of the key. If key ends with ":fx" the URL <code>https://api-free.deepl.com</code> is used, otherwise <code>https://api.deepl.com</code>

;API-Key
:The secret ''api-key''

=== eTranslation ===
Specific https://translation.ec.europa.eu/tools-and-resources/ai-translation-and-language-tools_en configuration

;Application Name
:The secret ''Application Name''

;Password
:The secret ''Password''

=== Custom LLM ===
Connects to any OpenAI API-compatible server, such as [https://ollama.com Ollama], vLLM, LM Studio, or a self-hosted model and interact with the endpoint <code>POST /v1/chat/completions</code>.

;Hostname
:The base URL of the server. The protocol prefix <code>https://</code> is assumed if omitted.
:Example: <code>https://ollama.example.com</code> or <code>ollama.example.com</code>
:Once a hostname is entered, the plugin automatically queries <code>{hostname}/v1/models</code> and populates the ''Model'' dropdown.

;Token
:Optional Bearer token sent as <code>Authorization: Bearer {token}</code> with every request to the inference server, including the model list query. Leave empty if the server does not require authentication.

;System Prompt
:The system prompt sent to the model with every translation request. Use <code>{LANG}</code> as a placeholder - it is replaced at runtime with the ISO target language code (e.g. <code>DE</code>, <code>EN-GB</code>).
:If left empty, the following default prompt is used: <code>You are a translation assistant. Translate the following text to {LANG}. Return only the translated text, with no explanations or additional content.</code>

;Model
:Dropdown populated automatically from the models available on the configured host. Select the model to be used for translation requests.

==Related Articles==
* [[{{NAMESPACE}}:Concept App Service Translations]]

[[Category:Concept App Service Translations]]

Reference17:Apps/PbxManager/App Translations

2026-06-02T09:50:50Z

Slu: /* Custom LLM */

With the translations PBX-Manager plugin, the needed app object can be created and configured.
In addition, the app object can be assigned to specific config templates, if any exist.

== Add an app object ==

;Name
:The ''name'' displayed for the app object which must be unique.

;SIP
:The ''sip'' from the app object which must be unique.

;Config Templates
:Enabled config templates where the App should be available.
:If config templates exist, they will be listed with a checkbox.
:The app object will be assigned to the config templates if a checkbox is checked. 
:'''Be Aware:''' Every user who should be able to use the translation service needs to have it assigned (by using a config template, for example).

=== Translations Service ===
Select the active translation backend.

=== DeepL ===
Specific https://www.deepl.com configuration

;URL
:The URL API Endpoint for the translation backend.
: If the field is empty, which is the default, the API endpoint will be selected automatically depending on the type of the key. If key ends with ":fx" the URL <code>https://api-free.deepl.com</code> is used, otherwhise <code>https://api.deepl.com</code>

;API-Key
:The secret ''api-key''

=== eTranslation ===
Specific https://translation.ec.europa.eu/tools-and-resources/ai-translation-and-language-tools_en configuration

;Application Name
:The secret ''Application Name''

;Password
:The secret ''Password''

=== Custom LLM ===
Connects to any OpenAI API-compatible server, such as [https://ollama.com Ollama], vLLM, LM Studio, or a self-hosted model and interact with the endpoint <code>POST /v1/chat/completions</code>.

;Hostname
:The base URL of the server. The protocol prefix <code>https://</code> is assumed if omitted.
:Example: <code>https://ollama.example.com</code> or <code>ollama.example.com</code>
:Once a hostname is entered, the plugin automatically queries <code>{hostname}/v1/models</code> and populates the ''Model'' dropdown.

;Token
:Optional Bearer token sent as <code>Authorization: Bearer {token}</code> with every request to the inference server, including the model list query. Leave empty if the server does not require authentication.

;System Prompt
:The system prompt sent to the model with every translation request. Use <code>{LANG}</code> as a placeholder - it is replaced at runtime with the ISO target language code (e.g. <code>DE</code>, <code>EN-GB</code>).
:If left empty, the following default prompt is used: <code>You are a translation assistant. Translate the following text to {LANG}. Return only the translated text, with no explanations or additional content.</code>

;Model
:Dropdown populated automatically from the models available on the configured host. Select the model to be used for translation requests.

==Related Articles==
* [[{{NAMESPACE}}:Concept App Service Translations]]

[[Category:Concept App Service Translations]]

Reference17:Apps/PbxManager/App Translations

2026-06-02T09:49:13Z

Slu: /* Translations Service */

With the translations PBX-Manager plugin, the needed app object can be created and configured.
In addition, the app object can be assigned to specific config templates, if any exist.

== Add an app object ==

;Name
:The ''name'' displayed for the app object which must be unique.

;SIP
:The ''sip'' from the app object which must be unique.

;Config Templates
:Enabled config templates where the App should be available.
:If config templates exist, they will be listed with a checkbox.
:The app object will be assigned to the config templates if a checkbox is checked. 
:'''Be Aware:''' Every user who should be able to use the translation service needs to have it assigned (by using a config template, for example).

=== Translations Service ===
Select the active translation backend.

=== DeepL ===
Specific https://www.deepl.com configuration

;URL
:The URL API Endpoint for the translation backend.
: If the field is empty, which is the default, the API endpoint will be selected automatically depending on the type of the key. If key ends with ":fx" the URL <code>https://api-free.deepl.com</code> is used, otherwhise <code>https://api.deepl.com</code>

;API-Key
:The secret ''api-key''

=== eTranslation ===
Specific https://translation.ec.europa.eu/tools-and-resources/ai-translation-and-language-tools_en configuration

;Application Name
:The secret ''Application Name''

;Password
:The secret ''Password''

=== Custom LLM ===
Connects to any OpenAI API-compatible server, such as [https://ollama.com Ollama], vLLM, LM Studio, or a self-hosted model.

;Hostname
:The base URL of the server. The protocol prefix <code>https://</code> is assumed if omitted.
:Example: <code>https://ollama.example.com</code> or <code>ollama.example.com</code>
:Once a hostname is entered, the plugin automatically queries <code>{hostname}/v1/models</code> and populates the ''Model'' dropdown.

;Token
:Optional Bearer token sent as <code>Authorization: Bearer {token}</code> with every request to the inference server, including the model list query. Leave empty if the server does not require authentication.

;System Prompt
:The system prompt sent to the model with every translation request. Use <code>{LANG}</code> as a placeholder - it is replaced at runtime with the ISO target language code (e.g. <code>DE</code>, <code>EN-GB</code>).
:If left empty, the following default prompt is used: <code>You are a translation assistant. Translate the following text to {LANG}. Return only the translated text, with no explanations or additional content.</code>

;Model
:Dropdown populated automatically from the models available on the configured host. Select the model to be used for translation requests.

:'''Note:''' Translation requests are sent as <code>POST /v1/chat/completions</code> to the configured host. The model receives a system prompt instructing it to translate the input text to the target language and return only the translated result.

==Related Articles==
* [[{{NAMESPACE}}:Concept App Service Translations]]

[[Category:Concept App Service Translations]]