[Index]
To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com
Phone Based Registration Feature Reference
The Phone Based Registration Add-On supports a number of configuration parameters that manage how the service operates in a specific provider or customer environment. This configuration is implemented using the Services > Phone Based Registration > PBR Config menu item.
Configuration is on VOSS Automate user interface:
Figure 5: Sample PBR Config record
When configuring the PBR service for a specific hierarchy the following considerations are important:
VOSS recommends that PBR configuration should only allow the replacement of phones with fake MACs with device name prefix starting with BAT.
This ensures that it is never possible for a user to replace a phone that is in active use.
Select the BAT Prefix Required check box.
Is the use of PBR Device records required in this environment?
The PBR device record provides a mechanism for administrators to explicitly specify that a device is eligible for phone based registration.
Select the PBR Device Record Required check box if this is desired.
The PBR device record allows the administrator to specify a PIN that should be used when performing phone based registration for a specific phone or for all phones at a site.
Select the Pin Required check box.
The PBR device record can be used to guarantee that the correct device is replaced in environments where Directory numbers are not unique within a Unified CM cluster, e.g. multiple Directory numbers are configured with same DN but located in different partitions.
In this case, clear the UseSiteWidePIN check box.
Phone Registration Portal Port:
Phone Registration Portal Address:
Phone Registration Portal API User Credentials:
Phone Registration Portal API User:
Phone Registration Portal API Password:
Note that this information is required for both the Provider level config and the config for any customers.
Phone Registration Service Hierarchy:
CUCM IP:
By default, VOSS Automate requires a PBR device record per device, but in some cases, it could be sufficient to use a single pin per site:
Additional options:
Important
After saving the above configuration in VOSS Automate, you must restart the services by running the following CLI command on the primary node:
cluster run all app start phone-based-registration
Phone Based Registration Configuration
Title | Description | Details | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name * | Name of the configuration. This MUST always be Default Default: Default |
|
|||||||||||||||||||||||||||||||||||||||||||||||
BAT Prefix Required * | Only allow registration of phones with device name starting with BAT Default: True |
|
|||||||||||||||||||||||||||||||||||||||||||||||
BAT DeviceName Format | Macro that describes how BAT device names are to be generated. This should be BAT Default: {{ fn.zeropad pwf.extension, 12 }} |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Auto Provision PBR * | Auto Provision PBR Device record for Subscriber BAT phones |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Pin Required * | Is the use of a pin required Default: True |
|
|||||||||||||||||||||||||||||||||||||||||||||||
UseSiteWidePin * | Allow the use of a single PIN per site. When this is set then the device name and extension should be set to SITE in a single PBR device record at the site level and a Partition should be specified. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
PBR Device Record Required * | Is the use of a PBR Device Record Required When this is set to false, then it is possible to replace any BAT phone with Phone based registration Default: True |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Phone Registration Portal Address | Phone Registration Portal Address. In environments that make use of NAT the address for VOSS-4-UC can be unique for each customer - if this is the case then configuring per-customer PBR config becomes mandatory. If HTTP access is desired then this should be map to the IP address of primary VOSS-4-UC Unified Node, for HTTPS this should map to a Web proxy. Redundancy across web proxies can be achieved using external load balancer or DNS. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Phone Registration Portal Port | Phone Registration Portal Port. This should be either port 8412 for HTTP or 443 for HTTPS. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Phone Registration Portal API User * | Phone Registration API User. This should be username dedicated to providing access to PBR web service with a Restricted API access role |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Phone Registration Portal API Password * | Phone Registration API Password. This should be password of API user. This information is encrypted in VOSS-4-UC database |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Phone Registration service Hierarchy | Phone Registration Service Hierarchy. This should be the hierarchy of the VOSS-4-UC Provider |
|
|||||||||||||||||||||||||||||||||||||||||||||||
CUCM IP | IP of CUCM that this config applies to. The IP must be accessible to VOSS-4-UC |
|