Configure Cisco UCM for AutoRegistration and PBR#

Overview#

This section describes phone-based registration (PBR) setup.

Related Topics

The flowchart provides the steps for this task:

@startuml 'PBR Install Flowchart !include style.iuml start :[[../src/user/install-web-service-PBR.html Check install and start]]; note right Check with **app status**: ""phone-based-registration"" service should be running. end note :[[../src/user/install-web-service-PBR.html#network-connectivity-for-pbr Establish network connectivity]]; note right Ports: auto-registered phones connect to VOSS Automate Proxy and Unified nodes end note :[[../src/user/install-web-service-PBR.html#certificates-for-https Install certificates for HTTPS]]; :[[../src/user/pbr/expose-access-PBR.html Add PBR to menus and access profile]]; :[[../src/user/pbr/create-restricted-API-role-user.html Create restricted API role and admin user]]; note right * User: **pbr_api_user** * Role: **PBR_RestrictedAPIAccess** end note @enduml

Using PBR setup to configure a UCM#

Use the PBR Setup menu to automates the configuration of Cisco Unified Communications Manager (UCM) for AutoRegistration and Phone Based Registration.

  1. In the Automate Admin portal, go to PBR Setup.

  2. Configure the following:

Setting

Description

CUCM IP Address

IP Address of the publisher for the UCM cluster.

Call Manager Group for Auto Reg

Name of UCM group for AutoReg.

Call Manager for Auto Reg

Name of the Call Manager for AutoReg (as specified under CUCM Call Managers).

First and Last Directory Number for Autoreg

A valid range of DNs to be used for Auto Registration.

PBR Portal Address

The IP Address of Automate cluster UN1

PBR Portal Port

8412
../../_images/PBR-CUCM-PBRSetup.png

It is recommended that initial configuration of the UCM is performed using the PBR setup workflow described above. In cases where there is existing auto-registration config on the UCM, it may be required to do this manually.

Important

Set the Services Provisioning value (under Enterprise Parameters Configuration - Parameter Name on the associated UCM) to Both.

Configuration on Cisco UCM#

Automate Phone Based Registration (PBR) requires the following functionality to be configured on UCMs that manage phones which may be registered by this feature:

  1. Configure the UCM to allow AutoRegistration of new phones.

    This is standard auto registration config for UCM. The PBR Setup in Automate carries out this configuration.

  2. When a phone Auto Registers the phonereg phone service should be configured for the phone. This is achieved by specifying a Universal Device Template for Auto Reg that user to the phonereg phone service.

Screenshots of the relevant configuration on UCM are provided to assist with understanding how the service is implemented and as background for a Cisco expert that may need to fine tune the Unified CM config.

  1. Setup the phonereg Phone Service:

    Browse to Device > Device Settings > Phone Services.

    172.30.11.126

    PBR-PhoneReg_PhoneService.png

    Service URL:

    Depending on whether HTTPS or HTTP is used the service URL may be different:

    • HTTP (Service URL):

      http://{VOSS_IP}:{PBR_PORT}/phoneservices/{UnifiedCM_IP}/phonereg/menu?device=#DEVICENAME#

    • HTTPS (Secure-Service URL):

      https://{VOSS_IP}:443/phoneservices/{UnifiedCM_IP}/phonereg/menu?device=#DEVICENAME#

      For HTTPS-only, both Secure Services URL and Service URL must be populated with the HTTPS URL.

    Note

    The port must always be specified explicitly.

  2. Configure phonereg Universal Device Template:

    1. Browse to User Management > User/Phone Add > Universal Device Template.

    2. Note the subscription to the phonereg Phone Service.

      PBR-PhoneReg_UDT.png

  3. UCM for Auto Registration:

    1. Browse to System > Cisco Unified CM.

    2. Note the phonereg Universal device template.

      ../../_images/CUCM-AutoRegistrationConfig.png