UnifiedEndPointProvisioning (TWU2)

Description

Automatically provisions UEP using phone provisioning mechanism

Release notes

Resource configuration interface

Task configuration parameters provided by SMP 5.3+

Warning: Can't find topic CustomerDocs.GenSmpDocCommonTaskParametersRGb55

This task will provisions the Unified End Point, using data from your PBX. The Unified Provisioning Module is to be run from the UEP sopkey and will act as a phone, and try to do auto provisioning. We use standard provisioning API defined by phone manufacturers.

Version 2.X

Please refer to the UEP2.X Administrator Guide for further configuration help.

In this version of the task, the UEP extensions will not be created by the task. The user extensions (also called slots in the scope of the UEP), should be created by the administrator before running this task.

Each slot contains a MAC address. This MAC address should match the MAC address a SDX6 device on the PBX.

Resource configuration parameters

• Contact Group - Contacts can be placed within groups, only contacts within the same group can see each other.
• Provisioning Server - This is usually the IP address of your PBX. This IP address must be reachable from the UEP SOP on port 80.
• Slot Range (Optional) - In most cases this field can be left empty. This field allows you only to provision part of the slots on the UEP.
• SMP API (Example: https://smp._vhost_.smpXXX.escaux.com/api/v1). The URL configured here should be able to do requests without authentication on the SMP. Ensure that you have a vHost on the SMP, that has API access set to Local only. Ensure that in that vHost you have defined the user to use in unauthenticated access. This user should also be created in the UEP core sopkey.
• Dry Run - No changes will be made on the SOPREP when running in dry run mode.
• Limit - Number of extension the API will query in the directory entry to search for slots to provision. Default value is 100.
• Apply Changes - When set to yes, an apply changes will be automatically done after changes are made.

Version 1.X

How to use it

On your PBX create create a Polycom Resource, assign it to a user, and assign it a unique MAC address of your liking.

Example on Escaux Fusion:

On your Escaux Fusion PBX:

• Assign the MAC address E5:C0:00:00:00:01 (this is only an example, make sure to use an unique address per resource)

• Create an extension for the user following Escaux Fusion conventions, and assign the created phone.

Once your phones are provisioned. Create a TWU2 (UnifiedEndPointProvisioning) task.

• Configure the task for your needs. Detailed help about this resource configuration can be found below.

• After running the provisioning task you must apply the changes.

Automation

Provisioning of the UEP can be automated. Steps:

• Define large mac address range in the TWU2 (UnifiedEndPointProvisioning) resource.
• Make the task run automatically every night.
• Create a TWP0 resource (ApplyClusterChanges)
• Make the task run automatically every night.

Requirements:

To obtain the data from the PBX it requires the Unified Provisioning Module to be installed on the UEP machine.

Limitations

• We currently only support Polycom HTTP provisioning.
• Updating data is not supported yet.

Resource configuration parameters

• Provisioning ID - This allows you to group users. Only users from the same group will be shown in each others directories. This value defaults to the name of the task. The contents of this input field will be added to the "Uep_ProvisioningGroup" profile parameter parameter of the User.
• Provisioning Host - IP addres or hostname of the PBX. It is this address that will be used to fetch the phone configuration.
• Username strategy - The usernames can either be provisioned along with theirs macs in the "Mac + Username field" or the provisioning mechanism can generate a username in this case you only need to define a mac address range.
• Mac list - Only required if you selected "Mac provisioning". Insert a comma separated list of mac addresses. You can also define a mac address range. Ex: '000000000000-000000000100'. You can mix both a list of mac addresses and ranges.
• Domain name - Only required if you selected "Mac provisioning". When using this kind of provisioning the username is generated from the <first_name>.<first_name>@<domain>.
• Mac + Username list - Only required if you selected "Mac + Username provisioning". Per line you indicate <mac>,<username> of each user you need to provision.
• Device Type - Defines the type of devices that you are provisioning against.
• Unified End Point SOPKEY - Sopkey of the UEP sop.
• WebRTC SOPKEY - Sopkey of the WebRTC sop.
• SMP vHost - Name of the vHost, to be used for provisioning. Note that this vHost must accept requests from the SMP itself without requiring authentication, and should be able to write extensions.