PUM

Description

This module installs the PUM functionality. PUM stands for Personal User Mobility and allows users to login on a phone and have their personal profile activated on this IP Phone (extensions, speeddials, caller name, caller id, voicemail access, ...)

Release notes

Show release notes
Version 3.6.1 - Early deployment
  • Bugfix: login failed when pincode is stored in an admin var (PC-4294)
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (for active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (for cluster configuration only)
    • SOP API v2.9 or higher
    • Sounds v1.8.0 or higher
    • SOP Base v1.4.5 or higher (Recommended v1.5.3 or higher)
    • System Base v1.5.0 or higher
    • TFTP Server 3.1.6 or higher

Version 3.6.0 - Early deployment
  • Improvement: Converted to debian packaging (M23654)
  • Bugfix: Fixed dependencies issues causing both login and logout to fail (M23936)
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (for active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (for cluster configuration only)
    • SOP API v2.9 or higher
    • Sounds v1.8.0 or higher
    • SOP Base v1.4.5 or higher (Recommended v1.5.3 or higher)
    • System Base v1.5.0 or higher
    • TFTP Server 3.1.6 or higher

Version 3.5.1 - Early deployment
  • Bugfix: Fixed file permissions (M4235)
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (for active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (for cluster configuration only)
    • SOP API v2.9 or higher
    • Sounds v1.8.0 or higher
    • SOP Base v1.4.5 or higher (Recommended v1.5.3 or higher)
    • System Base v1.5.0 or higher
    • TFTP Server 3.1.6 or higher

Version 3.5.0 - Early deployment
  • Improvement: Use pincode defined in profile params (M19274)
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (for active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (for cluster configuration only)
    • SOP API v2.9 or higher
    • Sounds v1.8.0 or higher
    • SOP Base v1.4.5 or higher (Recommended v1.5.3 or higher)
    • System Base v1.5.0 or higher

Version 3.4.2 - Early deployment
  • Bugfix: Prevent HTTP 500 header error (M16121)
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (for active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (for cluster configuration only)
    • SOP API v2.9 or higher
    • Sounds v1.8.0 or higher
    • SOP Base v1.4.5 or higher (Recommended v1.5.3 or higher)
    • System Base v1.5.0 or higher

Version 3.4.1 - General deployment
  • Bugfix: Fixed compatibility issue with Polycom Phone Support module v5 (M10428)
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (for active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (for cluster configuration only)
    • SOP API v2.9 or higher
    • Sounds v1.8.0 or higher
    • SOP Base v1.4.5 or higher (Recommended v1.5.3 or higher)
    • System Base v1.5.0 or higher

Version 3.4.0 - Early deployment
  • Bugfix: Broadcast status to clustered SOPs with parallel request fix timeout issue. (M9135)
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (for active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (for cluster configuration only)
    • SOP API v2.9 or higher
    • Sounds v1.8.0 or higher
    • SOP Base v1.4.5 or higher (Recommended v1.5.3 or higher)
    • System Base v1.5.0 or higher

Version 3.3.0 - General deployment
  • Feature: Support for SVE2 v2.0.0 resources. (M8822)
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (for active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (for cluster configuration only)
    • SOP API v2.9 or higher
    • Sounds v1.8.0 or higher
    • SOP Base v1.4.5 or higher (Recommended v1.5.3 or higher)
    • System Base v1.4.1 or higher

Version 3.2.6 - General deployment
  • Bugfix: PUM shell tools sometimes failed when database inconsistencies occurred. (M5417)
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (for active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (for cluster configuration only)
    • SOP API v2.9 or higher
    • Sounds v1.8.0 or higher
    • SOP Base v1.4.5 or higher (Recommended v1.5.3 or higher)

Version 3.2.5 - General deployment
  • Bugfix: Logout was not working in active-active setup with Polycom reload (M6102)
  • Bugfix: PUM shell tools were not working on a HA standby sop in a cluster (M6278)
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (for active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (for cluster configuration only)
    • SOP API v2.9 or higher
    • Sounds v1.8.0 or higher
    • SOP Base v1.4.5 or higher

Version 3.2.4 - General deployment
  • Bugfix: SVE3 resource types could not be rebooted through the phone status page on the SMP. (M6089)
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (for active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (for cluster configuration only)
    • SOP API v2.9 or higher
    • Sounds v1.8.0 or higher
    • SOP Base v1.4.5 or higher

Version 3.2.3 - General deployment
  • Improvement: Moved library to SOP Base to avoid duplicate implementations.
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (for active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (for cluster configuration only)
    • SOP API v2.9 or higher
    • Sounds v1.8.0 or higher
    • SOP Base v1.4.5 or higher

Version 3.2.2 - General deployment
  • Feature: Added PUM administration interface in the SOP Shell (M0003120)
  • Improvement: Removed prompt files which belong in the Sounds module (M0001123)
  • Improvement: When a virtual phone is removed from the SMP, the virtual phone will be logged out (M0004824)
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (for active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (for cluster configuration only)
    • SOP API v2.9 module or higher
    • Sounds v1.8.0 or higher

Version 3.2.1 - General deployment
  • Improvement: Reduced SOP connectivity timeout to 2 seconds in order to prevent timeout in GetXPath
  • Bugfix: Login of an extension on a phone already logged in sometimes fails (M0004630)
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (for active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (for cluster configuration only)

Version 3.2.0 - General deployment
  • Bugfix: An extension was sometimes blocked until an administrative reset was done (M0004059)
  • Bugfix: PUM logout was not possible anymore after a virtual phone lost its registration (M0003920)
  • Bugfix: After a disconnection of the network, a SOP stopped received pum status update (M0004552)
  • Bugfix: PUM reset did not always reset everything (M0003920)
  • Dependency:
    • Database Schema v1.12.2 or higher
    • High Availability v2.3 or higher (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2 or higher (in a cluster configuration only)

Version 3.1.3 - General deployment
  • Bugfix: PUM synchronization was somtimes disabled after restart of the Application Management Server (M0004059)
  • Dependency:
    • Database Schema v1.12.2+
    • Application Management Server v.3.0+
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 3.1.2 - General deployment
  • Feature: Added support for Aastra phones (M0003130)
  • Dependency:
    • Database Schema v1.12.2+
    • Application Management Server v.3.0+
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 3.1.1 - General deployment
  • Bugfix: Permissions on /tftpboot which prevent proper configuration regeneration on login
  • Dependency:
    • Database Schema v1.12.2+
    • Application Management Server v.3.0+
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 3.1.0 - General deployment
  • Feature: Baseline 2.0 support (M0003103)
  • Dependency:
    • Database Schema v1.12.2+
    • Application Management Server v.3.0+
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 3.0.4 - General deployment
  • Bugfix: Permission on /tftpboot which prevent proper configuration regeration on login
  • Dependency:
    • Database Schema v1.12.2+
    • Application Management Server v.3.0+
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 3.0.3 - General deployment
  • Bug: Logged in phone not restarted in case auto-logout from remote SOP (M0003634)
  • Bug: Logging in on phone already logged in causes inconsistent pum state (M0003464)
  • Dependency:
    • Database Schema v1.12.2+
    • Application Management Server v.3.0+
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 3.0.2 - General deployment
  • Bugfix: Fixed directory permissions (M0003110)
  • Dependency:
    • Database Schema v1.10+
    • Application Management Server v.3.0+
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 3.0.1 - General deployment
  • Bug: Grandstream virtual phone status not cleared when logging in on another logged in phone (M0003464)
  • Improvement: removed unused 'Default TFTP SOP' parameter
  • Dependency:
    • Database Schema v1.10+
    • Application Management Server v.3.0+
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 3.0.0 - General deployment
  • Version compatible with Application Management Server 3.0+
  • Dependency:
    • Database Schema v1.10+
    • Application Management Server v.3.0+
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 2.14.0 - General deployment
  • Feature: HTTP API to retrieve pum status for a specific virtual or physical phone (M0002536)
  • Dependency:
    • Database Schema v1.10+
    • Application Management Server v.2.1+ (in a cluster configuration only)
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 2.13.0 - General deployment
  • Improvement : Default TFTP server will be the current SOPs ip address if left empty
  • Dependency:
    • Database Schema v1.10+
    • Application Management Server v.2.1+ (optional)
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 2.12.0 - General deployment
  • Bug fix: Login/logout failed with new resources with identifier such as SDPA (PolycomIP331)
  • Dependency:
    • Database Schema v1.10+
    • AApplication Management Server v.2.1+ (in a cluster configuration only)
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 2.11.0 - General deployment
  • Bug fix: net.Application does not display proper phone state after logout
  • Improve: added SOP1 and SOP2 of virtual phone on 'pum status' command output
  • Dependency:
    • Asterisk-1.2x v2.17+
    • Database Schema v1.10+
    • Application Management Server v.2.1+ (in a cluster configuration only)
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 2.10.0 - General deployment
  • Bug fix: After login in a cluster configuration, sometimes phone restarts but does not get the virtual phone configuration (M0002168)
  • Bug fix: Login an extension in a cluster configuration sometimes causes another extension to be logged out (M0002168)
  • Bug fix: Logged phone not displayed in SMP>Advanced>Phone Status for single SOP configuration
  • Feature: Command line interface to login, logout and reset a phone for cluster configuration (M0002132)
  • Dependency:
    • Asterisk-1.2x v2.17+
    • Database Schema v1.10+
    • Application Management Server v.2.1+ (in a cluster configuration only)
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 2.9.0 - General deployment
  • Bug fix: Inconsistent pum state after HA switch-over (M0002179)
  • Dependency:
    • Asterisk-1.2x v2.17+
    • Database Schema v1.10+
    • Application Management Server v.2.1+ (in a cluster configuration only)
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 2.8.0 - General deployment
  • Bug fix: pum state not synchronize on HA clones (M0001508)
  • Feature: Active-active support, telephony fail-over support (M0001651)
  • Feature: Active-active support, login and logout fail-over support (M0001690)
  • Dependency:
    • Asterisk-1.2x v2.17+
    • Database Schema v1.10+
    • Application Management Server v.2.1+ (in a cluster configuration only)
    • High Availability v2.3+ (in active-standby configuration only)
    • Cluster & Active-Active Support v1.2+ (in a cluster configuration only)

Version 2.7.0 - General deployment
  • Bug fix: PUM refuse to work because it does not have the right permission to write the log file
  • Advise: upgrade GrandStream Phone Support to v1.6+
  • Dependency:
    • SMP >= v1.4
    • Asterisk-1.2x >= v2.17

Version 2.6.0 - General deployment
  • Bug fix: PUM refuse to work because it does not have the right permission to write the log file
  • Dependency:
    • SMP >= v1.4
    • Asterisk-1.2x >= v2.17

Version 2.5.0 - General deployment
  • Force unregistration of phone after reconfiguration (requires Asterisk 2.17)
  • Added TCP timeout in case remote SOP would not be available
  • Dependency:
    • SMP >= v1.4
    • Asterisk-1.2x >= v2.17

Version 2.4.0 - Deprecated
  • Ensure that TFTP file regeneration always occurs on the TFTP server of the physical phone

Version 2.3.0 - Deprecated
  • Polycom IP330 support
  • Inter-SOP PUM support
  • Extra management reset-action for VirtualPhone

Version 2.2.0 - Deprecated
  • installation of .deb package dependencies will not downgrade exisiting .deb versions

Version 2.1.0 - Deprecated

Version 2.0.0 - Deprecated
  • adds support for accounting/reporting
  • minimal version required when using API Module 1.11 or

Version 1.2.0 - Deprecated
  • use dbGetPhoneState to get IP address
  • (escaux-phone-1.1)
  • requires API >=1.9

Version 1.1.0 - Deprecated

Module configuration interface

create_resource_form: .:/usr/share/escaux/glue/lib:/usr/share/escaux/glue/bin/gen_wiki_documentation/src/lib:/usr/share/escaux/glue/bin/gen_wiki_documentation/src/lib/

Profile parameter for pincode

Module configuration parameters

  • Default TFTP SOP (deprecated as of v2.15): SOP key of the SOP acting as TFTP server for all the phone configured on this SOP. This parameter is mandatory for the clustering support.
  • Profile parameter for pincode (since v3.5.0): Define the profile parameter used for pum authentication.

Optional features

  • High availability support: Enables to switch from active server to a standby server without impacting the PUM service. This requires the installation of the High Availability module.
  • Clustering support: Enables a PUM user to log in on any phone compatible with PUM within a SOP cluster. This requires the installation of the Cluster & Active-Active Support module. As of version 2.15, this feature also requires the Application Management Server in order to replicate phone configuration files on all SOPs of the cluster
  • Active-Active support: Enables a PUM user to configure its extensions and resources on a primary and secondary SOP. In case of failure of its primary SOP, the secondary SOP will automatically take care of its extensions and resources. This requires the installation of the Application Management Server

Technical notes

  • From release 2.15, PUM status and phone configuration files are fully replicated on all the SOPs of the cluster.
  • From release 3.2.0, the PUM status update notification mechanism has been reworked and the dependency with the Application Management module as been removed. If you are upgrading from a version 3.0 or 3.1, make sure to upgrade the module on all the SOPs of the cluster.
Copyright © Escaux SA